blueprinter 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 580e993c5873c53b1324841946e603d64cc53549fa171467683b0d4777bb3375
-  data.tar.gz: 297c9ff83b8b2a726970e099034631e9f9200ff4598f896c465885a982a86e04
+  metadata.gz: bf9b763f4f3719ba9e005676312f09f21165d8bc53ede0ee5ac0d171fcbae828
+  data.tar.gz: 2984aa6879ecafa6e15e49a95edc0b3fdad19d0f3ef0cdb51c484a7785b05303
 SHA512:
-  metadata.gz: b7ba1f23e5cd9f50a7c1c97269d6830ed832d4018ba29c24ee208e8105be53f0034ce52c7f851f12d2c4a876f8093202fa7c99306bd50c74f1663edca0a82cbe
-  data.tar.gz: a66d70cf431cdd6ada7633cf1ee067a8701a5eaef4ba2d9d9cea0344a81565603357ba0dafa548cac4db870bc131b7aca263ead7c389b4b0d15264ec4dff2315
+  metadata.gz: 8141264e23abc76304a7dc22527880e22c82b1dbb796e4b4f9f5cbd6bd3a0b95c029aa83f3d68b557c530904b0131b19338fde99b00693374b95f529d6424027
+  data.tar.gz: 74c36b42fdb6655084572d94c7cb8ac610855c587604c3aae4c093590fb0254641de043a1b58d25ed2c963db42209d85444fdcdd8370189d766228136804b37d

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.20.0  - 2019/10/15
+* 🚀 [FEATURE] Ability to include multiple views in a single method call with `include_views`. [184](https://github.com/procore/blueprinter/pull/184). Thanks to [@narendranvelmurugan](https://github.com/narendranvelmurugan).
+
+* 💅 [ENHANCEMENT] Update field-level conditional settings to reflect new three-argument syntax. [183](https://github.com/procore/blueprinter/pull/183). Thanks to [@danirod](https://github.com/danirod).
+
+* 💅 [ENHANCEMENT] Modify Extractor access control in documentation. [182](https://github.com/procore/blueprinter/pull/182). Thanks to [@cagmz](https://github.com/cagmz).
+
+* 💅 [ENHANCEMENT] Fix the Transformer example documentation. [174](https://github.com/procore/blueprinter/pull/174). Thanks to [@tjwallace](https://github.com/tjwallace).
+
 ## 0.19.0  - 2019/07/24
 * 🚀 [FEATURE] Added ability to specify transformers for Blueprinter views to further process the resulting hash before serialization. [#164](https://github.com/procore/blueprinter/pull/164). Thanks to [@amalarayfreshworks](https://github.com/amalarayfreshworks).
 

data/README.md

@@ -137,6 +137,7 @@ class UserBlueprint < Blueprinter::Base
   end
 end
 ```
+A view can include fields from another view by utilizing `include_view` and `include_views`.
 
 Usage:
 ```ruby
@@ -590,8 +591,8 @@ end
 ```ruby
 class UserBlueprint < Blueprinter::Base
   identifier :uuid
-  field :last_name, if: ->(user, options) { user.first_name != options[:first_name] }
-  field :age, unless: ->(user, _options) { user.age < 18 }
+  field :last_name, if: ->(_field_name, user, options) { user.first_name != options[:first_name] }
+  field :age, unless: ->(_field_name, user, _options) { user.age < 18 }
 end
 ```
 

data/lib/blueprinter/base.rb

@@ -286,17 +286,18 @@ module Blueprinter
     #    
     # @example Specifying a DynamicFieldTransformer transformer for including dynamic fields to be serialized.
     #   class User 
-    #      def custom_columns
-    #         self.dynamic_fields #which is an array of some columns
-    #      end
-    #      def custom_fields
-    #         custom_columns.each_with_object({}){|col,result|  result[col] = self.send(col)}
-    #      end
+    #     def custom_columns
+    #       self.dynamic_fields # which is an array of some columns
+    #     end
+    #
+    #     def custom_fields
+    #       custom_columns.each_with_object({}) { |col,result| result[col] = self.send(col) }
+    #     end
     #   end
     #
     #   class UserBlueprint < Blueprinter::Base
     #     fields :first_name, :last_name
-    #     transform DynamicTransformer  
+    #     transform DynamicFieldTransformer  
     #     # other code
     #   end
     #
@@ -335,6 +336,34 @@ module Blueprinter
     end
 
 
+    # Specify additional views that should be mixed into the current view.
+    #
+    #  @param view_name [Array<Symbol>] the views to mix into the current view.
+    #
+    # @example Including the normal and special views into an extended view.
+    #   class UserBlueprint < Blueprinter::Base
+    #     # other code...
+    #     view :normal do
+    #       fields :first_name, :last_name
+    #     end
+    #     view :special do 
+    #       fields :birthday, :company
+    #     end 
+    #     view :extended do
+    #       include_views :normal, :special # include fields specified from above.
+    #       field :description
+    #     end
+    #     #=> [:first_name, :last_name, :birthday, :company, :description]
+    #   end
+    #
+    # @return [Array<Symbol>] an array of view names.
+
+
+    def self.include_views(*view_names)
+        current_view.include_views(view_names)
+    end 
+
+
     # Exclude a field that was mixed into the current view.
     #
     # @param field_name [Symbol] the field to exclude from the current view.

data/lib/blueprinter/extractor.rb

@@ -1,5 +1,4 @@
 module Blueprinter
-  # @api private
   class Extractor
     def extract(field_name, object, local_options, options={})
       fail NotImplementedError, "An Extractor must implement #extract"

data/lib/blueprinter/extractors/association_extractor.rb

@@ -1,4 +1,5 @@
 module Blueprinter
+  # @api private
   class AssociationExtractor < Extractor
     def initialize
       @extractor = AutoExtractor.new

data/lib/blueprinter/extractors/auto_extractor.rb

@@ -1,4 +1,5 @@
 module Blueprinter
+  # @api private
   class AutoExtractor < Extractor
     def initialize
       @hash_extractor = HashExtractor.new

data/lib/blueprinter/extractors/block_extractor.rb

@@ -1,4 +1,5 @@
 module Blueprinter
+  # @api private
   class BlockExtractor < Extractor
     def extract(field_name, object, local_options, options = {})
       options[:block].call(object, local_options)

data/lib/blueprinter/extractors/hash_extractor.rb

@@ -1,4 +1,5 @@
 module Blueprinter
+  # @api private
   class HashExtractor < Extractor
     def extract(field_name, object, _local_options, _options = {})
       object[field_name]

data/lib/blueprinter/extractors/public_send_extractor.rb

@@ -1,4 +1,5 @@
 module Blueprinter
+  # @api private
   class PublicSendExtractor < Extractor
     def extract(field_name, object, local_options, options = {})
       object.public_send(field_name)

data/lib/blueprinter/version.rb

@@ -1,3 +1,3 @@
 module Blueprinter
-  VERSION = '0.19.0'
+  VERSION = '0.20.0'
 end

data/lib/blueprinter/view.rb

@@ -33,6 +33,12 @@ module Blueprinter
       included_view_names << view_name
     end
 
+    def include_views(view_names)
+      view_names.each do |view_name|
+        included_view_names << view_name
+      end
+    end 
+
     def exclude_field(field_name)
       excluded_field_names << field_name
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Adam Hess
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-25 00:00:00.000000000 Z
+date: 2019-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot