blueprinter 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58305ea0b747a19614cf18bacb3a531de6c64e6ccf4f01abc22dc47c3a378ecc
-  data.tar.gz: b48d6d62205280be48ec415bc5b67af3ae5a5ee7afe3581a707064fa46f5986f
+  metadata.gz: 580e993c5873c53b1324841946e603d64cc53549fa171467683b0d4777bb3375
+  data.tar.gz: 297c9ff83b8b2a726970e099034631e9f9200ff4598f896c465885a982a86e04
 SHA512:
-  metadata.gz: f101686b41f0c201d3bf0414f7aa1529450ca79ffed19e272875c48ba617bf0a9933876510715f3a65d016af3f4ed7ebeb179a932489dfe7c074a0a3465fba3a
-  data.tar.gz: 3b4dcc7ce851136b62cb3fe534fa38746da07c834d25b19a56927dfabe01f0be4a1e3e5ba95434fce80cc43c566244854b08eb0b6fbb7f14cb1dce33d8a2b18f
+  metadata.gz: b7ba1f23e5cd9f50a7c1c97269d6830ed832d4018ba29c24ee208e8105be53f0034ce52c7f851f12d2c4a876f8093202fa7c99306bd50c74f1663edca0a82cbe
+  data.tar.gz: a66d70cf431cdd6ada7633cf1ee067a8701a5eaef4ba2d9d9cea0344a81565603357ba0dafa548cac4db870bc131b7aca263ead7c389b4b0d15264ec4dff2315

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 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).
+
 ## 0.18.0  - 2019/05/29
 
 * ⚠️ [DEPRECATION] :if/:unless procs with two arguments are now deprecated. *These procs now take in three arguments (field_name, obj, options) instead of just (obj, options).*

data/README.md

