gemsmith 7.7.0 → 8.0.0

data/lib/gemsmith/template_helper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Gemsmith
+  # Provides helper methods for use by the Thor CLI. These methods are necessary to resolve %% file
+  # and folder variables and render dynamic content within the Thor ERB *templates* structure.
+  module TemplateHelper
+    def gem_name
+      configuration.dig :gem, :name
+    end
+
+    def gem_path
+      configuration.dig :gem, :path
+    end
+
+    def gem_class
+      configuration.dig :gem, :class
+    end
+
+    def rails_version
+      configuration.dig :versions, :rails
+    end
+
+    def render_namespace &block
+      body = capture(&block) if block_given?
+      concat Gem::ModuleFormatter.new(gem_class).render(body)
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 $LOAD_PATH.push File.expand_path("../lib", __FILE__)
-require "<%= config.dig(:gem, :name) %>/identity"
+require "<%= config.dig(:gem, :path) %>/identity"
 
 Gem::Specification.new do |spec|
   spec.name = <%= config.dig(:gem, :class) %>::Identity.name
@@ -7,52 +7,54 @@ Gem::Specification.new do |spec|
   spec.platform = <%= config.dig(:gem, :platform) %>
   spec.authors = ["<%= config.dig(:author, :name) %>"]
   spec.email = ["<%= config.dig(:author, :email) %>"]
-  spec.homepage = "<%= config.dig(:gem, :home_url) %>"
+  spec.homepage = "<%= config.dig(:gem, :url) %>"
   spec.summary = ""
-  spec.description = ""
   spec.license = "MIT"
 
-  <%- if config.dig(:create, :security) -%>
-  if ENV["RUBY_GEM_SECURITY"] == "enabled"
-    spec.signing_key = File.expand_path("<%= config.dig(:gem, :private_key) %>")
-    spec.cert_chain = [File.expand_path("<%= config.dig(:gem, :public_key) %>")]
+  <%- if config.dig(:generate, :security) -%>
+  if File.exist?(Gem.default_key_path) && File.exist?(Gem.default_cert_path)
+    spec.signing_key = Gem.default_key_path
+    spec.cert_chain = [Gem.default_cert_path]
   end
   <%- end -%>
 
-  <%- if config.dig(:create, :cli) -%>
+  <%- if config.dig(:generate, :cli) -%>
   spec.add_dependency "thor", "~> 0.19"
-  spec.add_dependency "thor_plus", "~> 3.1"
+  spec.add_dependency "thor_plus", "~> 4.0"
+  spec.add_dependency "runcom", "~> 0.2"
   <%- end -%>
-  <%- if config.dig(:create, :rails) -%>
+  <%- if config.dig(:generate, :rails) -%>
   spec.add_dependency "rails", "~> <%= config.dig(:versions, :rails) %>"
   <%- end -%>
-  spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 11.0"
   spec.add_development_dependency "gemsmith", "~> <%= Gemsmith::Identity.version[/\d{1}\.\d{1}/] %>"
-  <%- if config.dig(:create, :pry) -%>
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "pry-byebug"
-  spec.add_development_dependency "pry-state"
+  <%- if config.dig(:generate, :pry) -%>
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "pry-byebug", "~> 3.4"
+  spec.add_development_dependency "pry-state", "~> 0.1"
   <%- end -%>
-  <%- if config.dig(:create, :rspec) -%>
-  spec.add_development_dependency "<%= config.dig(:create, :rails) ? "rspec-rails" : "rspec" %>", "~> 3.4"
+  <%- if config.dig(:generate, :rspec) -%>
+  spec.add_development_dependency "<%= config.dig(:generate, :rails) ? "rspec-rails" : "rspec" %>", "~> 3.5"
   <%- end -%>
-  <%- if config.dig(:create, :guard) -%>
-  spec.add_development_dependency "rb-fsevent" # Guard file events for OSX.
-  spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency "terminal-notifier"
-  spec.add_development_dependency "terminal-notifier-guard"
+  <%- if config.dig(:generate, :guard) -%>
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
   <%- end -%>
-  <%- if config.dig(:create, :rubocop) -%>
-  spec.add_development_dependency "rubocop", "~> 0.40"
+  <%- if config.dig(:generate, :reek) -%>
+  spec.add_development_dependency "reek", "~> 4.5"
   <%- end -%>
