gemsmith 11.2.0 → 11.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb78c42cc900eee4942327ad45879410de65014c8c50237244f57359d3dec392
-  data.tar.gz: 3f10400690bf4f524253daa9a370213e784691898550e8c1c6b4e50a583b1091
+  metadata.gz: 239c568371d501376dcff5619e20b4cd8946690316580a534b9eb4e7f7207f83
+  data.tar.gz: 04f1a037a219e2e95f2d04167488f2e8bbba179ec5f762cd857d99bca136ff7b
 SHA512:
-  metadata.gz: bb6f2a7df992c20ba3534f0baa868ae2f7bca4aae9ca8ebe30b0267ff9c6438d64c09825b0824eaf0552970b051f77f78e48dcfdb13b4b19256c4471d37ca32d
-  data.tar.gz: a8cef2c6beb8724976e6f670c428c8f42a95c46974d364f7fea88c382f89bba7038173d5f2823a19bf4a2fadacd2b91feceb2dee0779cbbe01768f2674e2acc6
+  metadata.gz: 0ad48caf292a01a67602e4b93c541a5511fc6014139605938a81f3801ac3f46eb66c7e0f999481cf13e39479ffe620c19137056e38e6700ad5e22b950fd84220
+  data.tar.gz: ddfd1d4c260cd1335f3574b4eabd270b8f41ec8d2ce1f8d5f5b2ac2e1ffdff0cecbc9085d0d967bbdcfc6697daabbf57c705b92ff764fcd3b57128db60b85030

data/README.md

@@ -127,6 +127,7 @@ The default configuration is as follows:
       :circle_ci: false
       :cli: false
       :code_climate: false
+      :engine: false
       :git_cop: true
       :git_hub: true
       :guard: true
@@ -185,6 +186,7 @@ For more gem generation options, type: `gemsmith --help --generate`
     [--circle-ci], [--no-circle-ci]          # Add Circle CI support.
     [--cli], [--no-cli]                      # Add CLI support.
     [--code-climate], [--no-code-climate]    # Add Code Climate support.
+    [--engine], [--no-engine]                # Add Rails Engine support.
     [--git-cop], [--no-git-cop]              # Add Git Cop support.
                                              # Default: true
     [--git-hub], [--no-git-hub]              # Add GitHub support.
@@ -193,7 +195,7 @@ For more gem generation options, type: `gemsmith --help --generate`
                                              # Default: true
     [--pry], [--no-pry]                      # Add Pry support.
                                              # Default: true
-    [--rails], [--no-rails]                  # Add Rails support.
+    [--rails], [--no-rails]                  # DEPRECATED (Use --engine instead). Add Rails support.
     [--reek], [--no-reek]                    # Add Reek support.
                                              # Default: true
     [--rspec], [--no-rspec]                  # Add RSpec support.

data/lib/gemsmith/cli.rb

@@ -63,6 +63,7 @@ module Gemsmith
           guard: true,
           pry: true,
           rails: false,
+          engine: false,
           reek: true,
           rspec: true,
           rubocop: true,
@@ -126,6 +127,10 @@ module Gemsmith
                   desc: "Add Code Climate support.",
                   type: :boolean,
                   default: configuration.to_h.dig(:generate, :code_climate)
+    method_option :engine,
+                  desc: "Add Rails Engine support.",
+                  type: :boolean,
+                  default: configuration.to_h.dig(:generate, :engine)
     method_option :git_cop,
                   desc: "Add Git Cop support.",
                   type: :boolean,
@@ -143,7 +148,7 @@ module Gemsmith
                   type: :boolean,
                   default: configuration.to_h.dig(:generate, :pry)
     method_option :rails,
-                  desc: "Add Rails support.",
+                  desc: "DEPRECATED (Use --engine instead). Add Rails support.",
                   type: :boolean,
                   default: configuration.to_h.dig(:generate, :rails)
     method_option :reek,
@@ -165,7 +170,11 @@ module Gemsmith
     # rubocop:disable Metrics/AbcSize
     # :reek:TooManyStatements
     def generate name
-      print_cli_and_rails_engine_option_error && return if options.cli? && options.rails?
+      rails = options.rails?
+      warn "[DEPRECATION]: --rails is deprecated, use --engine instead." if rails
+      print_cli_and_rails_engine_option_error && return if options.cli? && (
+        rails || options.engine?
+      )
 
       say_status :info, "Generating gem...", :green
 

data/lib/gemsmith/generators/base.rb

@@ -39,6 +39,10 @@ module Gemsmith
       def gem_root
         File.join cli.destination_root, gem_name
       end
+
+      def template path
+        cli.template path, configuration
+      end
     end
   end
 end

data/lib/gemsmith/generators/circle_ci.rb

@@ -6,7 +6,7 @@ module Gemsmith
     class CircleCI < Base
       def run
         return unless configuration.dig(:generate, :circle_ci)
-        cli.template "%gem_name%/circle.yml.tt", configuration
+        template "%gem_name%/circle.yml.tt"
       end
     end
   end

data/lib/gemsmith/generators/cli.rb

@@ -4,16 +4,14 @@ module Gemsmith
   module Generators
     # Generates Command Line Interface (CLI) support.
     class CLI < Base
-      # rubocop:disable Metrics/AbcSize
       def run
         return unless configuration.dig(:generate, :cli)
 
-        cli.template "%gem_name%/bin/%gem_name%.tt", configuration
-        cli.template "%gem_name%/lib/%gem_path%/cli.rb.tt", configuration
-        cli.template "%gem_name%/spec/lib/%gem_path%/cli_spec.rb.tt", configuration
+        template "%gem_name%/bin/%gem_name%.tt"
+        template "%gem_name%/lib/%gem_path%/cli.rb.tt"
+        template "%gem_name%/spec/lib/%gem_path%/cli_spec.rb.tt"
         cli.chmod "#{gem_name}/bin/#{gem_name}", 0o755
       end
-      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/gemsmith/generators/code_climate.rb

@@ -6,8 +6,7 @@ module Gemsmith
     class CodeClimate < Base
       def run
         return unless configuration.dig(:generate, :code_climate)
-
-        cli.template "%gem_name%/.codeclimate.yml.tt", configuration
+        template "%gem_name%/.codeclimate.yml.tt"
       end
     end
   end

data/lib/gemsmith/generators/documentation.rb

@@ -7,11 +7,11 @@ module Gemsmith
     # Generates documentation support.
     class Documentation < Base
       def create_files
-        cli.template "%gem_name%/README.md.tt", configuration
-        cli.template "%gem_name%/CONTRIBUTING.md.tt", configuration
-        cli.template "%gem_name%/CODE_OF_CONDUCT.md.tt", configuration
-        cli.template "%gem_name%/LICENSE.md.tt", configuration
-        cli.template "%gem_name%/CHANGES.md.tt", configuration
+        template "%gem_name%/README.md.tt"
+        template "%gem_name%/CONTRIBUTING.md.tt"
+        template "%gem_name%/CODE_OF_CONDUCT.md.tt"
+        template "%gem_name%/LICENSE.md.tt"
+        template "%gem_name%/CHANGES.md.tt"
       end
 
       def update_readme

data/lib/gemsmith/generators/gem.rb

@@ -4,17 +4,20 @@ module Gemsmith
   module Generators
     # Generates default gem support.
     class Gem < Base
-      # rubocop:disable Metrics/AbcSize
-      # :reek:TooManyStatements
       def run
-        cli.template "%gem_name%/bin/setup.tt", configuration
-        cli.template "%gem_name%/Gemfile.tt", configuration
-        cli.template "%gem_name%/%gem_name%.gemspec.tt", configuration
-        cli.template "#{lib_gem_root}.rb.tt", configuration
-        cli.template "#{lib_gem_root}/identity.rb.tt", configuration
+        create_files
         cli.chmod "#{configuration.dig(:gem, :name)}/bin/setup", 0o755
       end
-      # rubocop:enable Metrics/AbcSize
+
+      private
+
+      def create_files
+        template "%gem_name%/bin/setup.tt"
+        template "%gem_name%/Gemfile.tt"
+        template "%gem_name%/%gem_name%.gemspec.tt"
+        template "#{lib_gem_root}.rb.tt"
+        template "#{lib_gem_root}/identity.rb.tt"
+      end
     end
   end
 end

data/lib/gemsmith/generators/git.rb

@@ -5,7 +5,7 @@ module Gemsmith
     # Generates Git support.
     class Git < Base
       def create_ignore_file
-        cli.template "%gem_name%/.gitignore.tt", configuration
+        template "%gem_name%/.gitignore.tt"
       end
 
       # :reek:TooManyStatements

data/lib/gemsmith/generators/git_hub.rb

@@ -6,8 +6,8 @@ module Gemsmith
     class GitHub < Base
       def run
         return unless configuration.dig(:generate, :git_hub)
-        cli.template "%gem_name%/.github/ISSUE_TEMPLATE.md.tt", configuration
-        cli.template "%gem_name%/.github/PULL_REQUEST_TEMPLATE.md.tt", configuration
+        template "%gem_name%/.github/ISSUE_TEMPLATE.md.tt"
+        template "%gem_name%/.github/PULL_REQUEST_TEMPLATE.md.tt"
       end
     end
   end

data/lib/gemsmith/generators/guard.rb

@@ -6,7 +6,7 @@ module Gemsmith
     class Guard < Base
       def run
         return unless configuration.dig(:generate, :guard)
-        cli.template "%gem_name%/Guardfile.tt", configuration
+        template "%gem_name%/Guardfile.tt"
       end
     end
   end

data/lib/gemsmith/generators/rails.rb

@@ -2,7 +2,7 @@
 
 module Gemsmith
   module Generators
-    # Generates Ruby on Rails support.
+    # Generates Ruby on Rails Engine support.
     class Rails < Base
       def rails?
         cli.run "command -v rails > /dev/null"
@@ -15,19 +15,17 @@ module Gemsmith
       end
 
       def create_engine
-        cli.template "#{LIB_ROOT}/%gem_path%/engine.rb.tt", configuration
+        template "#{LIB_ROOT}/%gem_path%/engine.rb.tt"
         cli.run "rails plugin new --skip #{configuration.dig :gem, :name} #{engine_options}"
       end
 
-      # rubocop:disable Metrics/AbcSize
       def create_generator_files
         cli.empty_directory "#{generator_root}/templates"
-        cli.template "#{generator_root}/install/install_generator.rb.tt", configuration
-        cli.template "#{generator_root}/install/USAGE.tt", configuration
-        cli.template "#{generator_root}/upgrade/upgrade_generator.rb.tt", configuration
-        cli.template "#{generator_root}/upgrade/USAGE.tt", configuration
+        template "#{generator_root}/install/install_generator.rb.tt"
+        template "#{generator_root}/install/USAGE.tt"
+        template "#{generator_root}/upgrade/upgrade_generator.rb.tt"
+        template "#{generator_root}/upgrade/USAGE.tt"
       end
-      # rubocop:enable Metrics/AbcSize
 
       def stub_assets
         cli.run %(printf "%s" > "#{gem_name}/app/assets/javascripts/#{gem_path}/application.js")
@@ -45,7 +43,7 @@ module Gemsmith
 
       # :reek:TooManyStatements
       def run
-        return unless configuration.dig(:generate, :rails)
+        return unless runnable?
 
         install_rails
         create_engine
@@ -56,6 +54,10 @@ module Gemsmith
 
       private
 
+      def runnable?
+        configuration.dig(:generate, :engine) || configuration.dig(:generate, :rails)
+      end
+
       def engine_options
         "--skip-git " \
         "--skip-bundle " \

data/lib/gemsmith/generators/rake.rb

@@ -19,7 +19,7 @@ module Gemsmith
       end
 
       def run
-        cli.template "%gem_name%/Rakefile.tt", configuration
+        template "%gem_name%/Rakefile.tt"
         append_code_quality_task
         append_default_task
       end

data/lib/gemsmith/generators/reek.rb

@@ -9,7 +9,7 @@ module Gemsmith
 
         cli.uncomment_lines "#{gem_name}/Rakefile", /require.+reek.+/
         cli.uncomment_lines "#{gem_name}/Rakefile", /Reek.+/
-        cli.template "%gem_name%/.reek.tt", configuration
+        template "%gem_name%/.reek.tt"
       end
     end
   end

data/lib/gemsmith/generators/rspec.rb

@@ -23,14 +23,14 @@ module Gemsmith
       end
 
       def install_templates
-        cli.template "#{rspec_root}/spec_helper.rb.tt", configuration
+        template "#{rspec_root}/spec_helper.rb.tt"
         install_rails_helper
-        cli.template "#{rspec_root}/support/shared_contexts/temp_dir.rb.tt", configuration
+        template "#{rspec_root}/support/shared_contexts/temp_dir.rb.tt"
       end
 
       def install_rails_helper
-        return unless configuration.dig(:generate, :rails)
-        cli.template("#{rspec_root}/rails_helper.rb.tt", configuration)
+        return unless configuration.dig(:generate, :engine) || configuration.dig(:generate, :rails)
+        template "#{rspec_root}/rails_helper.rb.tt"
       end
     end
   end

data/lib/gemsmith/generators/rubocop.rb

@@ -9,7 +9,7 @@ module Gemsmith
 
         cli.uncomment_lines "#{gem_name}/Rakefile", /require.+rubocop.+/
         cli.uncomment_lines "#{gem_name}/Rakefile", /RuboCop.+/
-        cli.template "%gem_name%/.rubocop.yml.tt", configuration
+        template "%gem_name%/.rubocop.yml.tt"
         cli.run "bundle exec rubocop --auto-correct #{gem_name} > /dev/null"
       end
     end

data/lib/gemsmith/generators/ruby.rb

@@ -5,7 +5,7 @@ module Gemsmith
     # Generates Ruby support.
     class Ruby < Base
       def run
-        cli.template "%gem_name%/.ruby-version.tt", configuration
+        template "%gem_name%/.ruby-version.tt"
       end
     end
   end

data/lib/gemsmith/identity.rb

@@ -12,7 +12,7 @@ module Gemsmith
     end
 
     def self.version
-      "11.2.0"
+      "11.3.0"
     end
 
     def self.version_label

data/lib/gemsmith/templates/%gem_name%/%gem_name%.gemspec.tt

@@ -1,4 +1,4 @@
-$LOAD_PATH.append File.expand_path("../lib", __FILE__)
+$LOAD_PATH.append File.expand_path("lib", __dir__)
 require "<%= config.dig(:gem, :path) %>/identity"
 
 Gem::Specification.new do |spec|
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   <%- end -%>
 
   spec.required_ruby_version = "~> <%= config.dig(:versions, :ruby)[/\d+\.\d+/] %>"
-  <%- if config.dig(:generate, :rails) -%>
+  <%- if config.dig(:generate, :engine) || config.dig(:generate, :rails) -%>
   spec.add_dependency "rails", "~> <%= config.dig(:versions, :rails) %>"
   <%- end -%>
   <%- if config.dig(:generate, :cli) -%>
@@ -43,16 +43,16 @@ Gem::Specification.new do |spec|
   <%- end -%>
   spec.add_development_dependency "rake", "~> 12.3"
   <%- if config.dig(:generate, :reek) -%>
-  spec.add_development_dependency "reek", "~> 4.7"
+  spec.add_development_dependency "reek", "~> 4.8"
   <%- end -%>
   <%- if config.dig(:generate, :rspec) -%>
-  spec.add_development_dependency "<%= config.dig(:generate, :rails) ? "rspec-rails" : "rspec" %>", "~> 3.7"
+  spec.add_development_dependency "<%= config.dig(:generate, :engine) || config.dig(:generate, :rails) ? "rspec-rails" : "rspec" %>", "~> 3.7"
   <%- end -%>
   <%- if config.dig(:generate, :rubocop) -%>
-  spec.add_development_dependency "rubocop", "~> 0.52"
+  spec.add_development_dependency "rubocop", "~> 0.53"
   <%- end -%>
 
-  <%- if config.dig(:generate, :rails) -%>
+  <%- if config.dig(:generate, :engine) || config.dig(:generate, :rails) -%>
   spec.files = Dir["app/**/*", "bin/**/*", "config/**/*", "lib/**/*", "vendor/**/*"]
   <%- else -%>
   spec.files = Dir["lib/**/*"]

data/lib/gemsmith/templates/%gem_name%/.rubocop.yml.tt

@@ -1,5 +1,5 @@
 inherit_from:
-  - https://raw.githubusercontent.com/bkuhlmann/code_quality/v2.0.0/configurations/rubocop/ruby.yml
-<%- if config.dig(:generate, :rails) -%>
-  - https://raw.githubusercontent.com/bkuhlmann/code_quality/v2.0.0/configurations/rubocop/rails.yml
+  - https://raw.githubusercontent.com/bkuhlmann/code_quality/v2.1.0/configurations/rubocop/ruby.yml
+<%- if config.dig(:generate, :engine) || config.dig(:generate, :rails) -%>
+  - https://raw.githubusercontent.com/bkuhlmann/code_quality/v2.1.0/configurations/rubocop/rails.yml
 <%- end -%>

data/lib/gemsmith/templates/%gem_name%/Guardfile.tt

@@ -2,7 +2,7 @@ guard :rspec, cmd: "bundle exec rspec --format documentation" do
   watch(%r(^spec/.+_spec\.rb$))
   watch(%r(^lib/(.+)\.rb$)) { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch("spec/spec_helper.rb") { "spec" }
-  <%- if config.dig(:generate, :rails) -%>
+  <%- if config.dig(:generate, :engine) || config.dig(:generate, :rails) -%>
 
   # Rails
   watch(%r(^app/(.+)\.rb$)) { |m| "spec/#{m[1]}_spec.rb" }

data/lib/gemsmith/templates/%gem_name%/README.md.tt

@@ -20,8 +20,8 @@
 ## Requirements
 
 0. [Ruby <%= config.dig(:versions, :ruby) %>](https://www.ruby-lang.org)
-<%- if config.dig(:generate, :rails) -%>
-0. [Ruby on Rails](http://rubyonrails.org).
+<%- if config.dig(:generate, :engine) || config.dig(:generate, :rails) -%>
+0. [Ruby on Rails](http://rubyonrails.org)
 <%- end -%>
 
 ## Setup

data/lib/gemsmith/templates/%gem_name%/lib/%gem_path%.rb.tt

@@ -2,6 +2,6 @@ require "<%= config.dig(:gem, :path) %>/identity"
 <%- if config.dig(:generate, :cli) -%>
 require "<%= config.dig(:gem, :path) %>/cli"
 <%- end -%>
-<%- if config.dig(:generate, :rails) -%>
+<%- if config.dig(:generate, :engine) || config.dig(:generate, :rails) -%>
 require "<%= config.dig(:gem, :path) %>/engine"
 <%- end -%>

data/lib/gemsmith/templates/%gem_name%/spec/spec_helper.rb.tt

@@ -8,7 +8,7 @@ SimpleCov.start
 require "pry"
 require "pry-byebug"
 <%- end -%>
-<%- unless config.dig(:generate, :rails) -%>
+<%- unless config.dig(:generate, :engine) || config.dig(:generate, :rails) -%>
 require "<%= config.dig(:gem, :path) %>"
 <%- end -%>
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemsmith
 version: !ruby/object:Gem::Version
-  version: 11.2.0
+  version: 11.3.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -29,7 +29,7 @@ cert_chain:
   4Zrsxi713z6sndd9JBAm4G7mJiV93MsuCM5N4ZDY7XaxIhvctNSNhX/Yn8LLdtGI
   b4jw5t40FKyNUvLPPXYAvQALBtk=
   -----END CERTIFICATE-----
-date: 2018-03-04 00:00:00.000000000 Z
+date: 2018-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,14 +93,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '0.53'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '0.53'
 - !ruby/object:Gem::Dependency
   name: runcom
   requirement: !ruby/object:Gem::Requirement
@@ -317,14 +317,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
+        version: '4.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
+        version: '4.8'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement