blueprinter 0.25.1 → 0.25.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ea32b799d411874c19f6fcd40b522e12ac8eca461e3ed518c2ec21d1b2a4980
-  data.tar.gz: 1a9f5d9ce56d46821047bb693975a310abc044ff7a30c3e3c7ca908bcd81b3c2
+  metadata.gz: 9e5e7be1f829035c332a5baa935ef724f52c381bd60f039a20a89368acc7cfde
+  data.tar.gz: 7307febc9d3a860aa3b3ffe00a83066b808329a32a3d81dde5a7af7439dc4609
 SHA512:
-  metadata.gz: bf07f48a3baaea65428a36c4751a0014f2178c3b391a69f8ad1f6081737454d62caa642b726ca16a8f6b53e83c5ccb61422dc2e470754d37f4c46bb257fea228
-  data.tar.gz: 5602227efea583382dc8e297151b473a859071cf293908feafdb00d7f50f4753cd53ae17a37e0697a47889543c883a3f0f668b45813ebc4d1bfa23f7c5a29a04
+  metadata.gz: 24411ac6c3068b7c08c167e1f91a6e4e25757fd4a32df56f710b0fbe84d07e7507cbdf05eb54645ba3b9b29b8b90c81cede3e68254b254c0523975c9c9236dc0
+  data.tar.gz: baef6ae7db2fcc0e6ab9eb4e4c11baf6453ecaf30519462bd6ea5d4dbd5cbd8b1e791f202b2b74e9f15ccc4d265d19828c33b339dc65041916d09351d7729e1f

data/CHANGELOG.md

@@ -1,5 +1,8 @@
+## 0.25.2  - 2020/11/19
+* 🚀 [FEATURE] Make deprecation behavior configurable (`:silence`, `:stderror`, `:raise`). See [#248](https://github.com/procore/blueprinter/pull/248) thanks to [@mcclayton](https://github.com/mcclayton)
+
 ## 0.25.1  - 2020/8/18
-* 🚀 [BUGFIX] Raise Blueprinter::BlueprinterError if Blueprint given is not of class Blueprinter::Base. Before it just raised a generic `undefined method 'prepare'`. See [#233](https://github.com/procore/blueprinter/pull/233) thanks to [@caws](https://github.com/caws)
+* 🐛 [BUGFIX] Raise Blueprinter::BlueprinterError if Blueprint given is not of class Blueprinter::Base. Before it just raised a generic `undefined method 'prepare'`. See [#233](https://github.com/procore/blueprinter/pull/233) thanks to [@caws](https://github.com/caws)
 
 ## 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).

data/README.md

@@ -869,6 +869,33 @@ Output:
 </details>
 
 
+<details>
+<summary>Deprecations</summary>
+
+---
+
+When functionality in Blueprinter is invoked, that has been deprecated, the default behavior is to
+write a deprecation notice to stderror.
+
+However, deprecations can be configured to report at three different levels:
+
+|        Key        |                              Result                             |
+|:-----------------:|:---------------------------------------------------------------:|
+| `:stderr` (Default) | Deprecations will be written to stderror                        |
+| `:raise`            | Deprecations will be raised as `Blueprinter::BlueprinterError`s |
+| `:silence`          | Deprecations will be silenced and will not be raised or logged  |
+
+### Example:
+```ruby
+Blueprinter.configure do |config|
+  config.deprecations = :raise
+end
+```
+
+---
+</details>
+
+
 <details>
 <summary>render_as_hash</summary>
 

data/lib/blueprinter/base.rb

@@ -1,5 +1,6 @@
 require_relative 'blueprinter_error'
 require_relative 'configuration'
+require_relative 'deprecation'
 require_relative 'empty_types'
 require_relative 'extractor'
 require_relative 'extractors/association_extractor'

data/lib/blueprinter/configuration.rb

@@ -1,10 +1,11 @@
 module Blueprinter
   class Configuration
-    attr_accessor :association_default, :datetime_format, :field_default, :generator, :if, :method, :sort_fields_by, :unless, :extractor_default, :default_transformers
+    attr_accessor :association_default, :datetime_format, :deprecations, :field_default, :generator, :if, :method, :sort_fields_by, :unless, :extractor_default, :default_transformers
 
     VALID_CALLABLES = %i(if unless).freeze
 
     def initialize
+      @deprecations = :stderror
       @association_default = nil
       @datetime_format = nil
       @field_default = nil

data/lib/blueprinter/deprecation.rb

@@ -0,0 +1,35 @@
+# @api private
+module Blueprinter
+  class Deprecation
+    class << self
+      VALID_BEHAVIORS = %i(silence stderror raise).freeze
+      MESSAGE_PREFIX = "[DEPRECATION::WARNING] Blueprinter:".freeze
+
+      def report(message)
+        full_msg = qualified_message(message)
+
+        case behavior
+        when :silence
+          # Silence deprecation (noop)
+        when :stderror
+          warn full_msg
+        when :raise
+          raise BlueprinterError, full_msg
+        end
+      end
+
+      private
+
+      def qualified_message(message)
+        "#{MESSAGE_PREFIX} #{message}"
+      end
+
+      def behavior
+        configured = Blueprinter.configuration.deprecations
+        return configured unless !VALID_BEHAVIORS.include?(configured)
+
+        :stderror
+      end
+    end
+  end
+end

data/lib/blueprinter/empty_types.rb

@@ -10,6 +10,8 @@ module Blueprinter
     private
 
     def use_default_value?(value, empty_type)
+      return value.nil? unless empty_type
+
       case empty_type
       when Blueprinter::EMPTY_COLLECTION
         array_like?(value) && value.empty?
@@ -18,7 +20,10 @@ module Blueprinter
       when Blueprinter::EMPTY_STRING
         value.to_s == ""
       else
-        value.nil?
+        Blueprinter::Deprecation.report(
+          "Invalid empty type '#{empty_type}' received. Blueprinter will raise an error in the next major version."\
+          "Must be one of [nil, Blueprinter::EMPTY_COLLECTION, Blueprinter::EMPTY_HASH, Blueprinter::EMPTY_STRING]"
+        )
       end
     end
   end

data/lib/blueprinter/field.rb

@@ -34,7 +34,7 @@ class Blueprinter::Field
     callable = old_callable_from(condition)
 
     if callable && callable.arity == 2
-      warn "[DEPRECATION] Blueprinter :#{condition} conditions now expects 3 arguments instead of 2."
+      Blueprinter::Deprecation.report("`:#{condition}` conditions now expects 3 arguments instead of 2.")
       ->(_field_name, obj, options) { callable.call(obj, options) }
     else
       callable

data/lib/blueprinter/version.rb

@@ -1,3 +1,3 @@
 module Blueprinter
-  VERSION = '0.25.1'.freeze
+  VERSION = '0.25.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter
 version: !ruby/object:Gem::Version
-  version: 0.25.1
+  version: 0.25.2
 platform: ruby
 authors:
 - Adam Hess
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-18 00:00:00.000000000 Z
+date: 2020-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot
@@ -197,6 +197,7 @@ files:
 - lib/blueprinter/base.rb
 - lib/blueprinter/blueprinter_error.rb
 - lib/blueprinter/configuration.rb
+- lib/blueprinter/deprecation.rb
 - lib/blueprinter/empty_types.rb
 - lib/blueprinter/extractor.rb
 - lib/blueprinter/extractors/association_extractor.rb