blueprinter 0.24.0 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d5e6d18d1ccf85eebe25b2aef41b629fbdad10a2972684e458bfbf268f266f0
-  data.tar.gz: a60400a4b58cb8d26db31838b8da490096b747d17b3912e119db413796d9f5ea
+  metadata.gz: c47449bb382533a5c9dab64108c3eec2078f4f1ceba16a9cde3c46b23cb1dcc9
+  data.tar.gz: ea6d7fb604c37ad0bceb6db63a300da7c7946bb49ef0696ed416a674fe95f01a
 SHA512:
-  metadata.gz: 7c58a220d1187a9fa39514158b7e585576010b030da4430a41263ea4dc47f43d1a115e4b475230dfc4a995e1607f870b280d26182d012109013b3303fd75d7cd
-  data.tar.gz: a9a8380551402f4aace847aa1333269e4e2d6052dcf220ea94dbe8f2976a7abb6172558926417438085ca56f57ca744d6a94f1694380ab44c98df37aba9751c3
+  metadata.gz: 48c8207d8f6a721feb45df8c15c128a73166478d708725a561861704eec7d041d92c08b8a5032bda2bba67cab138c0988976026732340086320b723e0ecab465
+  data.tar.gz: 1c818d65fb75800ff01ebdb15470626a2e83af578e16ef0537d67005dbb014366da34d504970fc7501e4d2fc9031601710ee4943f79fd4145ce965da06cd6e1d

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.25.0  - 2020/7/06
+* 🚀 [FEATURE] Enable default `Blueprinter::Transformer`s to be set in the global configuration. [#222](https://github.com/procore/blueprinter/pull/222). Thanks to [@supremebeing7](https://github.com/supremebeing7).
+
 ## 0.24.0  - 2020/6/22
 * 🚀 [FEATURE] Add an `options` option to associations to facilitate passing options from one blueprint to another. [#220](https://github.com/procore/blueprinter/pull/220). Thanks to [@mcclayton](https://github.com/mcclayton).
 

data/README.md

@@ -759,6 +759,25 @@ class UserBlueprint < Blueprinter::Base
 end
 ```
 
+#### Global Transforms
+
+You can also specify global default transformers. Create one or more transformer classes extending from `Blueprinter::Transformer` and set the `default_transformers` configuration
+```ruby
+class LowerCamelTransformer < Blueprinter::Transformer
+  def transform(hash, _object, _options)
+    hash.transform_keys! { |key| key.to_s.camelize(:lower).to_sym }
+  end
+end
+```
+
+```ruby
+Blueprinter.configure do |config|
+  config.default_transformers = [LowerCamelTransformer]
+end
+```
+
+**Note: Any transforms specified on a per-blueprint or per-view level will override the `default_transformers` in the configuration.**
+
 ---
 </details>
 

data/lib/blueprinter/configuration.rb

@@ -1,6 +1,6 @@
 module Blueprinter
   class Configuration
-    attr_accessor :association_default, :datetime_format, :field_default, :generator, :if, :method, :sort_fields_by, :unless, :extractor_default
+    attr_accessor :association_default, :datetime_format, :field_default, :generator, :if, :method, :sort_fields_by, :unless, :extractor_default, :default_transformers
 
     VALID_CALLABLES = %i(if unless).freeze
 
@@ -14,6 +14,7 @@ module Blueprinter
       @sort_fields_by = :name_asc
       @unless = nil
       @extractor_default = AutoExtractor
+      @default_transformers = []
     end
 
     def jsonify(blob)

data/lib/blueprinter/version.rb

@@ -1,3 +1,3 @@
 module Blueprinter
-  VERSION = '0.24.0'.freeze
+  VERSION = '0.25.0'.freeze
 end

data/lib/blueprinter/view.rb

@@ -2,18 +2,22 @@ module Blueprinter
   # @api private
   DefinitionPlaceholder = Struct.new :name, :view?
   class View
-    attr_reader :excluded_field_names, :fields, :included_view_names, :name, :transformers, :definition_order
+    attr_reader :excluded_field_names, :fields, :included_view_names, :name, :view_transformers, :definition_order
 
-    def initialize(name, fields: {}, included_view_names: [], excluded_view_names: [],transformers: [])
+    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
+      @view_transformers = transformers
       @definition_order = []
       @sort_by_definition = Blueprinter.configuration.sort_fields_by.eql?(:definition)
     end
 
+    def transformers
+      view_transformers.empty? ? Blueprinter.configuration.default_transformers : view_transformers
+    end
+
     def track_definition_order(method, is_view = true)
       if @sort_by_definition
         @definition_order << DefinitionPlaceholder.new(method, is_view)
@@ -33,8 +37,8 @@ module Blueprinter
         exclude_field(field_name)
       end
 
-      view.transformers.each do |transformer|
-        self.add_transformer(transformer)
+      view.view_transformers.each do |transformer|
+        add_transformer(transformer)
       end
     end
 
@@ -61,7 +65,7 @@ module Blueprinter
     end
 
     def add_transformer(custom_transformer)
-      transformers << custom_transformer
+      view_transformers << custom_transformer
     end
 
     def <<(field)

metadata

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