blueprinter 0.21.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8c9a52221d1a5473708cc7391865c25400d9e34440a1c0c52d76f2e7c811997
-  data.tar.gz: 380008b99bfd079c13d3c8ce019e4160b92141c20c639b233adaa6ef1ccfc9e5
+  metadata.gz: 335ed3cf4448c0972904b81679e8e95304ab075064c1022555062b8eb07eaf12
+  data.tar.gz: fd442388bb18481015b4ae8ed79ca9b79b9a34f6eef6f5b31eb9ef473c458287
 SHA512:
-  metadata.gz: 225d6b77da9cf47411b014372234e7091d52d6a8ce0d358cc01d6f4a9eb188eafab70a50295a9e9ba3b15863d91cc35a3e3dcdcf501221ca8c959c785420e064
-  data.tar.gz: 0f407b0d11bcce8176c8e31f15e16f497431ffffe637ffe35e03779e91335902d70ef778546f55913b18885a261a9472fadc81b62caef490e64eb02d07900f5f
+  metadata.gz: 6855988c4693065d2620a19995f326718fd14796b0ec856b1ace0d5e91068959c72ada4788881e4b7bc2fbe587f56cf146dba06817431feaa6fb7d487d2d1eba
+  data.tar.gz: 4aef0b54eea76568616e860863d782caced131399cdd36bdec2874f5b701b139517367556fe880f5041b7acd4fe6619eba79f8c7180c8fe8b31f09bd279cdc5d

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.22.0  - 2019/12/26
+* 🚀 [FEATURE] Add rails generators. See `rails g blueprinter:blueprint --help` for usage. Introduced in [#176](https://github.com/procore/blueprinter/pull/176) by [@wlkrw](https://github.com/wlkrw).
+
 ## 0.21.0  - 2019/12/19
 * 🚀 [FEATURE] Ability to specify `default_if` field/association option for more control on when the default value is applied. [191](https://github.com/procore/blueprinter/pull/191). Thanks to [@mcclayton](https://github.com/mcclayton).
 

data/lib/blueprinter/version.rb

@@ -1,3 +1,3 @@
 module Blueprinter
-  VERSION = '0.21.0'.freeze
+  VERSION = '0.22.0'.freeze
 end

data/lib/generators/blueprinter/blueprint_generator.rb

@@ -0,0 +1,127 @@
+module Blueprinter
+  module Generators
+    class BlueprintGenerator < ::Rails::Generators::NamedBase
+      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"
+
+      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"
+
+
+
+      remove_class_option :skip_namespace
+
+      def ensure_blueprint_dir
+        FileUtils.mkdir_p(path) unless File.directory?(path)
+      end
+
+      def create_blueprint
+        template "blueprint.rb", File.join(path, "#{file_path}_blueprint.rb")
+      end
+
+
+
+      private
+
+      def path
+        options["blueprints_dir"]
+      end
+
+      def identifier_symbol
+        if options['identifier']
+           options['identifier'] == "identifier" ? :id : options['identifier']
+        end
+      end
+
+      def fields
+        fs = if options["detect_fields"]
+               Array.new(options["fields"]).concat(introspected_fields)
+             else
+               options["fields"]
+             end
+        fs.reject {|f| f.blank? }.uniq
+      end
+
+      def introspected_fields
+        class_name.constantize.columns_hash.keys
+      end
+
+      # 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?
+            now = "#{memo.last} :#{f},"
+            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]
+      end
+
+      def associations
+        as = if options["detect_associations"]
+               Array.new(options["associations"]).concat(introspected_associations.keys)
+             else
+               options["associations"]
+             end
+        as.reject {|f| f.blank? }.uniq
+      end
+
+      def introspected_associations
+        class_name.constantize.reflections
+      end
+
+      def association_blueprint(association_name)
+        ", blueprint: #{association_class(association_name)}"
+      end
+
+      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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+class <%= class_name %>Blueprint < Blueprinter::Base
+<% if identifier_symbol -%>
+<%= indent -%>identifier :<%= identifier_symbol %>
+
+<% end -%>
+<% if fields.any? -%>
+<%= indent -%>fields<%= formatted_fields %>
+
+<% end -%>
+<% associations.each do |a| -%>
+<%= indent -%>association :<%= a -%><%= association_blueprint(a) %>
+
+<% end -%>
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Adam Hess
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-19 00:00:00.000000000 Z
+date: 2019-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot
@@ -151,6 +151,20 @@ dependencies:
     - - "~>"
       - !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
 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).
@@ -184,6 +198,8 @@ files:
 - 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/blueprinter
 licenses: