Merge pull request #298 from thewatts/nw-engines

Engine Support for Links

Author: lgebhardt

lib/jsonapi/link_builder.rb

@@ -0,0 +1,140 @@
+module JSONAPI
+  class LinkBuilder
+    attr_reader :base_url,
+                :primary_resource_klass,
+                :route_formatter
+
+    def initialize(config = {})
+      @base_url               = config[:base_url]
+      @primary_resource_klass = config[:primary_resource_klass]
+      @route_formatter        = config[:route_formatter]
+    end
+
+    def engine?
+      !!engine_name
+    end
+
+    def engine_name
+      @engine_name ||= build_engine_name
+    end
+
+    def primary_resources_url
+      if engine?
+        engine_primary_resources_url
+      else
+        regular_primary_resources_url
+      end
+    end
+
+    def query_link(query_params)
+      "#{ primary_resources_url }?#{ query_params.to_query }"
+    end
+
+    def relationships_related_link(source, association)
+      "#{ self_link(source) }/#{ route_for_association(association) }"
+    end
+
+    def relationships_self_link(source, association)
+      "#{ self_link(source) }/relationships/#{ route_for_association(association) }"
+    end
+
+    def self_link(source)
+      if engine?
+        engine_resource_url(source)
+      else
+        regular_resource_url(source)
+      end
+    end
+
+    private
+
+    def build_engine_name
+      scopes = module_scopes_from_class(primary_resource_klass)
+
+      unless scopes.empty?
+        "#{ scopes.first.to_s.camelize }::Engine".safe_constantize
+      end
+    end
+
+    def engine_path_from_resource_class(klass)
+      path_name = engine_resources_path_name_from_class(klass)
+      engine_name.routes.url_helpers.send(path_name)
+    end
+
+    def engine_primary_resources_path
+      engine_path_from_resource_class(primary_resource_klass)
+    end
+
+    def engine_primary_resources_url
+      "#{ base_url }#{ engine_primary_resources_path }"
+    end
+
+    def engine_resource_path(source)
+      resource_path_name = engine_resource_path_name_from_source(source)
+      engine_name.routes.url_helpers.send(resource_path_name, source.id)
+    end
+
+    def engine_resource_path_name_from_source(source)
+      scopes         = module_scopes_from_class(source.class)[1..-1]
+      base_path_name = scopes.map { |scope| scope.downcase }.join("_")
+      end_path_name  = source.class._type.to_s.singularize
+      "#{ base_path_name }_#{ end_path_name }_path"
+    end
+
+    def engine_resource_url(source)
+      "#{ base_url }#{ engine_resource_path(source) }"
+    end
+
+    def engine_resources_path_name_from_class(klass)
+      scopes         = module_scopes_from_class(klass)[1..-1]
+      base_path_name = scopes.map { |scope| scope.downcase }.join("_")
+      end_path_name  = klass._type.to_s
+      "#{ base_path_name }_#{ end_path_name }_path"
+    end
+
+    def format_route(route)
+      route_formatter.format(route.to_s)
+    end
+
+    def formatted_module_path_from_class(klass)
+      scopes = module_scopes_from_class(klass)
+
+      unless scopes.empty?
+        "/#{ scopes.map(&:downcase).join('/') }/"
+      else
+        "/"
+      end
+    end
+
+    def module_scopes_from_class(klass)
+      klass.name.to_s.split("::")[0...-1]
+    end
+
+    def regular_primary_resources_path
+      [
+        formatted_module_path_from_class(primary_resource_klass),
+        route_formatter.format(primary_resource_klass._type.to_s),
+      ].join
+    end
+
+    def regular_primary_resources_url
+      "#{ base_url }#{ regular_primary_resources_path }"
+    end
+
+    def regular_resource_path(source)
+      [
+        formatted_module_path_from_class(source.class),
+        route_formatter.format(source.class._type.to_s),
+        "/#{ source.id }",
+      ].join
+    end
+
+    def regular_resource_url(source)
+      "#{ base_url }#{ regular_resource_path(source) }"
+    end
+
+    def route_for_association(association)
+      format_route(association.name)
+    end
+  end
+end

lib/jsonapi/resource_serializer.rb

@@ -1,3 +1,5 @@
+require_relative "link_builder"
+
 module JSONAPI
   class ResourceSerializer
 
@@ -12,16 +14,15 @@ class ResourceSerializer
     # key_formatter: KeyFormatter class to override the default configuration
     # base_url: a string to prepend to generated resource links
 
-    def initialize(primary_resource_klass, options = {})
-      @primary_resource_klass = primary_resource_klass
-      @primary_class_name = @primary_resource_klass._type
+    attr_reader :url_generator
 
-      @fields =  options.fetch(:fields, {})
-      @include = options.fetch(:include, [])
+    def initialize(primary_resource_klass, options = {})
+      @primary_class_name = primary_resource_klass._type
+      @fields             = options.fetch(:fields, {})
+      @include            = options.fetch(:include, [])
       @include_directives = options[:include_directives]
-      @key_formatter = options.fetch(:key_formatter, JSONAPI.configuration.key_formatter)
-      @route_formatter = options.fetch(:route_formatter, JSONAPI.configuration.route_formatter)
-      @base_url = options.fetch(:base_url, '')
+      @key_formatter      = options.fetch(:key_formatter, JSONAPI.configuration.key_formatter)
+      @url_generator      = generate_link_builder(primary_resource_klass, options)
     end
 
     # Converts a single resource, or an array of resources to a hash, conforming to the JSONAPI structure
@@ -68,7 +69,7 @@ def serialize_to_links_hash(source, requested_association)
     end
 
     def find_link(query_params)
-      "#{@base_url}/#{formatted_module_path_from_klass(@primary_resource_klass)}#{@route_formatter.format(@primary_resource_klass._type.to_s)}?#{query_params.to_query}"
+      url_generator.query_link(query_params)
     end
 
     private
@@ -196,38 +197,22 @@ def relationship_data(source, include_directives)
 
     def relationship_links(source)
       links = {}
-      links[:self] = self_href(source)
+      links[:self] = url_generator.self_link(source)
 
       links
     end
 
-    def formatted_module_path(source)
-      formatted_module_path_from_klass(source.class)
-    end
-
-    def formatted_module_path_from_klass(klass)
-      klass.name =~ /::[^:]+\Z/ ? (@route_formatter.format($`).freeze.gsub('::', '/') + '/').downcase : ''
-    end
-
-    def self_href(source)
-      "#{@base_url}/#{formatted_module_path(source)}#{@route_formatter.format(source.class._type.to_s)}/#{source.id}"
-    end
-
     def already_serialized?(type, id)
       type = format_key(type)
       @included_objects.key?(type) && @included_objects[type].key?(id)
     end
 
-    def format_route(route)
-      @route_formatter.format(route.to_s)
-    end
-
     def self_link(source, association)
-      "#{self_href(source)}/relationships/#{format_route(association.name)}"
+      url_generator.relationships_self_link(source, association)
     end
 
     def related_link(source, association)
-      "#{self_href(source)}/#{format_route(association.name)}"
+      url_generator.relationships_related_link(source, association)
     end
 
     def has_one_linkage(source, association)
@@ -327,5 +312,13 @@ def format_value(value, format)
       value_formatter = JSONAPI::ValueFormatter.value_formatter_for(format)
       value_formatter.format(value)
     end
+
+    def generate_link_builder(primary_resource_klass, options)
+      LinkBuilder.new(
+        base_url: options.fetch(:base_url, ''),
+        route_formatter: options.fetch(:route_formatter, JSONAPI.configuration.route_formatter),
+        primary_resource_klass: primary_resource_klass,
+      )
+    end
   end
 end

test/fixtures/active_record.rb

@@ -1164,11 +1164,19 @@ class NumeroTelefoneResource < JSONAPI::Resource
   end
 end
 
+module MyEngine
+  module Api
+    module V1
+      class PersonResource < JSONAPI::Resource
+      end
+    end
+  end
+end
+
 warn 'start testing Name Collisions'
 # The name collisions only emmit warnings. Exceptions would change the flow of the tests
 
 class LinksResource < JSONAPI::Resource
-
 end
 
 class BadlyNamedAttributesResource < JSONAPI::Resource

test/test_helper.rb

@@ -14,6 +14,7 @@
 require 'rails/test_help'
 require 'minitest/mock'
 require 'jsonapi-resources'
+require 'pry'
 
 require File.expand_path('../helpers/value_matchers', __FILE__)
 require File.expand_path('../helpers/assertions', __FILE__)
@@ -43,6 +44,12 @@ class TestApp < Rails::Application
   ActiveSupport::JSON::Encoding.time_precision = 0 if Rails::VERSION::MAJOR >= 4 && Rails::VERSION::MINOR >= 1
 end
 
+module MyEngine
+  class Engine < ::Rails::Engine
+    isolate_namespace MyEngine
+  end
+end
+
 # Patch RAILS 4.0 to not use millisecond precision
 if Rails::VERSION::MAJOR >= 4 && Rails::VERSION::MINOR < 1
   module ActiveSupport
@@ -198,6 +205,16 @@ def show_queries
       jsonapi_resources :numeros_telefone
     end
   end
+
+  mount MyEngine::Engine => "/boomshaka", as: :my_engine
+end
+
+MyEngine::Engine.routes.draw do
+  namespace :api do
+    namespace :v1 do
+      jsonapi_resources :people
+    end
+  end
 end
 
 # Ensure backward compatibility with Minitest 4