gemsmith 11.3.0 → 12.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 239c568371d501376dcff5619e20b4cd8946690316580a534b9eb4e7f7207f83
-  data.tar.gz: 04f1a037a219e2e95f2d04167488f2e8bbba179ec5f762cd857d99bca136ff7b
+  metadata.gz: 78f0cee5081369bd81427a2265d1b07d32cd0cf94431149dcc217d15ea438db6
+  data.tar.gz: 8f0ec1968496a1343cb1c2ccde99e49883ee005a59cc5847b7674e5568e60e79
 SHA512:
-  metadata.gz: 0ad48caf292a01a67602e4b93c541a5511fc6014139605938a81f3801ac3f46eb66c7e0f999481cf13e39479ffe620c19137056e38e6700ad5e22b950fd84220
-  data.tar.gz: ddfd1d4c260cd1335f3574b4eabd270b8f41ec8d2ce1f8d5f5b2ac2e1ffdff0cecbc9085d0d967bbdcfc6697daabbf57c705b92ff764fcd3b57128db60b85030
+  metadata.gz: 5f3ceb6eed7c7cde98a56f2fb32083c9cbcf030bc8c615bdb4ddf889ead48b16fb25e19b8c054c5b19a5c9070cf5450e068c5c2f5f831c218eafcbaed83edc41
+  data.tar.gz: 0c9c23e5672ce8bb81843a1f7f292966eabfde058ae3289179a81da7c5d09337a8dbac01c8fb9083d0586e6749f4412d86f16188c08b7527a9acb4dad747a1e4

data/README.md

@@ -132,7 +132,6 @@ The default configuration is as follows:
       :git_hub: true
       :guard: true
       :pry: true
-      :rails: false
       :reek: true
       :rspec: true
       :rubocop: true
@@ -195,7 +194,6 @@ For more gem generation options, type: `gemsmith --help --generate`
                                              # Default: true
     [--pry], [--no-pry]                      # Add Pry support.
                                              # Default: true
-    [--rails], [--no-rails]                  # DEPRECATED (Use --engine instead). Add Rails support.
     [--reek], [--no-reek]                    # Add Reek support.
                                              # Default: true
     [--rspec], [--no-rspec]                  # Add RSpec support.
@@ -213,14 +211,14 @@ Once a gem skeleton has been created, the following tasks are available (i.e. `b
     rake bundle:audit          # Updates the ruby-advisory-db then runs bundle-audit
     rake clean                 # Clean gem artifacts
     rake code_quality          # Run code quality checks
-    rake doc                   # Update README (table of contents)
     rake git_cop               # Run Git Cop
     rake install               # Install example-0.1.0.gem package
-    rake publish               # Build, tag as v0.1.0 (unsigned), and push example-0.1.0.gem to RubyGems
+    rake publish               # Build, tag as 0.1.0 (unsigned), and push example-0.1.0.gem to RubyGems
     rake reek                  # Check for code smells
     rake rubocop               # Run RuboCop
     rake rubocop:auto_correct  # Auto-correct RuboCop offenses
     rake spec                  # Run RSpec code examples
+    rake toc                   # Update Table of Contents (README)
 
 *NOTE: Some tasks might differ depending on what options you enabled/disabled during gem
 generation.*

data/lib/gemsmith.rb

@@ -24,7 +24,7 @@ require "gemsmith/generators/git_cop"
 require "gemsmith/generators/git_hub"
 require "gemsmith/generators/guard"
 require "gemsmith/generators/pragma"
-require "gemsmith/generators/rails"
+require "gemsmith/generators/engine"
 require "gemsmith/generators/rake"
 require "gemsmith/generators/reek"
 require "gemsmith/generators/rspec"

data/lib/gemsmith/cli.rb

@@ -28,7 +28,7 @@ module Gemsmith
 
     # rubocop:disable Metrics/MethodLength
     def self.configuration
-      Runcom::Configuration.new project_name: Identity.name, defaults: {
+      Runcom::Configuration.new Identity.name, defaults: {
         year: Time.now.year,
         github_user: Git.github_user,
         gem: {
@@ -62,7 +62,6 @@ module Gemsmith
           git_hub: true,
           guard: true,
           pry: true,
-          rails: false,
           engine: false,
           reek: true,
           rspec: true,
@@ -84,7 +83,7 @@ module Gemsmith
         Generators::Rake,
         Generators::CLI,
         Generators::Ruby,
-        Generators::Rails,
+        Generators::Engine,
         Generators::Rspec,
         Generators::BundlerAudit,
         Generators::GitCop,
@@ -147,10 +146,6 @@ module Gemsmith
                   desc: "Add Pry support.",
                   type: :boolean,
                   default: configuration.to_h.dig(:generate, :pry)
-    method_option :rails,
-                  desc: "DEPRECATED (Use --engine instead). Add Rails support.",
-                  type: :boolean,
-                  default: configuration.to_h.dig(:generate, :rails)
     method_option :reek,
                   desc: "Add Reek support.",
                   type: :boolean,
@@ -170,11 +165,7 @@ module Gemsmith
     # rubocop:disable Metrics/AbcSize
     # :reek:TooManyStatements
     def generate name
-      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?
-      )
+      print_cli_and_rails_engine_option_error && return if options.cli? && options.engine?
 
       say_status :info, "Generating gem...", :green
 

data/lib/gemsmith/gem/specification.rb

@@ -22,6 +22,8 @@ module Gemsmith
         specification.find_all_by_name name, requirement
       end
 
+      attr_reader :version
+
       def initialize file_path
         @file_path = file_path
         @spec = self.class.specification.load file_path
@@ -49,16 +51,8 @@ module Gemsmith
         spec.metadata.fetch("allowed_push_host") { self.class.default_gem_host }
       end
 
-      def version_number
-        version.to_s
-      end
-
-      def version_label
-        version.label
-      end
-
       def package_file_name
-        "#{name}-#{version_number}.gem"
+        "#{name}-#{version}.gem"
       end
 
       def package_path
@@ -67,7 +61,7 @@ module Gemsmith
 
       private
 
-      attr_reader :file_path, :spec, :version
+      attr_reader :file_path, :spec
 
       def validate
         return if spec.is_a?(self.class.specification)

data/lib/gemsmith/generators/base.rb

@@ -5,6 +5,7 @@ module Gemsmith
     # Abstract class from which all generators inherit from.
     class Base
       LIB_ROOT = File.join("%gem_name%", "lib").freeze
+      LIB_ROOT_GEM = File.join(LIB_ROOT, "%gem_path%").freeze
 
       def initialize cli, configuration: {}
         @cli = cli
@@ -23,11 +24,6 @@ module Gemsmith
 
       attr_reader :cli, :configuration
 
-      # :reek:UtilityFunction
-      def lib_gem_root
-        File.join LIB_ROOT, "%gem_path%"
-      end
-
       def gem_name
         configuration.dig :gem, :name
       end

data/lib/gemsmith/generators/{rails.rb → engine.rb}

@@ -3,7 +3,7 @@
 module Gemsmith
   module Generators
     # Generates Ruby on Rails Engine support.
-    class Rails < Base
+    class Engine < Base
       def rails?
         cli.run "command -v rails > /dev/null"
       end
@@ -55,7 +55,7 @@ module Gemsmith
       private
 
       def runnable?
-        configuration.dig(:generate, :engine) || configuration.dig(:generate, :rails)
+        configuration.dig :generate, :engine
       end
 
       def engine_options

data/lib/gemsmith/generators/gem.rb

@@ -15,8 +15,8 @@ module Gemsmith
         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"
+        template "#{LIB_ROOT_GEM}.rb.tt"
+        template "#{LIB_ROOT_GEM}/identity.rb.tt"
       end
     end
   end

data/lib/gemsmith/generators/rspec.rb

@@ -29,7 +29,7 @@ module Gemsmith
       end
 
       def install_rails_helper
-        return unless configuration.dig(:generate, :engine) || configuration.dig(:generate, :rails)
+        return unless configuration.dig(:generate, :engine)
         template "#{rspec_root}/rails_helper.rb.tt"
       end
     end

data/lib/gemsmith/identity.rb

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

data/lib/gemsmith/rake/builder.rb

@@ -14,10 +14,10 @@ module Gemsmith
         @kernel = kernel
       end
 
-      def doc
+      def toc
         readme = File.join Dir.pwd, "README.md"
         tocer.new(readme).write
-        shell.confirm "Updated gem documentation."
+        shell.confirm "Updated gem table of contents."
       end
 
       def clean
@@ -44,7 +44,7 @@ module Gemsmith
       end
 
       def install gem_spec
-        gem_name = "#{gem_spec.name} #{gem_spec.version_number}"
+        gem_name = "#{gem_spec.name} #{gem_spec.version}"
 
         if kernel.system("gem install #{gem_spec.package_path}")
           shell.confirm "Installed: #{gem_name}."

data/lib/gemsmith/rake/publisher.rb

@@ -45,7 +45,7 @@ module Gemsmith
       # rubocop:enable Metrics/AbcSize
 
       def publish
-        publisher.publish gem_spec.version_number, sign: signed?
+        publisher.publish gem_spec.version, sign: signed?
         push
       rescue Milestoner::Errors::Base => error
         shell.error error.message

data/lib/gemsmith/rake/tasks.rb

@@ -33,9 +33,9 @@ module Gemsmith
       # rubocop:disable Metrics/MethodLength
       # :reek:TooManyStatements
       def install
-        desc "Update README (table of contents)"
-        task :doc do
-          builder.doc
+        desc "Update Table of Contents (README)"
+        task :toc do
+          builder.toc
         end
 
         desc "Clean gem artifacts"
@@ -48,7 +48,7 @@ module Gemsmith
         end
 
         desc "Build #{gem_package} package"
-        task build: %i[clean doc validate] do
+        task build: %i[clean toc validate] do
           builder.build gem_spec
         end
 
@@ -57,7 +57,7 @@ module Gemsmith
           builder.install gem_spec
         end
 
-        desc "Build, tag as #{gem_spec.version_label} (#{signed_label}), " \
+        desc "Build, tag as #{gem_spec.version} (#{signed_label}), " \
              "and push #{gem_package} to RubyGems"
         task publish: :build do
           publisher.publish

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

@@ -11,17 +11,23 @@ Gem::Specification.new do |spec|
   spec.summary = ""
   spec.license = "MIT"
 
+  spec.metadata = {
+    "source_code_uri" => "<%= config.dig(:gem, :url) %>",
+    "changelog_uri" => "<%= config.dig(:gem, :url) %>/blob/master/CHANGES.md",
+    "bug_tracker_uri" => "<%= config.dig(:gem, :url) %>/issues"
+  }
+
   <%- if config.dig(:generate, :security) -%>
   spec.signing_key = Gem.default_key_path
   spec.cert_chain = [Gem.default_cert_path]
   <%- end -%>
 
   spec.required_ruby_version = "~> <%= config.dig(:versions, :ruby)[/\d+\.\d+/] %>"
-  <%- if config.dig(:generate, :engine) || config.dig(:generate, :rails) -%>
+  <%- if config.dig(:generate, :engine) -%>
   spec.add_dependency "rails", "~> <%= config.dig(:versions, :rails) %>"
   <%- end -%>
   <%- if config.dig(:generate, :cli) -%>
-  spec.add_dependency "runcom", "~> 2.0"
+  spec.add_dependency "runcom", "~> 3.0"
   spec.add_dependency "thor", "~> 0.20"
   <%- end -%>
   <%- if config.dig(:generate, :bundler_audit) -%>
@@ -32,7 +38,7 @@ Gem::Specification.new do |spec|
   <%- end -%>
   spec.add_development_dependency "gemsmith", "~> <%= Gemsmith::Identity.version[/\d+\.\d+/] %>"
   <%- if config.dig(:generate, :git_cop) -%>
-  spec.add_development_dependency "git-cop", "~> 2.0"
+  spec.add_development_dependency "git-cop", "~> 2.2"
   <%- end -%>
   <%- if config.dig(:generate, :guard) -%>
   spec.add_development_dependency "guard-rspec", "~> 4.7"
@@ -46,13 +52,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "reek", "~> 4.8"
   <%- end -%>
   <%- if config.dig(:generate, :rspec) -%>
-  spec.add_development_dependency "<%= config.dig(:generate, :engine) || config.dig(:generate, :rails) ? "rspec-rails" : "rspec" %>", "~> 3.7"
+  spec.add_development_dependency "<%= config.dig(:generate, :engine) ? "rspec-rails" : "rspec" %>", "~> 3.7"
   <%- end -%>
   <%- if config.dig(:generate, :rubocop) -%>
-  spec.add_development_dependency "rubocop", "~> 0.53"
+  spec.add_development_dependency "rubocop", "~> 0.54"
   <%- end -%>
 
-  <%- if config.dig(:generate, :engine) || config.dig(:generate, :rails) -%>
+  <%- if config.dig(:generate, :engine) -%>
   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.1.0/configurations/rubocop/ruby.yml
-<%- if config.dig(:generate, :engine) || config.dig(:generate, :rails) -%>
+<%- if config.dig(:generate, :engine) -%>
   - 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, :engine) || config.dig(:generate, :rails) -%>
+  <%- if config.dig(:generate, :engine) -%>
 
   # Rails
   watch(%r(^app/(.+)\.rb$)) { |m| "spec/#{m[1]}_spec.rb" }

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

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

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

@@ -13,10 +13,6 @@ jobs:
     steps:
       - checkout
 
-      - type: cache-restore
-        name: Bundler Cache Restore
-        key: bundle-{{ checksum "Gemfile" }}
-
       - run:
           name: Bundler Install
           command: |
@@ -24,12 +20,6 @@ jobs:
             bundle check || bundle install
             gem install rails
 
-      - type: cache-save
-        name: Bundler Cache Store
-        key: bundle-{{ checksum "Gemfile" }}
-        paths:
-          - vendor/bundle
-
       - run:
           name: Rake Run
           command: bundle exec rake

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, :engine) || config.dig(:generate, :rails) -%>
+<%- if config.dig(:generate, :engine) -%>
 require "<%= config.dig(:gem, :path) %>/engine"
 <%- end -%>

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

@@ -10,7 +10,7 @@ require "runcom"
     package_name Identity.version_label
 
     def self.configuration
-      Runcom::Configuration.new project_name: Identity.name
+      Runcom::Configuration.new Identity.name
     end
 
     def initialize args = [], options = {}, config = {}

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, :engine) || config.dig(:generate, :rails) -%>
+<%- unless config.dig(:generate, :engine) -%>
 require "<%= config.dig(:gem, :path) %>"
 <%- end -%>
 

data/lib/gemsmith/templates/%gem_name%/spec/support/shared_contexts/temp_dir.rb.tt

@@ -1,5 +1,5 @@
 RSpec.shared_context "Temporary Directory", :temp_dir do
-  let(:temp_dir) { File.join Bundler.root, "tmp", "rspec" }
+  let(:temp_dir) { Bundler.root.join "tmp", "rspec" }
 
   around do |example|
     FileUtils.mkdir_p temp_dir

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemsmith
 version: !ruby/object:Gem::Version
-  version: 11.3.0
+  version: 12.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -29,7 +29,7 @@ cert_chain:
   4Zrsxi713z6sndd9JBAm4G7mJiV93MsuCM5N4ZDY7XaxIhvctNSNhX/Yn8LLdtGI
   b4jw5t40FKyNUvLPPXYAvQALBtk=
   -----END CERTIFICATE-----
-date: 2018-03-10 00:00:00.000000000 Z
+date: 2018-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -51,70 +51,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: pragmater
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: refinements
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.53'
+        version: '0.54'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.53'
+        version: '0.54'
 - !ruby/object:Gem::Dependency
   name: runcom
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -135,28 +135,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: versionaire
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -233,14 +233,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -386,13 +386,13 @@ files:
 - lib/gemsmith/generators/cli.rb
 - lib/gemsmith/generators/code_climate.rb
 - lib/gemsmith/generators/documentation.rb
+- lib/gemsmith/generators/engine.rb
 - lib/gemsmith/generators/gem.rb
 - lib/gemsmith/generators/git.rb
 - lib/gemsmith/generators/git_cop.rb
 - lib/gemsmith/generators/git_hub.rb
 - lib/gemsmith/generators/guard.rb
 - lib/gemsmith/generators/pragma.rb
-- lib/gemsmith/generators/rails.rb
 - lib/gemsmith/generators/rake.rb
 - lib/gemsmith/generators/reek.rb
 - lib/gemsmith/generators/rspec.rb
@@ -440,7 +440,10 @@ files:
 homepage: https://github.com/bkuhlmann/gemsmith
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/bkuhlmann/gemsmith
+  changelog_uri: https://github.com/bkuhlmann/gemsmith/blob/master/CHANGES.md
+  bug_tracker_uri: https://github.com/bkuhlmann/gemsmith/issues
 post_install_message: 
 rdoc_options: []
 require_paths: