blueprinter 0.23.0 → 0.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a1440e4adce199d743371035d3061ae69aea0ab8030bcbdabe59b23cd995c34
-  data.tar.gz: b1a58870b18665b6bf1a7fe07ac3993cea0d25450c73a00f241f981ab4b9ad95
+  metadata.gz: 1a290d1ace21669c5f28a726e25b634570cf8da35654f51b0901a46fcd36de94
+  data.tar.gz: c065c391df542d56b63e1668096d0e83f14e67819e9e69360667290ec4d4b16a
 SHA512:
-  metadata.gz: b20e40f673a754d4d20ccacb2acc8caceeb79d0cced6f69bf4003fa6df6bde5c883baf40954d9fcc9dcde5394f489f54f8a9e1f3f4c3db8eb8494ea88d860e50
-  data.tar.gz: 6192b46a62e77bb267c1b03f15686412efebbddf30dc10931941f2966ddc0bad4f97ec8823d3f4c939d9902c3cac89a3a5ebd209c61798314e2f94c94a537249
+  metadata.gz: 91c21f6610e95ff9221a7a546d215f5fcef23de42e6429fe72af7ebee134bb2a5550b4a283cecf178d837f19ec12b8df782cc5bd42c5088ab8da4af09ff9d8a6
+  data.tar.gz: d5832253816c04b5309c7e589730f5d28ca9ef2e0dffe7cd0879bf860a360ee95b6e953062571ca83656c273612a07bd53ef70986db431b3ecf69740b3ebba6f

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 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.23.0  - 2019/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:
 ```

data/lib/blueprinter/base.rb

@@ -427,6 +427,7 @@ 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

data/lib/blueprinter/version.rb

@@ -1,3 +1,3 @@
 module Blueprinter
-  VERSION = '0.23.0'.freeze
+  VERSION = '0.23.1'.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,8 +23,8 @@ 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)
+      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
     end
 
@@ -58,12 +58,27 @@ module Blueprinter
       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.23.1
 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-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot