blueprinter 0.23.1 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a290d1ace21669c5f28a726e25b634570cf8da35654f51b0901a46fcd36de94
-  data.tar.gz: c065c391df542d56b63e1668096d0e83f14e67819e9e69360667290ec4d4b16a
+  metadata.gz: c47449bb382533a5c9dab64108c3eec2078f4f1ceba16a9cde3c46b23cb1dcc9
+  data.tar.gz: ea6d7fb604c37ad0bceb6db63a300da7c7946bb49ef0696ed416a674fe95f01a
 SHA512:
-  metadata.gz: 91c21f6610e95ff9221a7a546d215f5fcef23de42e6429fe72af7ebee134bb2a5550b4a283cecf178d837f19ec12b8df782cc5bd42c5088ab8da4af09ff9d8a6
-  data.tar.gz: d5832253816c04b5309c7e589730f5d28ca9ef2e0dffe7cd0879bf860a360ee95b6e953062571ca83656c273612a07bd53ef70986db431b3ecf69740b3ebba6f
+  metadata.gz: 48c8207d8f6a721feb45df8c15c128a73166478d708725a561861704eec7d041d92c08b8a5032bda2bba67cab138c0988976026732340086320b723e0ecab465
+  data.tar.gz: 1c818d65fb75800ff01ebdb15470626a2e83af578e16ef0537d67005dbb014366da34d504970fc7501e4d2fc9031601710ee4943f79fd4145ce965da06cd6e1d

data/CHANGELOG.md

