RubyGems - blueprinter - Versions diffs - 0.25.3 → 0.30.0 - Mend

blueprinter 0.25.3 → 0.30.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (28) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +58 -50
data/README.md +124 -85
data/Rakefile +13 -1
data/lib/blueprinter/base.rb +10 -15
data/lib/blueprinter/blueprinter_error.rb +2 -0
data/lib/blueprinter/configuration.rb +14 -2
data/lib/blueprinter/deprecation.rb +5 -3
data/lib/blueprinter/empty_types.rb +7 -9
data/lib/blueprinter/extractor.rb +6 -4
data/lib/blueprinter/extractors/association_extractor.rb +8 -3
data/lib/blueprinter/extractors/auto_extractor.rb +2 -0
data/lib/blueprinter/extractors/block_extractor.rb +3 -1
data/lib/blueprinter/extractors/hash_extractor.rb +2 -0
data/lib/blueprinter/extractors/public_send_extractor.rb +3 -1
data/lib/blueprinter/field.rb +44 -47
data/lib/blueprinter/formatters/date_time_formatter.rb +3 -1
data/lib/blueprinter/helpers/base_helpers.rb +17 -13
data/lib/blueprinter/helpers/type_helpers.rb +5 -5
data/lib/blueprinter/transformer.rb +4 -2
data/lib/blueprinter/version.rb +3 -1
data/lib/blueprinter/view.rb +8 -6
data/lib/blueprinter/view_collection.rb +17 -12
data/lib/blueprinter.rb +2 -0
data/lib/generators/blueprinter/blueprint_generator.rb +37 -48
data/lib/generators/blueprinter/templates/blueprint.rb +2 -0
metadata +11 -179
data/lib/tasks/blueprinter_tasks.rake +0 -4

data/lib/blueprinter.rb CHANGED Viewed

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
 require_relative 'blueprinter/base'
 module Blueprinter

data/lib/generators/blueprinter/blueprint_generator.rb CHANGED Viewed

@@ -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 CHANGED Viewed

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

metadata CHANGED Viewed

@@ -1,190 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter
 version: !ruby/object:Gem::Version
-  version: 0.25.3
+  version: 0.30.0
 platform: ruby
 authors:
-- Adam Hess
-- Derek Carter
+- Procore Technologies, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
-dependencies:
-- !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: 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: 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: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.1.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.1.2
-- !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: 4.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.6
-- !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
-- !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
+date: 2023-09-20 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).
   It is designed to be simple, direct, and performant.
 email:
-- adamhess1991@gmail.com
+- blueprinter@googlegroups.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -215,11 +46,12 @@ files:
 - 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/blueprinter
+homepage: https://github.com/procore-oss/blueprinter
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -228,14 +60,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Simple Fast Declarative Serialization Library

data/lib/tasks/blueprinter_tasks.rake DELETED Viewed

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