blueprinter 0.25.0 → 0.25.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c47449bb382533a5c9dab64108c3eec2078f4f1ceba16a9cde3c46b23cb1dcc9
-  data.tar.gz: ea6d7fb604c37ad0bceb6db63a300da7c7946bb49ef0696ed416a674fe95f01a
+  metadata.gz: 1ea32b799d411874c19f6fcd40b522e12ac8eca461e3ed518c2ec21d1b2a4980
+  data.tar.gz: 1a9f5d9ce56d46821047bb693975a310abc044ff7a30c3e3c7ca908bcd81b3c2
 SHA512:
-  metadata.gz: 48c8207d8f6a721feb45df8c15c128a73166478d708725a561861704eec7d041d92c08b8a5032bda2bba67cab138c0988976026732340086320b723e0ecab465
-  data.tar.gz: 1c818d65fb75800ff01ebdb15470626a2e83af578e16ef0537d67005dbb014366da34d504970fc7501e4d2fc9031601710ee4943f79fd4145ce965da06cd6e1d
+  metadata.gz: bf07f48a3baaea65428a36c4751a0014f2178c3b391a69f8ad1f6081737454d62caa642b726ca16a8f6b53e83c5ccb61422dc2e470754d37f4c46bb257fea228
+  data.tar.gz: 5602227efea583382dc8e297151b473a859071cf293908feafdb00d7f50f4753cd53ae17a37e0697a47889543c883a3f0f668b45813ebc4d1bfa23f7c5a29a04

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 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)
+
 ## 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

@@ -370,7 +370,7 @@ class DriverBlueprint < Blueprinter::Base
 
   view :normal do
     fields :first_name, :last_name
-    association :vehicles, blueprint: vehicle_blueprint, options: { trim: 'LX' }
+    association :vehicles, blueprint: VehicleBlueprint, options: { trim: 'LX' }
   end
 end
 ```

data/lib/blueprinter/base.rb

@@ -156,7 +156,7 @@ module Blueprinter
     #
     # @return [Field] A Field object
     def self.association(method, options = {}, &block)
-      raise BlueprinterError, 'blueprint required' unless options[:blueprint]
+      validate_blueprint!(options[:blueprint], method)
 
       field(
         method,
@@ -214,7 +214,7 @@ module Blueprinter
     #   # => [{id:1, title: Hello},{id:2, title: My Day}]
     #
     # @return [Hash]
-    def self.render_as_hash(object, options= {})
+    def self.render_as_hash(object, options = {})
       prepare_for_render(object, options)
     end
 
@@ -239,7 +239,7 @@ module Blueprinter
     #   # => [{"id" => "1", "title" => "Hello"},{"id" => "2", "title" => "My Day"}]
     #
     # @return [Hash]
-    def self.render_as_json(object, options= {})
+    def self.render_as_json(object, options = {})
       prepare_for_render(object, options).as_json
     end
 
@@ -279,7 +279,6 @@ module Blueprinter
     end
 
 
-
     # Specify one transformer to be included for serialization.
     # Takes a class which extends Blueprinter::Transformer
     #

data/lib/blueprinter/helpers/base_helpers.rb

@@ -8,11 +8,12 @@ module Blueprinter
       include TypeHelpers
 
       private
+
       def prepare_for_render(object, options)
         view_name = options.delete(:view) || :default
         root = options.delete(:root)
         meta = options.delete(:meta)
-        validate_root_and_meta(root, meta)
+        validate_root_and_meta!(root, meta)
         prepare(object, view_name: view_name, local_options: options, root: root, meta: meta)
       end
 
@@ -20,19 +21,19 @@ module Blueprinter
         if array_like?(object)
           object.map do |obj|
             object_to_hash(obj,
-                          view_name: view_name,
-                          local_options: local_options)
+                           view_name: view_name,
+                           local_options: local_options)
           end
         else
           object_to_hash(object,
-                        view_name: view_name,
-                        local_options: local_options)
+                         view_name: view_name,
+                         local_options: local_options)
         end
       end
 
       def prepend_root_and_meta(data, root, meta)
         return data unless root
-        ret = { root => data }
+        ret = {root => data}
         meta ? ret.merge!(meta: meta) : ret
       end
 
@@ -43,15 +44,15 @@ module Blueprinter
       def object_to_hash(object, view_name:, local_options:)
         result_hash = view_collection.fields_for(view_name).each_with_object({}) do |field, hash|
           next if field.skip?(field.name, object, local_options)
-           hash[field.name] = field.extract(object, local_options)
+          hash[field.name] = field.extract(object, local_options)
         end
         view_collection.transformers(view_name).each do |transformer|
-           transformer.transform(result_hash,object,local_options)
+          transformer.transform(result_hash, object, local_options)
         end
         result_hash
       end
 
-      def validate_root_and_meta(root, meta)
+      def validate_root_and_meta!(root, meta)
         case root
         when String, Symbol
           # no-op
@@ -62,6 +63,44 @@ module Blueprinter
         end
       end
 
+      def dynamic_blueprint?(blueprint)
+        blueprint.is_a?(Proc)
+      end
+
+      def validate_blueprint!(blueprint, method)
+        validate_presence_of_blueprint!(blueprint)
+        unless dynamic_blueprint?(blueprint)
+          validate_blueprint_has_ancestors!(blueprint, method)
+          validate_blueprint_has_blueprinter_base_ancestor!(blueprint, method)
+        end
+      end
+
+      def validate_presence_of_blueprint!(blueprint)
+        raise BlueprinterError, 'Blueprint required' unless blueprint
+      end
+
+      def validate_blueprint_has_ancestors!(blueprint, association_name)
+        # If the class passed as a blueprint does not respond to ancestors
+        # it means it, at the very least, does not have Blueprinter::Base as
+        # one of its ancestor classes (e.g: Hash) and thus an error should
+        # be raised.
+        unless blueprint.respond_to?(:ancestors)
+          raise BlueprinterError, "Blueprint provided for #{association_name} "\
+                                'association is not valid.'
+        end
+      end
+
+      def validate_blueprint_has_blueprinter_base_ancestor!(blueprint, association_name)
+        # Guard clause in case Blueprinter::Base is present in the ancestor list
+        # for the blueprint class provided.
+        return if blueprint.ancestors.include? Blueprinter::Base
+
+        # Raise error describing what's wrong.
+        raise BlueprinterError, "Class #{blueprint.name} does not inherit from "\
+                              'Blueprinter::Base and is not a valid Blueprinter '\
+                              "for #{association_name} association."
+      end
+
       def jsonify(blob)
         Blueprinter.configuration.jsonify(blob)
       end

data/lib/blueprinter/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.25.1
 platform: ruby
 authors:
 - Adam Hess
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-06 00:00:00.000000000 Z
+date: 2020-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot