blueprinter-rb 1.1.1 → 1.2.0

data/lib/blueprinter/base.rb

@@ -60,7 +60,7 @@ module Blueprinter
         name,
         extractor,
         self,
-        block: block,
+        block: block
       )
     end
 
@@ -125,7 +125,7 @@ module Blueprinter
         options.fetch(:name) { method },
         options.fetch(:extractor) { Blueprinter.configuration.extractor_default.new },
         self,
-        options.merge(block: block),
+        options.merge(block: block)
       )
     end
 
@@ -165,7 +165,7 @@ module Blueprinter
         method,
         options.merge(
           association: true,
-          extractor: options.fetch(:extractor) { AssociationExtractor.new },
+          extractor: options.fetch(:extractor) { AssociationExtractor.new }
         ),
         &block
       )
@@ -254,9 +254,7 @@ module Blueprinter
     #
     # @api private
     def self.prepare(object, view_name:, local_options:, root: nil, meta: nil)
-      unless view_collection.has_view? view_name
-        raise BlueprinterError, "View '#{view_name}' is not defined"
-      end
+      raise BlueprinterError, "View '#{view_name}' is not defined" unless view_collection.view? view_name
 
       data = prepare_data(object, view_name, local_options)
       prepend_root_and_meta(data, root, meta)
@@ -281,7 +279,6 @@ module Blueprinter
       end
     end
 
-
     # Specify one transformer to be included for serialization.
     # Takes a class which extends Blueprinter::Transformer
     #
@@ -317,7 +314,6 @@ module Blueprinter
       current_view.add_transformer(transformer)
     end
 
-
     # Specify another view that should be mixed into the current view.
     #
     # @param view_name [Symbol] the view to mix into the current view.
@@ -340,7 +336,6 @@ module Blueprinter
       current_view.include_view(view_name)
     end
 
-
     # Specify additional views that should be mixed into the current view.
     #
     #  @param view_name [Array<Symbol>] the views to mix into the current view.
@@ -363,12 +358,10 @@ module Blueprinter
     #
     # @return [Array<Symbol>] an array of view names.
 
-
     def self.include_views(*view_names)
       current_view.include_views(view_names)
     end
 
-
     # Exclude a field that was mixed into the current view.
     #
     # @param field_name [Symbol] the field to exclude from the current view.
@@ -446,13 +439,13 @@ module Blueprinter
     #  end
     # end
     #
-    #  ExampleBlueprint.has_view?(:custom) => true
-    #  ExampleBlueprint.has_view?(:doesnt_exist) => false
+    #  ExampleBlueprint.view?(:custom) => true
+    #  ExampleBlueprint.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
+    def self.view?(view_name)
+      view_collection.view? view_name
     end
   end
 end

data/lib/blueprinter/configuration.rb

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

data/lib/blueprinter/deprecation.rb

@@ -4,8 +4,8 @@
 module Blueprinter
   class Deprecation
     class << self
-      VALID_BEHAVIORS = %i(silence stderror raise).freeze
-      MESSAGE_PREFIX = "[DEPRECATION::WARNING] Blueprinter:"
+      VALID_BEHAVIORS = %i[silence stderror raise].freeze
+      MESSAGE_PREFIX = '[DEPRECATION::WARNING] Blueprinter:'
 
       def report(message)
         full_msg = qualified_message(message)
@@ -28,7 +28,7 @@ module Blueprinter
 
       def behavior
         configured = Blueprinter.configuration.deprecations
-        return configured unless !VALID_BEHAVIORS.include?(configured)
+        return configured if VALID_BEHAVIORS.include?(configured)
 
         :stderror
       end

data/lib/blueprinter/empty_types.rb

@@ -3,12 +3,13 @@
 require_relative 'helpers/type_helpers'
 
 module Blueprinter
-  EMPTY_COLLECTION = "empty_collection"
-  EMPTY_HASH = "empty_hash"
-  EMPTY_STRING = "empty_string"
+  EMPTY_COLLECTION = 'empty_collection'
+  EMPTY_HASH = 'empty_hash'
+  EMPTY_STRING = 'empty_string'
 
   module EmptyTypes
     include TypeHelpers
+
     private
 
     def use_default_value?(value, empty_type)
@@ -20,12 +21,7 @@ module Blueprinter
       when Blueprinter::EMPTY_HASH
         value.is_a?(Hash) && value.empty?
       when Blueprinter::EMPTY_STRING
-        value.to_s == ""
-      else
-        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]"
-        )
+        value.to_s == ''
       end
     end
   end

data/lib/blueprinter/extractor.rb

@@ -2,12 +2,12 @@
 
 module Blueprinter
   class Extractor
-    def extract(_field_name, _object, _local_options, _options={})
-      fail NotImplementedError, "An Extractor must implement #extract"
+    def extract(_field_name, _object, _local_options, _options = {})
+      raise NotImplementedError, 'An Extractor must implement #extract'
     end
 
-    def self.extract(field_name, object, local_options, options={})
-      self.new.extract(field_name, object, local_options, options)
+    def self.extract(field_name, object, local_options, options = {})
+      new.extract(field_name, object, local_options, options)
     end
   end
 end

data/lib/blueprinter/extractors/association_extractor.rb

@@ -9,12 +9,13 @@ module Blueprinter
       @extractor = Blueprinter.configuration.extractor_default.new
     end
 
-    def extract(association_name, object, local_options, options={})
-      options_without_default = options.reject { |k,_| k == :default || k == :default_if }
+    def extract(association_name, object, local_options, options = {})
+      options_without_default = options.reject { |k, _| %i[default default_if].include?(k) }
       # 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
       blueprint = association_blueprint(options[:blueprint], value)
       blueprint.prepare(value, view_name: view, local_options: local_options)

data/lib/blueprinter/extractors/block_extractor.rb

@@ -3,7 +3,7 @@
 module Blueprinter
   # @api private
   class BlockExtractor < Extractor
-    def extract(field_name, object, local_options, options = {})
+    def extract(_field_name, object, local_options, options = {})
       options[:block].call(object, local_options)
     end
   end

data/lib/blueprinter/extractors/public_send_extractor.rb

@@ -3,7 +3,7 @@
 module Blueprinter
   # @api private
   class PublicSendExtractor < Extractor
-    def extract(field_name, object, local_options, options = {})
+    def extract(field_name, object, _local_options, _options = {})
       object.public_send(field_name)
     end
   end

data/lib/blueprinter/field.rb

@@ -1,65 +1,60 @@
 # frozen_string_literal: true
 
 # @api private
-class Blueprinter::Field
-  attr_reader :method, :name, :extractor, :options, :blueprint
-  def initialize(method, name, extractor, blueprint, options = {})
-    @method = method
-    @name = name
-    @extractor = extractor
-    @blueprint = blueprint
-    @options = options
-  end
+module Blueprinter
+  class Field
+    attr_reader :method, :name, :extractor, :options, :blueprint
+
+    def initialize(method, name, extractor, blueprint, options = {})
+      @method = method
+      @name = name
+      @extractor = extractor
+      @blueprint = blueprint
+      @options = options
+    end
 
-  def extract(object, local_options)
-    extractor.extract(method, object, local_options, options)
-  end
+    def extract(object, local_options)
+      extractor.extract(method, object, local_options, options)
+    end
 
-  def skip?(field_name, object, local_options)
-    return true if if_callable && !if_callable.call(field_name, object, local_options)
-    unless_callable && unless_callable.call(field_name, object, local_options)
-  end
+    def skip?(field_name, object, local_options)
+      return true if if_callable && !if_callable.call(field_name, object, local_options)
 
-  private
+      unless_callable && unless_callable.call(field_name, object, local_options)
+    end
 
-  def if_callable
-    return @if_callable if defined?(@if_callable)
-    @if_callable = callable_from(:if)
-  end
+    private
 
-  def unless_callable
-    return @unless_callable if defined?(@unless_callable)
-    @unless_callable = callable_from(:unless)
-  end
+    def if_callable
+      return @if_callable if defined?(@if_callable)
 
-  def callable_from(condition)
-    callable = old_callable_from(condition)
+      @if_callable = callable_from(:if)
+    end
 
-    if callable && callable.arity == 2
-      Blueprinter::Deprecation.report("`:#{condition}` conditions now expects 3 arguments instead of 2.")
-      ->(_field_name, obj, options) { callable.call(obj, options) }
-    else
-      callable
+    def unless_callable
+      return @unless_callable if defined?(@unless_callable)
+
+      @unless_callable = callable_from(:unless)
     end
-  end
 
-  def old_callable_from(condition)
-    config = Blueprinter.configuration
+    def callable_from(condition)
+      config = Blueprinter.configuration
 
-    # Use field-level callable, or when not defined, try global callable
-    tmp = if options.key?(condition)
-            options.fetch(condition)
-          elsif config.valid_callable?(condition)
-            config.public_send(condition)
-          end
+      # Use field-level callable, or when not defined, try global callable
+      tmp = if options.key?(condition)
+              options.fetch(condition)
+            elsif config.valid_callable?(condition)
+              config.public_send(condition)
+            end
 
-    return false unless tmp
+      return false unless tmp
 
-    case tmp
-    when Proc then tmp
-    when Symbol then blueprint.method(tmp)
-    else
-      raise ArgumentError, "#{tmp.class} is passed to :#{condition}"
+      case tmp
+      when Proc then tmp
+      when Symbol then blueprint.method(tmp)
+      else
+        raise ArgumentError, "#{tmp.class} is passed to :#{condition}"
+      end
     end
   end
 end

data/lib/blueprinter/formatters/date_time_formatter.rb

@@ -26,7 +26,7 @@ module Blueprinter
       when Proc then format.call(value)
       when String then value.strftime(format)
       else
-        raise InvalidDateTimeFormatterError, 'Cannot format DateTime object with invalid formatter: #{format.class}'
+        raise InvalidDateTimeFormatterError, "Cannot format DateTime object with invalid formatter: #{format.class}"
       end
     end
   end

data/lib/blueprinter/helpers/base_helpers.rb

@@ -35,7 +35,8 @@ module Blueprinter
 
       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
 
@@ -46,6 +47,7 @@ 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)
         end
         view_collection.transformers(view_name).each do |transformer|
@@ -59,9 +61,9 @@ module Blueprinter
         when String, Symbol
           # no-op
         when NilClass
-          raise BlueprinterError, "meta requires a root to be passed" if meta
+          raise BlueprinterError, 'meta requires a root to be passed' if meta
         else
-          raise BlueprinterError, "root should be one of String, Symbol, NilClass"
+          raise BlueprinterError, 'root should be one of String, Symbol, NilClass'
         end
       end
 
@@ -71,10 +73,10 @@ module Blueprinter
 
       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
+        return if dynamic_blueprint?(blueprint)
+
+        validate_blueprint_has_ancestors!(blueprint, method)
+        validate_blueprint_has_blueprinter_base_ancestor!(blueprint, method)
       end
 
       def validate_presence_of_blueprint!(blueprint)
@@ -86,10 +88,10 @@ module Blueprinter
         # 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} "\
+        return if 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)
@@ -98,9 +100,9 @@ module Blueprinter
         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."
+        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)

data/lib/blueprinter/transformer.rb

@@ -4,11 +4,11 @@ module Blueprinter
   # @api private
   class Transformer
     def transform(_result_hash, _primary_obj, _options = {})
-      fail NotImplementedError, "A Transformer must implement #transform"
+      raise NotImplementedError, 'A Transformer must implement #transform'
     end
 
     def self.transform(result_hash, primary_obj, options = {})
-      self.new.transform(result_hash, primary_obj, options)
+      new.transform(result_hash, primary_obj, options)
     end
   end
 end

data/lib/blueprinter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Blueprinter
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/lib/blueprinter/view.rb

@@ -20,14 +20,14 @@ module Blueprinter
       view_transformers.empty? ? Blueprinter.configuration.default_transformers : view_transformers
     end
 
-    def track_definition_order(method, is_view = true)
-      if @sort_by_definition
-        @definition_order << DefinitionPlaceholder.new(method, is_view)
-      end
+    def track_definition_order(method, viewable: true)
+      return unless @sort_by_definition
+
+      @definition_order << DefinitionPlaceholder.new(method, viewable)
     end
 
     def inherit(view)
-      view.fields.values.each do |field|
+      view.fields.each_value do |field|
         self << field
       end
 
@@ -71,7 +71,7 @@ module Blueprinter
     end
 
     def <<(field)
-      track_definition_order(field.name,false)
+      track_definition_order(field.name, viewable: false)
       fields[field.name] = field
     end
   end

data/lib/blueprinter/view_collection.rb

@@ -4,6 +4,7 @@ module Blueprinter
   # @api private
   class ViewCollection
     attr_reader :views, :sort_by_definition
+
     def initialize
       @views = {
         identifier: View.new(:identifier),
@@ -18,8 +19,8 @@ module Blueprinter
       end
     end
 
-    def has_view?(view_name)
-      views.has_key? view_name
+    def view?(view_name)
+      views.key? view_name
     end
 
     def fields_for(view_name)
@@ -28,8 +29,8 @@ module Blueprinter
       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).tap do |fields|
-        fields.reject! { |field| excluded_fields.include?(field.name) }
+      (identifier_fields + sorted_fields).tap do |fields_array|
+        fields_array.reject! { |field| excluded_fields.include?(field.name) }
       end
     end
 
@@ -69,7 +70,9 @@ module Blueprinter
     # 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)  }
+      views[:default].definition_order.each do |definition|
+        add_to_ordered_fields(ordered_fields, definition, fields, view_name)
+      end
       ordered_fields.values
     end
 
@@ -78,7 +81,9 @@ module Blueprinter
     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) }
+          views[definition.name].definition_order.each do |defined|
+            add_to_ordered_fields(ordered_fields, defined, fields)
+          end
         end
       else
         ordered_fields[definition.name] = fields[definition.name]

data/lib/generators/blueprinter/blueprint_generator.rb

@@ -3,39 +3,31 @@
 module Blueprinter
   module Generators
     class BlueprintGenerator < ::Rails::Generators::NamedBase
-      desc "Generates blueprint for ActiveRecord model with the given NAME."
+      desc 'Generates blueprint for ActiveRecord model with the given NAME.'
 
       attr_accessor :options
 
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path('templates', __dir__)
 
+      class_option :blueprints_dir, default: 'app/blueprints', desc: 'path to new blueprint', aliases: '-d'
 
+      class_option :identifier, default: nil,
+                                desc: 'Add an identifer to the generated blueprint, either uses :id or your specified value', aliases: '-i', banner: 'id'
 
-      class_option :blueprints_dir, default: "app/blueprints", desc: "path to new blueprint", aliases: "-d"
+      class_option :fields, type: :array, default: [], desc: 'Manually add specified fields'
 
+      class_option :detect_fields, type: :boolean, default: false,
+                                   desc: 'Introspect on the model to set fields in the generated blueprint. Will be merged with any manually specified'
 
+      class_option :associations, type: :array, default: [], desc: 'Manually add specified associations', aliases: '-a'
 
-      class_option :identifier, default: nil, desc: "Add an identifer to the generated blueprint, either uses :id or your specified value", aliases: "-i", banner: "id"
-
-
-
-      class_option :fields, type: :array, default: [], desc: "Manually add specified fields"
-
-      class_option :detect_fields, type: :boolean, default: false, desc: "Introspect on the model to set fields in the generated blueprint. Will be merged with any manually specified"
-
-
-
-      class_option :associations, type: :array, default: [], desc: "Manually add specified associations", aliases: "-a"
-
-      class_option :detect_associations, type: :boolean, default: false, desc: "Introspect on the model to set associations in the generated blueprint. Will be merged with any manually specified"
-
-
-
-      class_option :wrap_at, type: :numeric, default: 80, desc: "Maximum length of generated fields line", aliases: "-w"
-
-      class_option :indentation, type: :string, default: "two", desc: "Indentation of generated file", banner: "two|four|tab"
+      class_option :detect_associations, type: :boolean, default: false,
+                                         desc: 'Introspect on the model to set associations in the generated blueprint. Will be merged with any manually specified'
 
+      class_option :wrap_at, type: :numeric, default: 80, desc: 'Maximum length of generated fields line', aliases: '-w'
 
+      class_option :indentation, type: :string, default: 'two', desc: 'Indentation of generated file',
+                                 banner: 'two|four|tab'
 
       remove_class_option :skip_namespace
 
@@ -44,30 +36,28 @@ module Blueprinter
       end
 
       def create_blueprint
-        template "blueprint.rb", File.join(path, "#{file_path}_blueprint.rb")
+        template 'blueprint.rb', File.join(path, "#{file_path}_blueprint.rb")
       end
 
-
-
       private
 
       def path
-        options["blueprints_dir"]
+        options['blueprints_dir']
       end
 
       def identifier_symbol
-        if options['identifier']
-           options['identifier'] == "identifier" ? :id : options['identifier']
-        end
+        return unless options['identifier']
+
+        options['identifier'] == 'identifier' ? :id : options['identifier']
       end
 
       def fields
-        fs = if options["detect_fields"]
-               Array.new(options["fields"]).concat(introspected_fields)
+        fs = if options['detect_fields']
+               Array.new(options['fields']).concat(introspected_fields)
              else
-               options["fields"]
+               options['fields']
              end
-        fs.reject {|f| f.blank? }.uniq
+        fs.reject(&:blank?).uniq
       end
 
       def introspected_fields
@@ -77,30 +67,29 @@ module Blueprinter
       # split at wrap_at chars, two indentations
       def formatted_fields
         two_indents = indent * 2
-        fields_string = fields.reduce([]) do |memo, f|
-          if !memo.last.nil?
+        fields_string = fields.each_with_object([]) do |f, memo|
+          if memo.last.nil?
+            memo << " :#{f},"
+          else
             now = "#{memo.last} :#{f},"
-            if now.length > options["wrap_at"].to_i
+            if now.length > options['wrap_at'].to_i
               memo << ":#{f},"
             else
               memo[memo.length - 1] = now
             end
-          else
-            memo << " :#{f},"
           end
-          memo
         end.join("\n#{two_indents}")
 
-        fields_string[0,fields_string.length - 1]
+        fields_string[0, fields_string.length - 1]
       end
 
       def associations
-        as = if options["detect_associations"]
-               Array.new(options["associations"]).concat(introspected_associations.keys)
+        as = if options['detect_associations']
+               Array.new(options['associations']).concat(introspected_associations.keys)
              else
-               options["associations"]
+               options['associations']
              end
-        as.reject {|f| f.blank? }.uniq
+        as.reject(&:blank?).uniq
       end
 
       def introspected_associations
@@ -114,15 +103,13 @@ module Blueprinter
       def association_class(association_name)
         introspected_name = if introspected_associations[association_name].respond_to?(:klass)
                               introspected_associations[association_name].klass.to_s
-                            else
-                              nil
                             end
         "#{introspected_name || association_name.camelcase}Blueprint"
       end
 
       def indent
-        user_intended = {two: "  ", four: "    ", tab:"\t"}[options["indentation"].intern]
-        user_intended.nil? ? "  " : user_intended
+        user_intended = { two: '  ', four: '    ', tab: "\t" }[options['indentation'].intern]
+        user_intended.nil? ? '  ' : user_intended
       end
     end
   end