caprese 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd2115a6fe41d29441c8e8efcf2dfa28372822e9
-  data.tar.gz: 03b0dcf4d7bcc71131002edd2249191e13b69023
+  metadata.gz: 4b725af58154343e22b1461038d79f44aed23dae
+  data.tar.gz: 8b6529bd2b85c220c639a054e2238318a7fabcd6
 SHA512:
-  metadata.gz: 29680318f5f3aab40b535ade40c4f037351c78607251619f5644d66cf9cd42331bd31b2f3268e9eea3b5a20743bb987baeae8170a271dadf6425f35a6f8466b4
-  data.tar.gz: c3e97ebcfbc324959307d519330afd413717d89da94145ec4872d937b41de6cac3062b0ccda2a4bede684842e5ce690e592dc3bbee9ced930cfa8ecf50eb6595
+  metadata.gz: 06f96af5359480e0f38f28117752c29d953708b05d9e2e5f5a3578237ed8efabf1967cff668041fc66404dc4a6f71559b08f770bbeda0a4339ba9041f6dad0b4
+  data.tar.gz: 392cccbd86e3fec174d5e7f86b545a1d17732c3b8ef6dc1d080221fe17fee04112fa771e3c36ca2ac63243ad5ec46dbb3c33a97b51a4745018fb14106a11139c

data/CHANGELOG.md

@@ -10,3 +10,7 @@
 ## 0.3.1
 
 * Remove strict dependencies
+
+## 0.3.2
+
+* Allow scoping of `has_many` relationships in serializers, i.e. when the relationship is included in another primary document

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

@@ -29,6 +29,10 @@ module Caprese
         # 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

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

@@ -0,0 +1,28 @@
+require 'active_support/concern'
+
+module Caprese
+  class Serializer < ActiveModel::Serializer
+    module Relationships
+      extend ActiveSupport::Concern
+
+      # Applies further scopes to a collection association when rendered as part of included document
+      # @note Can be overridden to customize scoping at a per-relationship level
+      #
+      # @example
+      #   def relationship_scope(name, scope)
+      #     case name
+      #     when :transactions
+      #       scope.by_merchant(...)
+      #     when :orders
+      #       scope.by_user(...)
+      #     end
+      #   end
+      #
+      # @param [String] name the name of the association
+      # @param [Relation] scope the scope corresponding to a collection association
+      def relationship_scope(name, scope)
+        scope
+      end
+    end
+  end
+end

data/lib/caprese/serializer.rb

@@ -2,6 +2,7 @@ require 'active_model_serializers'
 require 'caprese/concerns/versioning'
 require 'caprese/serializer/concerns/links'
 require 'caprese/serializer/concerns/lookup'
+require 'caprese/serializer/concerns/relationships'
 
 module Caprese
   class Serializer < ActiveModel::Serializer
@@ -9,6 +10,7 @@ module Caprese
     include Versioning
     include Links
     include Lookup
+    include Relationships
 
     def json_key
       unversion(self.class.name).gsub('Serializer', '').underscore

data/lib/caprese/version.rb

@@ -1,3 +1,3 @@
 module Caprese
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caprese
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Nick Landgrebe
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-02 00:00:00.000000000 Z
+date: 2017-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -240,6 +240,7 @@ files:
 - lib/caprese/serializer.rb
 - lib/caprese/serializer/concerns/links.rb
 - lib/caprese/serializer/concerns/lookup.rb
+- lib/caprese/serializer/concerns/relationships.rb
 - lib/caprese/serializer/error_serializer.rb
 - lib/caprese/version.rb
 homepage: https://github.com/nicklandgrebe/caprese