caprese 0.3.27 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5179ca42789493695ca03e5fb2d7a1874a372056
-  data.tar.gz: f14d99e1adf2e3d475e3b0bcb91cd4ec7e49899e
+  metadata.gz: 2166fc2b8abb1545a666d9d9e20bbffcb20666d0
+  data.tar.gz: dac348b43650955f6c16b8321e283c8d437dbd9c
 SHA512:
-  metadata.gz: 5fba032a7f1e4543edd66dae4f4ebf4aa0774ffdf0d0580cac2a1b46a4a779abef14af898a4f23f6089b02d3a8a5a2f1071f06d783b6837721c904a03b5fa24c
-  data.tar.gz: 1a9de55405e112dd2ad26e8c8479293e43425da2c9111251ff1267b202bab80e2d6ac6259e6c06321e5e4677ef5e860df179b6928fe37b1a5c873e17d5fe70bd
+  metadata.gz: d416cf781dc717d62c82be61634c7c0eb09752088284b65c2787958733d4cd2f784937fd235ce363098ece7d66de333608e368f460ba25160d24385d28412f54
+  data.tar.gz: 7f55dac36dbf0a11ce6feb3f083e924fb18005ae5d01b5cae807b618f0d28193b13fdd5f6d360123f75d5861701320589f24f10e07344f9699a449c07b8d8f13

data/CHANGELOG.md

@@ -152,4 +152,16 @@
 
 ## 0.3.27
 
-* Fix bug in JSON API adapter that inappropriately aliases relationships
+* Fix bug in JSON API adapter that inappropriately aliases relationships
+
+## 0.4.0
+
+* Modifies behavior of `config.optimize_relationships`
+  * Original behavior: Only sends `links` of relationships (no `data`) except those that are in `includes`
+  * New behavior: Relationship is omitted from response entirely except those that are in `includes`
+* **Breaking:** Modifies behavior of serializer relationships
+  * Original behavior: Use the serializer corresponding to the class of objects for the relationships
+    * Example: `has_many :productos => ProductSerializer`
+  * New behavior: Relationships in serializers use the name of the relationship as an assumption about the serializer for that relationship
+    * Example: `has_many :productos => ProductoSerializer`
+  * Can override by passing any serializer: `has_many :productos, serializer: ProductSerializer`

data/caprese.gemspec

@@ -21,9 +21,9 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.1'
 
-  spec.add_dependency 'active_model_serializers', '0.10.5'
+  spec.add_dependency 'active_model_serializers', '0.10.6'
   spec.add_dependency 'kaminari', '~> 0.16.0'
-  spec.add_dependency 'rails', '>= 4.2.0'
+  spec.add_dependency 'rails', '~> 4.2.0'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'factory_girl'

data/lib/caprese/adapter/json_api/relationship.rb

@@ -6,19 +6,16 @@ module Caprese
         # {http://jsonapi.org/format/#document-links Document Links}
         # {http://jsonapi.org/format/#document-resource-object-linkage Document Resource Relationship Linkage}
         # {http://jsonapi.org/format/#document-meta Document Meta}
-        def initialize(parent_serializer, serializable_resource_options, association, included_associations)
+        def initialize(parent_serializer, serializable_resource_options, association)
           @parent_serializer = parent_serializer
           @association = association
           @serializable_resource_options = serializable_resource_options
-          @included_associations = included_associations
         end
 
         def as_json
           hash = {}
 
-          # Only render a relationship's data if it was included, if Caprese.config.optimize_relationships
-          if association.options[:include_data] &&
-            (!Caprese.config.optimize_relationships || included_associations[association.name])
+          if association.include_data?
             hash[:data] = data_for(association)
           end
 
@@ -33,18 +30,42 @@ module Caprese
 
         protected
 
-        attr_reader :parent_serializer, :serializable_resource_options, :association, :included_associations
+        attr_reader :parent_serializer, :serializable_resource_options, :association
 
         private
 
+        # TODO(BF): Avoid db hit on belong_to_ releationship by using foreign_key on self
         def data_for(association)
-          serializer = association.serializer
-          if serializer.respond_to?(:each)
-            serializer.map { |s| ResourceIdentifier.new(s, serializable_resource_options).as_json }
-          elsif (virtual_value = association.options[:virtual_value])
+          if association.collection?
+            data_for_many(association)
+          else
+            data_for_one(association)
+          end
+        end
+
+        def data_for_one(association)
+          # TODO(BF): Process relationship without evaluating lazy_association
+          serializer = association.lazy_association.serializer
+          if (virtual_value = association.virtual_value)
             virtual_value
-          elsif serializer && serializer.object
+          elsif serializer && association.object
             ResourceIdentifier.new(serializer, serializable_resource_options).as_json
+          else
+            nil
+          end
+        end
+
+        def data_for_many(association)
+          # TODO(BF): Process relationship without evaluating lazy_association
+          collection_serializer = association.lazy_association.serializer
+          if collection_serializer.respond_to?(:each)
+            collection_serializer.map do |serializer|
+              ResourceIdentifier.new(serializer, serializable_resource_options).as_json
+            end
+          elsif (virtual_value = association.virtual_value)
+            virtual_value
+          else
+            []
           end
         end
 

data/lib/caprese/adapter/json_api/resource_identifier.rb

@@ -16,6 +16,14 @@ module Caprese
           JsonApi.send(:transform_key_casing!, raw_type, transform_options)
         end
 
+        def self.for_type_with_id(type, id, options)
+          return nil if id.blank?
+          {
+            id: id.to_s,
+            type: type_for(:no_class_needed, type, options)
+          }
+        end
+
         # {http://jsonapi.org/format/#document-resource-identifier-objects Resource Identifier Objects}
         def initialize(serializer, options)
           @id   = id_for(serializer)

data/lib/caprese/adapter/json_api.rb

@@ -244,7 +244,7 @@ module Caprese
 
       def process_relationships(serializer, include_directive)
         serializer.associations(include_directive).each do |association|
-          process_relationship(association.serializer, include_directive[association.key])
+          process_relationship(association.lazy_association.serializer, include_directive[association.key])
         end
       end
 
@@ -290,8 +290,14 @@ module Caprese
           resource_object
         end
 
-        requested_associations = fieldset.fields_for(resource_object[:type]) || '*'
-        relationships = relationships_for(serializer, requested_associations, included_associations)
+        requested_associations = fieldset.fields_for(resource_object[:type])
+        requested_associations ||= included_associations.to_string if Caprese.config.optimize_relationships
+        requested_associations ||= '*'
+        requested_associations = JSONAPI::IncludeDirective.new(
+          requested_associations,
+          allow_wildcard: true
+        )
+        relationships = relationships_for(serializer, requested_associations)
         resource_object[:relationships] = relationships if relationships.any?
 
         links = links_for(serializer)
@@ -419,17 +425,12 @@ module Caprese
       #     id: 'required-id',
       #     meta: meta
       #   }.reject! {|_,v| v.nil? }
-      def relationships_for(serializer, requested_associations, included_associations)
-        include_directive = JSONAPI::IncludeDirective.new(
-          requested_associations,
-          allow_wildcard: true
-        )
+      def relationships_for(serializer, include_directive)
         serializer.associations(include_directive).each_with_object({}) do |association, hash|
           hash[association.key] = Relationship.new(
             serializer,
             instance_options,
-            association,
-            included_associations
+            association
           ).as_json
         end
       end

data/lib/caprese/controller/concerns/persistence.rb

@@ -18,8 +18,12 @@ module Caprese
         )
       end
 
-      rescue_from ActiveRecord::RecordInvalid do |e|
-        rescue_with_handler RecordInvalidError.new(e.record, engaged_field_aliases)
+      rescue_from ActiveRecord::RecordInvalid, ActiveRecord::RecordNotSaved do |e|
+        if e.record
+          rescue_with_handler RecordInvalidError.new(e.record, engaged_field_aliases)
+        else
+          rescue_with_handler ActionForbiddenError.new
+        end
       end
 
       rescue_from ActiveRecord::RecordNotDestroyed do |e|
@@ -291,7 +295,7 @@ module Caprese
         end
 
         ref
-      else
+      elsif !relationship_data.has_key?(:data)
         raise Error.new(
           field: "/data/relationships/#{relationship_name}/data",
           code: :blank

data/lib/caprese/serializer/concerns/links.rb

@@ -12,7 +12,7 @@ module Caprese
         #   object = Order<@token='asd27h'>
         #   links = { self: '/api/v1/orders/asd27hß' }
         link :self do
-          if(url = serializer.class.route_for(object))
+          if object.persisted? && (url = serializer.class.route_for(object))
             serializer.url_helpers.send(
               url,
               object.read_attribute(Caprese.config.resource_primary_key),
@@ -30,86 +30,6 @@ module Caprese
             fail 'Caprese requires that config.default_url_options[:host] be set when rendering links.'
           end
         end
-
-        # Overridden so we can define relationship links without any code in a specific
-        # serializer
-        def has_many(name, options = {}, &block)
-          super name, options, &build_association_block(name)
-
-          define_method name do
-            self.relationship_scope(name, object.send(name))
-          end
-        end
-
-        # @see has_many
-        def has_one(name, options = {}, &block)
-          super name, options, &build_association_block(name)
-        end
-
-        # @see has_many
-        def belongs_to(name, options = {}, &block)
-          super name, options, &build_association_block(name)
-        end
-
-        private
-
-        # Builds a block that is passed into an association when it is defined in a specific serializer
-        # The block is run, and links are added to each association so when it is rendered in the
-        # `relationships` object of the `data` for record, it contains links to the particular association
-        #
-        # @example
-        #   object = Order<@token=5, @product_id=10>
-        #   reflection_name = 'product'
-        #   # => {
-        #     id: 'asd27h',
-        #     type: 'orders',
-        #     relationships: {
-        #       product: {
-        #         id: 'hy7sql',
-        #         type: 'products',
-        #         links: {
-        #           self: '/api/v1/orders/asd27h/relationships/product',
-        #           related: '/api/v1/orders/asd27h/product'
-        #         }
-        #       }
-        #     }
-        #   }
-        #
-        # @param [String] reflection_name the name of the relationship
-        # @return [Block] a block to build links for the relationship
-        def build_association_block(reflection_name)
-          primary_key = Caprese.config.resource_primary_key
-
-          reflection_name = reflection_name.to_sym
-
-          Proc.new do |serializer|
-            link :self do
-              url = "relationship_definition_#{serializer.version_name("#{serializer.unnamespace(object.class.name).underscore}_url")}"
-              if serializer.url_helpers.respond_to? url
-                serializer.url_helpers.send(
-                  url,
-                  id: object.read_attribute(primary_key),
-                  relationship: reflection_name,
-                  host: serializer.class.send(:caprese_default_url_options_host)
-                )
-              end
-            end
-
-            link :related do
-              url = "relationship_data_#{serializer.version_name("#{serializer.unnamespace(object.class.name).underscore}_url")}"
-              if serializer.url_helpers.respond_to? url
-                serializer.url_helpers.send(
-                  url,
-                  id: object.read_attribute(primary_key),
-                  relationship: reflection_name,
-                  host: serializer.class.send(:caprese_default_url_options_host)
-                )
-              end
-            end
-
-            :nil
-          end
-        end
       end
     end
   end

data/lib/caprese/serializer/concerns/lookup.rb

@@ -52,13 +52,13 @@ module Caprese
         # Gets a serializer for a klass, either as the serializer explicitly defined
         # for this class, or as a serializer defined for one of the klass's parents
         #
-        # @param [Class] klass the klass to get the serializer for
+        # @param [Class,String] klass the klass or klass name to get the serializer for
         # @return [Serializer] the serializer for the class
         def get_serializer_for(klass)
           begin
-            namespaced_module("#{klass.name}Serializer").constantize
-          rescue NameError => e
-            get_serializer_for(klass.superclass) if klass.superclass
+            namespaced_module("#{klass.is_a?(Class) ? klass.name : klass}Serializer").constantize
+          rescue NameError
+            get_serializer_for(klass.superclass) if klass.is_a?(Class) && klass.superclass
           end
         end
 

data/lib/caprese/serializer/concerns/relationships.rb

@@ -23,6 +23,108 @@ module Caprese
       def relationship_scope(name, scope)
         scope
       end
+
+      module ClassMethods
+        def has_many(name, options = {}, &block)
+          super(
+            name,
+            merge_serializer_option(name, options),
+            &build_association_block(name)
+          )
+
+          define_method name do
+            self.relationship_scope(name, object.send(object.class.caprese_unalias_field(name)))
+          end
+        end
+
+        def has_one(name, options = {}, &block)
+          super(
+            name,
+            merge_serializer_option(name, options),
+            &build_association_block(name)
+          )
+        end
+
+        def belongs_to(name, options = {}, &block)
+          super(
+            name,
+            merge_serializer_option(name, options),
+            &build_association_block(name)
+          )
+        end
+
+        private
+
+        # Builds a block that is passed into an association when it is defined in a specific serializer
+        # The block is run, and links are added to each association so when it is rendered in the
+        # `relationships` object of the `data` for record, it contains links to the particular association
+        #
+        # @example
+        #   object = Order<@token=5, @product_id=10>
+        #   reflection_name = 'product'
+        #   # => {
+        #     id: 'asd27h',
+        #     type: 'orders',
+        #     relationships: {
+        #       product: {
+        #         id: 'hy7sql',
+        #         type: 'products',
+        #         links: {
+        #           self: '/api/v1/orders/asd27h/relationships/product',
+        #           related: '/api/v1/orders/asd27h/product'
+        #         }
+        #       }
+        #     }
+        #   }
+        #
+        # @param [String] reflection_name the name of the relationship
+        # @return [Block] a block to build links for the relationship
+        def build_association_block(reflection_name)
+          primary_key = Caprese.config.resource_primary_key
+
+          reflection_name = reflection_name.to_sym
+
+          Proc.new do |serializer|
+            link :self do
+              url = "relationship_definition_#{serializer.version_name("#{serializer.unnamespace(object.class.name).underscore}_url")}"
+              if serializer.url_helpers.respond_to? url
+                serializer.url_helpers.send(
+                  url,
+                  id: object.read_attribute(primary_key),
+                  relationship: reflection_name,
+                  host: serializer.class.send(:caprese_default_url_options_host)
+                )
+              end
+            end
+
+            link :related do
+              url = "relationship_data_#{serializer.version_name("#{serializer.unnamespace(object.class.name).underscore}_url")}"
+              if serializer.url_helpers.respond_to? url
+                serializer.url_helpers.send(
+                  url,
+                  id: object.read_attribute(primary_key),
+                  relationship: reflection_name,
+                  host: serializer.class.send(:caprese_default_url_options_host)
+                )
+              end
+            end
+
+            :nil
+          end
+        end
+
+        # Adds a default serializer for relationship based on the relationship name
+        #
+        # @example
+        #   has_many :answers => AnswerSerializer
+        #
+        # @param [String] name the name of the relationship
+        # @param [Hash] options options to add default serializer to
+        # @return [Hash] the default options
+        def merge_serializer_option(name, options)
+          { serializer: get_serializer_for(name.to_s.classify) }.merge(options)
+        end
+      end
     end
   end
 end

data/lib/caprese/version.rb

@@ -1,3 +1,3 @@
 module Caprese
-  VERSION = '0.3.27'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caprese
 version: !ruby/object:Gem::Version
-  version: 0.3.27
+  version: 0.4.0
 platform: ruby
 authors:
 - Nick Landgrebe
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-03 00:00:00.000000000 Z
+date: 2017-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.10.5
+        version: 0.10.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.10.5
+        version: 0.10.6
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.0
 - !ruby/object:Gem::Dependency