blueprinter 0.23.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a1440e4adce199d743371035d3061ae69aea0ab8030bcbdabe59b23cd995c34
-  data.tar.gz: b1a58870b18665b6bf1a7fe07ac3993cea0d25450c73a00f241f981ab4b9ad95
+  metadata.gz: 2d5e6d18d1ccf85eebe25b2aef41b629fbdad10a2972684e458bfbf268f266f0
+  data.tar.gz: a60400a4b58cb8d26db31838b8da490096b747d17b3912e119db413796d9f5ea
 SHA512:
-  metadata.gz: b20e40f673a754d4d20ccacb2acc8caceeb79d0cced6f69bf4003fa6df6bde5c883baf40954d9fcc9dcde5394f489f54f8a9e1f3f4c3db8eb8494ea88d860e50
-  data.tar.gz: 6192b46a62e77bb267c1b03f15686412efebbddf30dc10931941f2966ddc0bad4f97ec8823d3f4c939d9902c3cac89a3a5ebd209c61798314e2f94c94a537249
+  metadata.gz: 7c58a220d1187a9fa39514158b7e585576010b030da4430a41263ea4dc47f43d1a115e4b475230dfc4a995e1607f870b280d26182d012109013b3303fd75d7cd
+  data.tar.gz: a9a8380551402f4aace847aa1333269e4e2d6052dcf220ea94dbe8f2976a7abb6172558926417438085ca56f57ca744d6a94f1694380ab44c98df37aba9751c3

data/CHANGELOG.md

@@ -1,4 +1,19 @@
-## 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>
 

data/lib/blueprinter/base.rb

@@ -427,8 +427,30 @@ module Blueprinter
     # @return [View] a Blueprinter::View object
     def self.view(view_name)
       @current_view = view_collection[view_name]
+      view_collection[:default].track_definition_order(view_name)
       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/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.0'.freeze
+  VERSION = '0.24.0'.freeze
 end

data/lib/blueprinter/view.rb

@@ -1,7 +1,8 @@
 module Blueprinter
   # @api private
+  DefinitionPlaceholder = Struct.new :name, :view?
   class View
-    attr_reader :excluded_field_names, :fields, :included_view_names, :name, :transformers
+    attr_reader :excluded_field_names, :fields, :included_view_names, :name, :transformers, :definition_order
 
     def initialize(name, fields: {}, included_view_names: [], excluded_view_names: [],transformers: [])
       @name = name
@@ -9,6 +10,14 @@ module Blueprinter
       @included_view_names = included_view_names
       @excluded_field_names = excluded_view_names
       @transformers =  transformers
+      @definition_order = []
+      @sort_by_definition = Blueprinter.configuration.sort_fields_by.eql?(:definition)
+    end
+
+    def track_definition_order(method, is_view = true)
+      if @sort_by_definition
+        @definition_order << DefinitionPlaceholder.new(method, is_view)
+      end
     end
 
     def inherit(view)
@@ -30,11 +39,13 @@ module Blueprinter
     end
 
     def include_view(view_name)
+      track_definition_order(view_name)
       included_view_names << view_name
     end
 
     def include_views(view_names)
       view_names.each do |view_name|
+        track_definition_order(view_name)
         included_view_names << view_name
       end
     end
@@ -54,6 +65,7 @@ module Blueprinter
     end
 
     def <<(field)
+      track_definition_order(field.name,false)
       fields[field.name] = field
     end
   end

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 = sortable_fields(view_name).values
-      sorted_fields = sort_by_definition ? fields : fields.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,28 +43,46 @@ 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
 
-    def merge_fields(source_fields, included_fields)
-      if sort_by_definition
-        included_fields.merge(source_fields)
+    # select and order members of fields according to traversal of the definition_orders
+    def sort_by_def(view_name, fields)
+      ordered_fields = {}
+      views[:default].definition_order.each { |definition| add_to_ordered_fields(ordered_fields, definition, fields, view_name)  }
+      ordered_fields.values
+    end
+
+    # view_name_filter allows to follow definition order all the way down starting from the view_name given to sort_by_def()
+    # but include no others at the top-level
+    def add_to_ordered_fields(ordered_fields, definition, fields, view_name_filter = nil)
+      if definition.view?
+        if view_name_filter.nil? || view_name_filter == definition.name
+          views[definition.name].definition_order.each { |_definition| add_to_ordered_fields(ordered_fields, _definition, fields) }
+        end
       else
-        source_fields.merge(included_fields)
+        ordered_fields[definition.name] = fields[definition.name]
       end
     end
+
+    def merge_fields(source_fields, 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.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Adam Hess
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-31 00:00:00.000000000 Z
+date: 2020-06-25 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