@@ -1,7 +1,22 @@
-## 0.23.1  - 2019/3/13
-* 🚀 [BUGFIX] Fixes #172 where views would unintentionally ignore `sort_fields_by: :definition` configuration. Resolved in [#197](https://github.com/procore/blueprinter/pull/197) by [@wlkrw](https://github.com/wlkrw).
+## 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.23.0  - 2019/1/31
+## 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).
+
+## 0.23.4  - 2020/4/28
+* 🚀 [FEATURE] Public class method `has_view?` on Blueprinter::Base subclasses introduced in [#213](https://github.com/procore/blueprinter/pull/213). Thanks to [@spencerneste](https://github.com/spencerneste).
+
+## 0.23.3  - 2020/4/7
+* 🐛 [BUGFIX] Fixes issue where `exclude` fields in deeply nested views were not respected. Resolved issue [207](https://github.com/procore/blueprinter/issues/207) in [#208](https://github.com/procore/blueprinter/pull/208) by [@tpltn](https://github.com/tpltn).
+
+## 0.23.2  - 2020/3/16
+* 🐛 [BUGFIX] Fixes issue where fields "bled" into other views due to merge side-effects. Resolved issue [205](https://github.com/procore/blueprinter/issues/205) in [#204](https://github.com/procore/blueprinter/pull/204) by [@trevorrjohn](https://github.com/trevorrjohn).
+
+## 0.23.1  - 2020/3/13
+* 🐛 [BUGFIX] Fixes #172 where views would unintentionally ignore `sort_fields_by: :definition` configuration. Resolved in [#197](https://github.com/procore/blueprinter/pull/197) by [@wlkrw](https://github.com/wlkrw).
+
+## 0.23.0  - 2020/1/31
 * 🚀 [FEATURE] Configurable default extractor introduced in [#198](https://github.com/procore/blueprinter/pull/198) by [@wlkrw](https://github.com/wlkrw). You can now set a default extractor like so:
 ```
 Blueprinter.configure do |config|

data/README.md

@@ -355,6 +355,26 @@ Output:
 }
 ```
 
+It is also possible to pass options from one Blueprint to another via an association.
+For example:
+```ruby
+class VehicleBlueprint < Blueprinter::Base
+  identifier :uuid
+  field :full_name do |vehicle, options|
+    "#{vehicle.model} #{options[:trim]}"
+  end
+end
+
+class DriverBlueprint < Blueprinter::Base
+  identifier :uuid
+
+  view :normal do
+    fields :first_name, :last_name
+    association :vehicles, blueprint: vehicle_blueprint, options: { trim: 'LX' }
+  end
+end
+```
+
 ---
 </details>
 
@@ -739,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/base.rb

@@ -431,5 +431,26 @@ module Blueprinter
       yield
       @current_view = view_collection[:default]
     end
+
+    # Check whether or not a Blueprint supports the supplied view.
+    # It accepts a view name.
+    #
+    # @param view_name [Symbol] the view name
+    #
+    # @example With the following Blueprint
+    #
+    # class ExampleBlueprint < Blueprinter::Base
+    #  view :custom do
+    #  end
+    # end
+    #
+    #  ExampleBlueprint.has_view?(:custom) => true
+    #  ExampleBlueprint.has_view?(:doesnt_exist) => false
+    #
+    # @return [Boolean] a boolean value indicating if the view is
+    # supported by this Blueprint.
+    def self.has_view?(view_name)
+      view_collection.has_view? view_name
+    end
   end
 end

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/extractors/association_extractor.rb

@@ -9,6 +9,8 @@ module Blueprinter
 
     def extract(association_name, object, local_options, options={})
       options_without_default = options.reject { |k,_| k == :default || k == :default_if }
+      # Merge in assocation options hash
+      local_options = local_options.merge(options[:options]) if options[:options].is_a?(Hash)
       value = @extractor.extract(association_name, object, local_options, options_without_default)
       return default_value(options) if use_default_value?(value, options[:default_if])
       view = options[:view] || :default

data/lib/blueprinter/version.rb

@@ -1,3 +1,3 @@
 module Blueprinter
-  VERSION = '0.23.1'.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)

data/lib/blueprinter/view_collection.rb

@@ -23,9 +23,10 @@ module Blueprinter
     def fields_for(view_name)
       return identifier_fields if view_name == :identifier
 
-      fields_hash = sortable_fields(view_name)
-      sorted_fields = sort_by_definition ? sort_by_def(view_name, fields_hash) : fields_hash.values.sort_by(&:name)
-      identifier_fields + sorted_fields
+      fields, excluded_fields = sortable_fields(view_name)
+      sorted_fields = sort_by_definition ? sort_by_def(view_name, fields) : fields.values.sort_by(&:name)
+
+      (identifier_fields + sorted_fields).reject { |field| excluded_fields.include?(field.name) }
     end
 
     def transformers(view_name)
@@ -42,20 +43,23 @@ module Blueprinter
       views[:identifier].fields.values
     end
 
+    # @param [String] view_name
+    # @return [Array<(Hash, Hash<String, NilClass>)>] fields, excluded_fields
     def sortable_fields(view_name)
+      excluded_fields = {}
       fields = views[:default].fields
       fields = merge_fields(fields, views[view_name].fields)
       views[view_name].included_view_names.each do |included_view_name|
-        if view_name != included_view_name
-          fields = merge_fields(fields, sortable_fields(included_view_name))
-        end
-      end
+        next if view_name == included_view_name
 
-      views[view_name].excluded_field_names.each do |name|
-        fields.delete(name)
+        view_fields, view_excluded_fields = sortable_fields(included_view_name)
+        fields = merge_fields(fields, view_fields)
+        excluded_fields.merge!(view_excluded_fields)
       end
 
-      fields
+      views[view_name].excluded_field_names.each { |name| excluded_fields[name] = nil }
+
+      [fields, excluded_fields]
     end
 
     # select and order members of fields according to traversal of the definition_orders
@@ -78,7 +82,7 @@ module Blueprinter
     end
 
     def merge_fields(source_fields, included_fields)
-      source_fields.merge! included_fields
+      source_fields.merge included_fields
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter
 version: !ruby/object:Gem::Version
-  version: 0.23.1
+  version: 0.25.0
 platform: ruby
 authors:
 - Adam Hess
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-14 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot
@@ -123,6 +123,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement