blueprinter 0.26.0 → 1.0.0

data/lib/blueprinter/reflection.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Blueprinter
+  #
+  # Public methods for reflecting on a Blueprint.
+  #
+  module Reflection
+    Field = Struct.new(:name, :display_name, :options)
+    Association = Struct.new(:name, :display_name, :blueprint, :view, :options)
+
+    #
+    # Returns a Hash of views keyed by name.
+    #
+    # Example:
+    #
+    #   widget_view = WidgetBlueprint.reflections[:default]
+    #   category = widget_view.associations[:category]
+    #   category.blueprint
+    #   => CategoryBlueprint
+    #   category.view
+    #   => :default
+    #
+    # @return [Hash<Symbol, Blueprinter::Reflection::View>]
+    #
+    def reflections
+      @reflections ||= view_collection.views.transform_values do |view|
+        View.new(view.name, view_collection)
+      end
+    end
+
+    #
+    # Represents a view within a Blueprint.
+    #
+    class View
+      attr_reader :name
+
+      def initialize(name, view_collection)
+        @name = name
+        @view_collection = view_collection
+      end
+
+      #
+      # Returns a Hash of fields in this view (recursive) keyed by method name.
+      #
+      # @return [Hash<Symbol, Blueprinter::Reflection::Field>]
+      #
+      def fields
+        @fields ||= @view_collection.fields_for(name).each_with_object({}) do |field, obj|
+          next if field.options[:association]
+
+          obj[field.method] = Field.new(field.method, field.name, field.options)
+        end
+      end
+
+      #
+      # Returns a Hash of associations in this view (recursive) keyed by method name.
+      #
+      # @return [Hash<Symbol, Blueprinter::Reflection::Association>]
+      #
+      def associations
+        @associations ||= @view_collection.fields_for(name).each_with_object({}) do |field, obj|
+          next unless field.options[:association]
+
+          blueprint = field.options.fetch(:blueprint)
+          view = field.options[:view] || :default
+          obj[field.method] = Association.new(field.method, field.name, blueprint, view, field.options)
+        end
+      end
+    end
+  end
+end

data/lib/blueprinter/transformer.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blueprinter
-  VERSION = '0.26.0'.freeze
+  VERSION = '1.0.0'
 end

data/lib/blueprinter/view.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blueprinter
   # @api private
   DefinitionPlaceholder = Struct.new :name, :view?
@@ -14,18 +16,14 @@ module Blueprinter
       @sort_by_definition = Blueprinter.configuration.sort_fields_by.eql?(:definition)
     end
 
-    def transformers
-      view_transformers.empty? ? Blueprinter.configuration.default_transformers : view_transformers
-    end
+    def track_definition_order(method, viewable: true)
+      return unless @sort_by_definition
 
-    def track_definition_order(method, is_view = true)
-      if @sort_by_definition
-        @definition_order << DefinitionPlaceholder.new(method, is_view)
-      end
+      @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
 
@@ -69,7 +67,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

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module Blueprinter
   # @api private
   class ViewCollection
     attr_reader :views, :sort_by_definition
+
     def initialize
       @views = {
         identifier: View.new(:identifier),
@@ -16,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)
@@ -26,11 +29,15 @@ 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).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
 
     def transformers(view_name)
-      views[view_name].transformers
+      included_transformers = gather_transformers_from_included_views(view_name).reverse
+      all_transformers = views[:default].view_transformers.concat(included_transformers).uniq
+      all_transformers.empty? ? Blueprinter.configuration.default_transformers : all_transformers
     end
 
     def [](view_name)
@@ -47,15 +54,15 @@ module Blueprinter
     # @return [Array<(Hash, Hash<String, NilClass>)>] fields, excluded_fields
     def sortable_fields(view_name)
       excluded_fields = {}
-      fields = views[:default].fields
+      fields = views[:default].fields.clone
       views[view_name].included_view_names.each do |included_view_name|
         next if view_name == included_view_name
 
         view_fields, view_excluded_fields = sortable_fields(included_view_name)
-        fields = merge_fields(fields, view_fields)
+        fields.merge!(view_fields)
         excluded_fields.merge!(view_excluded_fields)
       end
-      fields = merge_fields(fields, views[view_name].fields)
+      fields.merge!(views[view_name].fields) unless view_name == :default
 
       views[view_name].excluded_field_names.each { |name| excluded_fields[name] = nil }
 
@@ -65,7 +72,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
 
@@ -74,15 +83,22 @@ 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]
       end
     end
 
-    def merge_fields(source_fields, included_fields)
-      source_fields.merge included_fields
+    def gather_transformers_from_included_views(view_name)
+      current_view = views[view_name]
+      current_view.included_view_names.flat_map do |included_view_name|
+        next [] if view_name == included_view_name
+
+        gather_transformers_from_included_views(included_view_name)
+      end.concat(current_view.view_transformers)
     end
   end
 end

data/lib/blueprinter.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require_relative 'blueprinter/base'
+require_relative 'blueprinter/extension'
 
 module Blueprinter
 end

data/lib/generators/blueprinter/blueprint_generator.rb

@@ -1,39 +1,33 @@
+# frozen_string_literal: true
+
 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__)
-
-
-
-      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 :fields, type: :array, default: [], desc: "Manually add specified fields"
+      source_root File.expand_path('templates', __dir__)
 
-      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 :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 :fields, type: :array, default: [], desc: 'Manually add specified fields'
 
-      class_option :associations, type: :array, default: [], desc: "Manually add specified associations", aliases: "-a"
+      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 :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 :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 :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 :indentation, type: :string, default: 'two', desc: 'Indentation of generated file',
+                                 banner: 'two|four|tab'
 
       remove_class_option :skip_namespace
 
@@ -42,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
@@ -75,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
@@ -112,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

data/lib/generators/blueprinter/templates/blueprint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class <%= class_name %>Blueprint < Blueprinter::Base
 <% if identifier_symbol -%>
 <%= indent -%>identifier :<%= identifier_symbol %>

metadata

@@ -1,183 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 1.0.0
 platform: ruby
 authors:
-- Derek Carter
+- Procore Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-19 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.7
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.7
-- !ruby/object:Gem::Dependency
-  name: ammeter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.1.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.1.4
-- !ruby/object:Gem::Dependency
-  name: factory_bot
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.2
-- !ruby/object:Gem::Dependency
-  name: oj
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.2
-- !ruby/object:Gem::Dependency
-  name: yajl-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.1
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.11
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.11
+date: 2024-01-18 00:00:00.000000000 Z
+dependencies: []
 description: Blueprinter is a JSON Object Presenter for Ruby that takes business objects
   and breaks them down into simple hashes and serializes them to JSON. It can be used
   in Rails in place of other serializers (like JBuilder or ActiveModelSerializers).
@@ -198,6 +30,8 @@ files:
 - lib/blueprinter/configuration.rb
 - lib/blueprinter/deprecation.rb
 - lib/blueprinter/empty_types.rb
+- lib/blueprinter/extension.rb
+- lib/blueprinter/extensions.rb
 - lib/blueprinter/extractor.rb
 - lib/blueprinter/extractors/association_extractor.rb
 - lib/blueprinter/extractors/auto_extractor.rb
@@ -208,18 +42,19 @@ files:
 - lib/blueprinter/formatters/date_time_formatter.rb
 - lib/blueprinter/helpers/base_helpers.rb
 - lib/blueprinter/helpers/type_helpers.rb
+- lib/blueprinter/reflection.rb
 - lib/blueprinter/transformer.rb
 - lib/blueprinter/version.rb
 - lib/blueprinter/view.rb
 - lib/blueprinter/view_collection.rb
 - lib/generators/blueprinter/blueprint_generator.rb
 - lib/generators/blueprinter/templates/blueprint.rb
-- lib/tasks/blueprinter_tasks.rake
 homepage: https://github.com/procore-oss/blueprinter
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/tasks/blueprinter_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :blueprinter do
-#   # Task goes here
-# end