-  <%- if config.dig(:create, :code_climate) -%>
-  spec.add_development_dependency "codeclimate-test-reporter"
+  <%- if config.dig(:generate, :rubocop) -%>
+  spec.add_development_dependency "rubocop", "~> 0.45"
+  <%- end -%>
+  <%- if config.dig(:generate, :scss_lint) -%>
+  spec.add_development_dependency "scss_lint", "~> 0.50"
+  <%- end -%>
+  <%- if config.dig(:generate, :code_climate) -%>
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0"
   <%- end -%>
 
-  spec.files = Dir["lib/**/*", "vendor/**/*"]
+  spec.files = Dir["lib/**/*"]
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
-  <%- if config.dig(:create, :cli) -%>
+  <%- if config.dig(:generate, :cli) -%>
   spec.executables << "<%= config.dig(:gem, :name) %>"
   <%- end -%>
   spec.require_paths = ["lib"]

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

@@ -0,0 +1,36 @@
+---
+engines:
+  shellcheck:
+    enabled: true
+  bundler-audit:
+    enabled: true
+  reek:
+    enabled: <%= config.dig :generate, :reek %>
+  rubocop:
+    enabled: <%= config.dig :generate, :rubocop %>
+  scss-lint:
+    enabled: <%= config.dig :generate, :scss_lint %>
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+      - javascript
+  fixme:
+    enabled: true
+    config:
+      strings:
+        - TODO
+        - FIX
+        - DUPLICATE
+ratings:
+  paths:
+  - "app/**/*"
+  - "bin/**/*"
+  - "lib/**/*"
+  - "**.rb"
+  - "**.js"
+exclude_paths:
+- "spec/**/*"
+- "vendor/**/*"
+- ".codeclimate.yml"

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

@@ -1,4 +1,4 @@
-<%- if config.dig(:create, :rails) -%>
+<%- if config.dig(:generate, :rails) -%>
 AllCops:
   Exclude:
     - "spec/dummy/**/*"
@@ -22,6 +22,8 @@ Style/PercentLiteralDelimiters:
     "%i": "[]"
     "%I": "[]"
     "%r": "()"
+Style/SafeNavigation:
+  Enabled: false
 Style/SignalException:
   EnforcedStyle: semantic
 Style/SingleLineBlockParams:
@@ -32,5 +34,11 @@ Style/StringLiterals:
   EnforcedStyle: double_quotes
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
+Style/VariableNumber:
+  EnforcedStyle: snake_case
+Metrics/BlockLength:
+  Exclude:
+    - "**/*.gemspec"
+    - "spec/**/*"
 Metrics/LineLength:
   Max: 120

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

@@ -1,10 +1,13 @@
 language: ruby
 rvm:
   - <%= config.dig(:versions, :ruby) %>
-<%- if config.dig(:create, :rails) -%>
+<%- if config.dig(:generate, :rails) -%>
 gemfile:
   - gemfiles/rails-<%= config.dig(:versions, :rails) %>.x.gemfile
 <%- end -%>
 script: bundle exec rake
+<%- if config.dig(:generate, :code_climate) -%>
+after_script: bundle exec codeclimate-test-reporter
+<%- end -%>
 notifications:
   email: false

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

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

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

@@ -1,17 +1,17 @@
 # <%= config.dig(:gem, :class) %>
 
 [![Gem Version](https://badge.fury.io/rb/<%= config.dig(:gem, :name) %>.svg)](http://badge.fury.io/rb/<%= config.dig(:gem, :name) %>)
-<%- if config.dig(:create, :code_climate) -%>
+<%- if config.dig(:generate, :code_climate) -%>
 [![Code Climate GPA](https://codeclimate.com/github/<%= config.fetch :github_user %>/<%= config.dig(:gem, :name) %>.svg)](https://codeclimate.com/github/<%= config.fetch :github_user %>/<%= config.dig(:gem, :name) %>)
 [![Code Climate Coverage](https://codeclimate.com/github/<%= config.fetch :github_user %>/<%= config.dig(:gem, :name) %>/coverage.svg)](https://codeclimate.com/github/<%= config.fetch :github_user %>/<%= config.dig(:gem, :name) %>)
 <%- end -%>
-<%- if config.dig(:create, :gemnasium) -%>
+<%- if config.dig(:generate, :gemnasium) -%>
 [![Gemnasium Status](https://gemnasium.com/<%= config.fetch :github_user %>/<%= config.dig(:gem, :name) %>.svg)](https://gemnasium.com/<%= config.fetch :github_user %>/<%= config.dig(:gem, :name) %>)
 <%- end -%>
-<%- if config.dig(:create, :travis) -%>
+<%- if config.dig(:generate, :travis) -%>
 [![Travis CI Status](https://secure.travis-ci.org/<%= config.fetch :github_user %>/<%= config.dig(:gem, :name) %>.svg)](https://travis-ci.org/<%= config.fetch :github_user %>/<%= config.dig(:gem, :name) %>)
 <%- end -%>
-<%- if config.dig(:create, :patreon) -%>
+<%- if config.dig(:generate, :patreon) -%>
 [![Patreon](https://img.shields.io/badge/patreon-donate-brightgreen.svg)](https://www.patreon.com/<%= config.fetch :github_user %>)
 <%- end -%>
 
@@ -24,21 +24,22 @@
 
 # Requirements
 
-0. [MRI <%= config.dig(:versions, :ruby) %>](https://www.ruby-lang.org)
-<%- if config.dig(:create, :rails) -%>
+0. [Ruby <%= config.dig(:versions, :ruby) %>](https://www.ruby-lang.org)
+<%- if config.dig(:generate, :rails) -%>
 0. [Ruby on Rails](http://rubyonrails.org).
 <%- end -%>
 
 # Setup
 
-<%- if config.dig(:create, :security) -%>
+<%- if config.dig(:generate, :security) -%>
 For a secure install, type the following (recommended):
 
     gem cert --add <(curl --location --silent <%= config.dig :organization, :url %>/gem-public.pem)
     gem install <%= config.dig(:gem, :name) %> --trust-policy MediumSecurity
 
-NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification while
-allowing the installation of unsigned dependencies since they are beyond the scope of this gem.
+NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification
+while allowing the installation of unsigned dependencies since they are beyond the scope of this
+gem.
 
 For an insecure install, type the following (not recommended):
 
@@ -49,7 +50,7 @@ To install, type the following:
     gem install <%= config.dig(:gem, :name) %>
 <%- end -%>
 
-<%- unless config.dig(:create, :cli) -%>
+<%- unless config.dig(:generate, :cli) -%>
 Add the following to your Gemfile:
 
     gem "<%= config.dig(:gem, :name) %>"
@@ -57,7 +58,7 @@ Add the following to your Gemfile:
 
 # Usage
 
-<%- if config.dig(:create, :rspec) -%>
+<%- if config.dig(:generate, :rspec) -%>
 # Tests
 
 To test, run:
@@ -69,14 +70,14 @@ To test, run:
 
 Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
 
-- Patch (x.y.Z) - Incremented for small, backwards compatible bug fixes.
-- Minor (x.Y.z) - Incremented for new, backwards compatible public API enhancements and/or bug fixes.
+- Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
 - Major (X.y.z) - Incremented for any backwards incompatible public API changes.
 
 # Code of Conduct
 
-Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By participating in this project
-you agree to abide by its terms.
+Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By
+participating in this project you agree to abide by its terms.
 
 # Contributions
 
@@ -85,13 +86,14 @@ Read [CONTRIBUTING](CONTRIBUTING.md) for details.
 # License
 
 Copyright (c) <%= config.fetch :year %> [<%= config.dig :organization, :name %>](<%= config.dig :organization, :url %>).
-Read the [LICENSE](LICENSE.md) for details.
+Read [LICENSE](LICENSE.md) for details.
 
 # History
 
-Read the [CHANGELOG](CHANGELOG.md) for details.
+Read [CHANGES](CHANGES.md) for details.
 Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
 
 # Credits
 
-Developed by [<%= config.dig(:author, :name) %>](<%= config.dig :author, :url %>) at [<%= config.dig :organization, :name %>](<%= config.dig :organization, :url %>).
+Developed by [<%= config.dig(:author, :name) %>](<%= config.dig :author, :url %>) at
+[<%= config.dig :organization, :name %>](<%= config.dig :organization, :url %>).

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

@@ -1,2 +1,7 @@
-require "gemsmith/rake/setup"
+begin
+  require "gemsmith/rake/setup"
+rescue LoadError => error
+  puts error.message
+end
+
 Dir.glob("lib/tasks/*.rake").each { |file| load file }

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

@@ -1,8 +1,8 @@
-#! /usr/bin/ruby
+#! /usr/bin/env ruby
 
-require "<%= config.dig(:gem, :name) %>"
-require "<%= config.dig(:gem, :name) %>/cli"
-require "<%= config.dig(:gem, :name) %>/identity"
+require "<%= config.dig(:gem, :path) %>"
+require "<%= config.dig(:gem, :path) %>/cli"
+require "<%= config.dig(:gem, :path) %>/identity"
 
 Process.setproctitle <%= config.dig(:gem, :class) %>::Identity.version_label
 <%= config.dig(:gem, :class) %>::CLI.start

data/lib/gemsmith/templates/%gem_name%/bin/setup.tt

@@ -1,4 +1,4 @@
-#! /bin/bash
+#! /usr/bin/env bash
 
 set -o nounset # Exit, with error message, when attempting to use an undefined variable.
 set -o errexit # Abort script at first error, when a command exits with non-zero status.

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

@@ -0,0 +1,4 @@
+require "<%= config.dig(:gem, :path) %>/identity"
+<%- if config.dig(:generate, :rails) -%>
+require "<%= config.dig(:gem, :path) %>/engine"
+<%- end -%>

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

@@ -0,0 +1,54 @@
+require "yaml"
+require "thor"
+require "thor/actions"
+require "thor_plus/actions"
+require "runcom"
+
+<% render_namespace do %>
+  # The Command Line Interface (CLI) for the gem.
+  class CLI < Thor
+    include Thor::Actions
+    include ThorPlus::Actions
+
+    package_name <%= config.dig(:gem, :class) %>::Identity.version_label
+
+    def self.configuration
+      Runcom::Configuration.new file_name: Identity.file_name
+    end
+
+    def initialize args = [], options = {}, config = {}
+      super args, options, config
+    end
+
+    desc "-c, [--config]", %(Manage gem configuration ("#{configuration.computed_path}").)
+    map %w[-c --config] => :config
+    method_option :edit,
+                  aliases: "-e",
+                  desc: "Edit gem configuration.",
+                  type: :boolean, default: false
+    method_option :info,
+                  aliases: "-i",
+                  desc: "Print gem configuration.",
+                  type: :boolean, default: false
+    def config
+      path = self.class.configuration.computed_path
+
+      if options.edit? then `#{editor} #{path}`
+      elsif options.info? then say(path)
+      else help(:config)
+      end
+    end
+
+    desc "-v, [--version]", "Show gem version."
+    map %w[-v --version] => :version
+    def version
+      say <%= config.dig(:gem, :class) %>::Identity.version_label
+    end
+
+    desc "-h, [--help=COMMAND]", "Show this message or get help for a command."
+    map %w[-h --help] => :help
+    def help task = nil
+      say and super
+    end
+  end
+<% end %>

data/lib/gemsmith/templates/%gem_name%/lib/{%gem_name% → %gem_path%}/engine.rb.tt

@@ -1,8 +1,6 @@
-# frozen_string_literal: true
-
-module <%= config.dig(:gem, :class) %>
+<% render_namespace do %>
   # Defines and registers the Rails engine.
   class Engine < ::Rails::Engine
     isolate_namespace <%= config.dig(:gem, :class) %>
   end
-end
+<% end %>

data/lib/gemsmith/templates/%gem_name%/lib/{%gem_name% → %gem_path%}/identity.rb.tt

@@ -1,6 +1,4 @@
-# frozen_string_literal: true
-
-module <%= config.dig(:gem, :class) %>
+<% render_namespace do %>
   # Gem identity information.
   module Identity
     def self.name
@@ -18,11 +16,11 @@ module <%= config.dig(:gem, :class) %>
     def self.version_label
       "#{label} #{version}"
     end
-    <%- if config.dig(:create, :cli) -%>
+    <%- if config.dig(:generate, :cli) -%>
 
     def self.file_name
       ".#{name}rc"
     end
     <%- end -%>
   end
-end
+<% end %>

data/lib/gemsmith/templates/%gem_name%/lib/generators/{%gem_name% → %gem_path%}/install/install_generator.rb.tt

@@ -1,13 +1,10 @@
-# frozen_string_literal: true
-
-module <%= config.dig(:gem, :class) %>
+<% render_namespace do %>
   # Generator for installing new files.
   class InstallGenerator < Rails::Generators::Base
     source_root File.join(File.dirname(__FILE__), "..", "templates")
 
     desc "Installs additional <%= config.dig(:gem, :class) %> resources."
     def install
-      # TODO: Add install code.
     end
   end
-end
+<% end %>