blueprinter 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 335ed3cf4448c0972904b81679e8e95304ab075064c1022555062b8eb07eaf12
-  data.tar.gz: fd442388bb18481015b4ae8ed79ca9b79b9a34f6eef6f5b31eb9ef473c458287
+  metadata.gz: 2a1440e4adce199d743371035d3061ae69aea0ab8030bcbdabe59b23cd995c34
+  data.tar.gz: b1a58870b18665b6bf1a7fe07ac3993cea0d25450c73a00f241f981ab4b9ad95
 SHA512:
-  metadata.gz: 6855988c4693065d2620a19995f326718fd14796b0ec856b1ace0d5e91068959c72ada4788881e4b7bc2fbe587f56cf146dba06817431feaa6fb7d487d2d1eba
-  data.tar.gz: 4aef0b54eea76568616e860863d782caced131399cdd36bdec2874f5b701b139517367556fe880f5041b7acd4fe6619eba79f8c7180c8fe8b31f09bd279cdc5d
+  metadata.gz: b20e40f673a754d4d20ccacb2acc8caceeb79d0cced6f69bf4003fa6df6bde5c883baf40954d9fcc9dcde5394f489f54f8a9e1f3f4c3db8eb8494ea88d860e50
+  data.tar.gz: 6192b46a62e77bb267c1b03f15686412efebbddf30dc10931941f2966ddc0bad4f97ec8823d3f4c939d9902c3cac89a3a5ebd209c61798314e2f94c94a537249

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 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:
+```
+Blueprinter.configure do |config|
+  config.extractor_default = MyAutoExtractor
+end
+```
+
 ## 0.22.0  - 2019/12/26
 * 🚀 [FEATURE] Add rails generators. See `rails g blueprinter:blueprint --help` for usage. Introduced in [#176](https://github.com/procore/blueprinter/pull/176) by [@wlkrw](https://github.com/wlkrw).
 

data/README.md

@@ -742,6 +742,57 @@ end
 ---
 </details>
 
+<details>
+<summary>Configurable Extractors</summary>
+
+---
+
+Blueprinter gets a given objects' values from the fields definitions using extractor classes. You can substitute your own extractor class globally or per-field.
+
+#### Examples
+
+For a specific kind of field, create an extractor class extending from `Blueprinter::Extractor`
+```ruby
+class MyFieldExtractor < Blueprinter::Extractor
+  def extract(_field_name, _object, _local_options, _options={})
+    # process your obscure_object
+    _object.clarified
+  end
+end
+```
+
+```ruby
+class MysteryBlueprint < Blueprinter::Base
+  field :obscure_object, extractor: MyFieldExtractor
+end
+```
+
+For a global default, create an extractor class extending from `Blueprinter::AutoExtractor` and set the `extractor_default` configuration
+```ruby
+class MyAutoExtractor < Blueprinter::AutoExtractor
+  def initialize
+    super
+    @my_field_extractor = MyFieldExtractor.new
+  end
+  def extractor(object, options)
+    # dispatch to any class AutoExtractor can, plus more
+    if detect_obscurity(object)
+      @my_field_extractor
+    else
+      super
+    end
+  end
+end
+```
+
+```ruby
+Blueprinter.configure do |config|
+  config.extractor_default = MyAutoExtractor
+end
+```
+
+---
+</details>
 
 <details>
 <summary>Sorting Fields</summary>

data/lib/blueprinter/base.rb

@@ -51,7 +51,7 @@ module Blueprinter
     #   end
     #
     # @return [Field] A Field object
-    def self.identifier(method, name: method, extractor: AutoExtractor.new, &block)
+    def self.identifier(method, name: method, extractor: Blueprinter.configuration.extractor_default.new, &block)
       view_collection[:identifier] << Field.new(
         method,
         name,
@@ -120,7 +120,7 @@ module Blueprinter
       current_view << Field.new(
         method,
         options.fetch(:name) { method },
-        options.fetch(:extractor) { AutoExtractor.new },
+        options.fetch(:extractor) { Blueprinter.configuration.extractor_default.new },
         self,
         options.merge(block: block),
       )

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
+    attr_accessor :association_default, :datetime_format, :field_default, :generator, :if, :method, :sort_fields_by, :unless, :extractor_default
 
     VALID_CALLABLES = %i(if unless).freeze
 
@@ -13,6 +13,7 @@ module Blueprinter
       @method = :generate
       @sort_fields_by = :name_asc
       @unless = nil
+      @extractor_default = AutoExtractor
     end
 
     def jsonify(blob)

data/lib/blueprinter/extractors/association_extractor.rb

@@ -4,7 +4,7 @@ module Blueprinter
     include EmptyTypes
 
     def initialize
-      @extractor = AutoExtractor.new
+      @extractor = Blueprinter.configuration.extractor_default.new
     end
 
     def extract(association_name, object, local_options, options={})

data/lib/blueprinter/version.rb

@@ -1,3 +1,3 @@
 module Blueprinter
-  VERSION = '0.22.0'.freeze
+  VERSION = '0.23.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Adam Hess
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-26 00:00:00.000000000 Z
+date: 2020-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot