jsonapi-resources 0.9.0 → 0.10.6

data/lib/jsonapi/relationship.rb

@@ -1,8 +1,13 @@
 module JSONAPI
   class Relationship
     attr_reader :acts_as_set, :foreign_key, :options, :name,
-                :class_name, :polymorphic, :always_include_linkage_data,
-                :parent_resource, :eager_load_on_include
+                :class_name, :polymorphic, :always_include_optional_linkage_data,
+                :parent_resource, :eager_load_on_include, :custom_methods,
+                :inverse_relationship, :allow_include, :use_related_resource_records_for_joins
+
+    attr_writer :allow_include
+
+    attr_accessor :_routed, :_warned_missing_route
 
     def initialize(name, options = {})
       @name = name.to_s
@@ -12,22 +17,75 @@ module JSONAPI
       @parent_resource = options[:parent_resource]
       @relation_name = options.fetch(:relation_name, @name)
       @polymorphic = options.fetch(:polymorphic, false) == true
-      @always_include_linkage_data = options.fetch(:always_include_linkage_data, false) == true
-      @eager_load_on_include = options.fetch(:eager_load_on_include, true) == true
+      @polymorphic_types = options[:polymorphic_types]
+      if options[:polymorphic_relations]
+        ActiveSupport::Deprecation.warn('Use polymorphic_types instead of polymorphic_relations')
+        @polymorphic_types ||= options[:polymorphic_relations]
+      end
+
+      use_related_resource_records_for_joins_default = if options[:relation_name]
+                                                         false
+                                                       else
+                                                         JSONAPI.configuration.use_related_resource_records_for_joins
+                                                       end
+      
+      @use_related_resource_records_for_joins = options.fetch(:use_related_resource_records_for_joins,
+                                                              use_related_resource_records_for_joins_default) == true
+
+      @always_include_optional_linkage_data = options.fetch(:always_include_optional_linkage_data, false) == true
+      @eager_load_on_include = options.fetch(:eager_load_on_include, false) == true
+      @allow_include = options[:allow_include]
+      @class_name = nil
+      @inverse_relationship = nil
+
+      @_routed = false
+      @_warned_missing_route = false
+
+      exclude_links(options.fetch(:exclude_links, JSONAPI.configuration.default_exclude_links))
+
+      # Custom methods are reserved for future use
+      @custom_methods = options.fetch(:custom_methods, {})
     end
 
     alias_method :polymorphic?, :polymorphic
+    alias_method :parent_resource_klass, :parent_resource
 
     def primary_key
+      # :nocov:
       @primary_key ||= resource_klass._primary_key
+      # :nocov:
     end
 
     def resource_klass
-      @resource_klass ||= @parent_resource.resource_for(@class_name)
+      @resource_klass ||= @parent_resource.resource_klass_for(@class_name)
     end
 
     def table_name
+      # :nocov:
       @table_name ||= resource_klass._table_name
+      # :nocov:
+    end
+
+    def self.polymorphic_types(name)
+      @poly_hash ||= {}.tap do |hash|
+        ObjectSpace.each_object do |klass|
+          next unless Module === klass
+          if ActiveRecord::Base > klass
+            klass.reflect_on_all_associations(:has_many).select{|r| r.options[:as] }.each do |reflection|
+              (hash[reflection.options[:as]] ||= []) << klass.name.underscore
+            end
+          end
+        end
+      end
+      @poly_hash[name.to_sym]
+    end
+
+    def resource_types
+      if polymorphic? && belongs_to?
+        @polymorphic_types ||= self.class.polymorphic_types(@relation_name).collect {|t| t.pluralize}
+      else
+        [resource_klass._type.to_s.pluralize]
+      end
     end
 
     def type
@@ -47,17 +105,35 @@ module JSONAPI
       end
     end
 
-    def type_for_source(source)
-      if polymorphic?
-        resource = source.public_send(name)
-        resource.class._type if resource
-      else
-        type
+    def belongs_to?
+      # :nocov:
+      false
+      # :nocov:
+    end
+
+    def readonly?
+      @options[:readonly]
+    end
+
+    def exclude_links(exclude)
+      case exclude
+        when :default, "default"
+          @_exclude_links = [:self, :related]
+        when :none, "none"
+          @_exclude_links = []
+        when Array
+          @_exclude_links = exclude.collect {|link| link.to_sym}
+        else
+          fail "Invalid exclude_links"
       end
     end
 
-    def belongs_to?
-      false
+    def _exclude_links
+      @_exclude_links ||= []
+    end
+
+    def exclude_link?(link)
+      _exclude_links.include?(link.to_sym)
     end
 
     class ToOne < Relationship
@@ -68,27 +144,89 @@ module JSONAPI
         @class_name = options.fetch(:class_name, name.to_s.camelize)
         @foreign_key ||= "#{name}_id".to_sym
         @foreign_key_on = options.fetch(:foreign_key_on, :self)
+        if parent_resource
+          @inverse_relationship = options.fetch(:inverse_relationship, parent_resource._type)
+        end
+      end
+
+      def to_s
+        # :nocov: useful for debugging
+        "#{parent_resource}.#{name}(#{belongs_to? ? 'BelongsToOne' : 'ToOne'})"
+        # :nocov:
       end
 
       def belongs_to?
+        # :nocov:
         foreign_key_on == :self
+        # :nocov:
       end
 
       def polymorphic_type
         "#{name}_type" if polymorphic?
       end
+
+      def include_optional_linkage_data?
+        @always_include_optional_linkage_data || JSONAPI::configuration.always_include_to_one_linkage_data
+      end
+
+      def allow_include?(context = nil)
+        strategy = if @allow_include.nil?
+                     JSONAPI.configuration.default_allow_include_to_one
+                   else
+                     @allow_include
+                   end
+
+        if !!strategy == strategy #check for boolean
+          return strategy
+        elsif strategy.is_a?(Symbol) || strategy.is_a?(String)
+          parent_resource.send(strategy, context)
+        else
+          strategy.call(context)
+        end
+      end
     end
 
     class ToMany < Relationship
-      attr_reader :reflect, :inverse_relationship
+      attr_reader :reflect
 
       def initialize(name, options = {})
         super
         @class_name = options.fetch(:class_name, name.to_s.camelize.singularize)
         @foreign_key ||= "#{name.to_s.singularize}_ids".to_sym
         @reflect = options.fetch(:reflect, true) == true
-        @inverse_relationship = options.fetch(:inverse_relationship, parent_resource._type.to_s.singularize.to_sym) if parent_resource
+        if parent_resource
+          @inverse_relationship = options.fetch(:inverse_relationship, parent_resource._type.to_s.singularize.to_sym)
+        end
+      end
+
+      def to_s
+        # :nocov: useful for debugging
+        "#{parent_resource}.#{name}(ToMany)"
+        # :nocov:
+      end
+
+      def include_optional_linkage_data?
+        # :nocov:
+        @always_include_optional_linkage_data || JSONAPI::configuration.always_include_to_many_linkage_data
+        # :nocov:
       end
+
+      def allow_include?(context = nil)
+        strategy = if @allow_include.nil?
+                     JSONAPI.configuration.default_allow_include_to_many
+                   else
+                     @allow_include
+                   end
+
+        if !!strategy == strategy #check for boolean
+          return strategy
+        elsif strategy.is_a?(Symbol) || strategy.is_a?(String)
+          parent_resource.send(strategy, context)
+        else
+          strategy.call(context)
+        end
+      end
+
     end
   end
 end