@@ -1,6 +1,6 @@
 [![CircleCI](https://circleci.com/gh/procore/blueprinter.svg?style=svg)](https://circleci.com/gh/procore/blueprinter)
 [![Gem Version](https://badge.fury.io/rb/blueprinter.svg)](https://badge.fury.io/rb/blueprinter)
-[![Gitter chat](https://badges.gitter.im/procore/blueprinter.png)](https://gitter.im/blueprinter-gem/community)
+[![Gitter chat](https://badges.gitter.im/procore/blueprinter.svg)](https://gitter.im/blueprinter-gem/community)
 
 <img src="blueprinter_logo.svg" width="25%">
 
@@ -660,6 +660,53 @@ _NOTE:_ The field-level setting overrides the global config setting (for the fie
 </details>
 
 
+<details>
+<summary>Transform Classes</summary>
+
+---
+
+Blueprinter provides the ability to specify `transform`s on views, which enable further
+processing and transforming of resulting view field hashes prior to serialization.
+
+Use `transform` to specify one transformer to be included for serialization.
+A transformer is a class, extending `Blueprinter::Transformer` and implementing the `transform` method.
+Whatever is returned from this `transform` method will end up being the resulting hash passed to serialization.
+
+#### Example
+
+Create a Transform class extending from `Blueprinter::Transformer`
+```ruby
+class DynamicFieldTransformer < Blueprinter::Transformer
+  def transform(hash, object, options)
+    hash.merge!(object.dynamic_fields)
+  end
+end
+```
+
+```ruby
+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
+end
+```
+
+Then specify the transform to use for the view.
+```ruby
+class UserBlueprint < Blueprinter::Base
+  fields :first_name, :last_name
+  transform DynamicTransformer
+end
+```
+
+---
+</details>
+
+
 <details>
 <summary>Sorting Fields</summary>
 

data/lib/blueprinter/base.rb

@@ -11,6 +11,7 @@ require_relative 'field'
 require_relative 'helpers/base_helpers'
 require_relative 'view'
 require_relative 'view_collection'
+require_relative 'transformer'
 
 module Blueprinter
   class Base
@@ -274,6 +275,43 @@ module Blueprinter
       end
     end
 
+
+
+    # Specify one transformer to be included for serialization.
+    # Takes a class which extends Blueprinter::Transformer
+    #
+    # @param class name [Class] which implements the method transform to include for
+    #   serialization.
+    #
+    #    
+    # @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
+    #   end
+    #
+    #   class UserBlueprint < Blueprinter::Base
+    #     fields :first_name, :last_name
+    #     transform DynamicTransformer  
+    #     # other code
+    #   end
+    #
+    #   class DynamicFieldTransformer < Blueprinter::Transformer
+    #     def transform(hash, object, options)
+    #       hash.merge!(object.dynamic_fields)
+    #     end
+    #   end
+    #
+    # @return [Array<Class>] an array of transformers
+    def self.transform(transformer)
+      current_view.add_transformer(transformer)
+    end
+
+
     # Specify another view that should be mixed into the current view.
     #
     # @param view_name [Symbol] the view to mix into the current view.

data/lib/blueprinter/helpers/base_helpers.rb

@@ -44,10 +44,14 @@ module Blueprinter
       end
 
       def object_to_hash(object, view_name:, local_options:)
-        view_collection.fields_for(view_name).each_with_object({}) do |field, hash|
+        result_hash = view_collection.fields_for(view_name).each_with_object({}) do |field, hash|
           next if field.skip?(field.name, object, local_options)
-          hash[field.name] = field.extract(object, local_options)
+           hash[field.name] = field.extract(object, local_options)
         end
+        view_collection.transformers(view_name).each do |transformer|
+           transformer.transform(result_hash,object,local_options)
+        end
+        result_hash
       end
 
       def validate_root_and_meta(root, meta)

data/lib/blueprinter/transformer.rb

@@ -0,0 +1,12 @@
+module Blueprinter
+  # @api private
+  class Transformer
+    def transform(result_hash,primary_obj, options={})
+      fail NotImplementedError, "A Transformer must implement #transform"
+    end
+
+    def self.transform(result_hash,primary_obj, options={})
+      self.new.transform(result_hash,primary_obj, options)
+    end
+  end
+end

data/lib/blueprinter/version.rb

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

data/lib/blueprinter/view.rb

@@ -1,13 +1,14 @@
 module Blueprinter
   # @api private
   class View
-    attr_reader :excluded_field_names, :fields, :included_view_names, :name
+    attr_reader :excluded_field_names, :fields, :included_view_names, :name, :transformers
 
-    def initialize(name, fields: {}, included_view_names: [], excluded_view_names: [])
+    def initialize(name, fields: {}, included_view_names: [], excluded_view_names: [],transformers: [])
       @name = name
       @fields = fields
       @included_view_names = included_view_names
       @excluded_field_names = excluded_view_names
+      @transformers =  transformers
     end
 
     def inherit(view)
@@ -22,6 +23,10 @@ module Blueprinter
       view.excluded_field_names.each do |field_name|
         exclude_field(field_name)
       end
+      
+      view.transformers.each do |transformer|
+        self.add_transformer(transformer)
+      end
     end
 
     def include_view(view_name)
@@ -38,6 +43,10 @@ module Blueprinter
       end
     end
 
+    def add_transformer(custom_transformer)
+      transformers << custom_transformer
+    end
+
     def <<(field)
       fields[field.name] = field
     end

data/lib/blueprinter/view_collection.rb

@@ -28,6 +28,10 @@ module Blueprinter
       identifier_fields + sorted_fields
     end
 
+    def transformers(view_name)
+      views[view_name].transformers
+    end
+
     def [](view_name)
       @views[view_name] ||= View.new(view_name)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Adam Hess
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-11 00:00:00.000000000 Z
+date: 2019-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot
@@ -178,6 +178,7 @@ files:
 - lib/blueprinter/field.rb
 - lib/blueprinter/formatters/date_time_formatter.rb
 - lib/blueprinter/helpers/base_helpers.rb
+- lib/blueprinter/transformer.rb
 - lib/blueprinter/version.rb
 - lib/blueprinter/view.rb
 - lib/blueprinter/view_collection.rb