gemsmith 5.6.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8fae3eed50e6c041a0468c15d995f955f2a12e0
-  data.tar.gz: d7c8f707c174b7e5f3c80d40a007a56b3d651338
+  metadata.gz: 93a8b6f5bd33ee3d2ca49fd60ab5120a5ed16753
+  data.tar.gz: 02f7d1a50c6aca870805920c2a85994b7da63030
 SHA512:
-  metadata.gz: ec5db0c1fafa1130cb9edaeaacd570bd9f58c352cc0b10fb0a70300f561e8b2f881cede25541b69eb6b5d8325715577383a9dc39dfb9d8377a925927b8174fdc
-  data.tar.gz: 3d2f2b54e0b818b5a75229dafa41b0f08b5eda1301521d1c72266bed7c2336192d46305edb929f9d919f68e98939188addb8dc93643a075ae55533debf710e67
+  metadata.gz: 5c9fccafbe3aef91a6a794261f0f5a6213185784faf2128a5bceb1072af3bf8003c24b9a5a8ffd90457955e2187b8a347e17fbae040a052c286c0767a72837f3
+  data.tar.gz: 7830aa4aa2fd4b2d32f7bbb20d57caa607ad658aa142f423ee6a1d7e51bec3e1061ddb682e1a4a42e89785af2a628fea9ba75d3a00b40137948d3a22fe8e2fc1

data.tar.gz.sig

@@ -1,3 +1,4 @@
-:�Z"�b>�;@9��]��q�
-�)0���|πF@�mz��gM�uS�Uw4�t}ߕaIy�D�L@��-'z4k��r7�@@J� +�9�iΈ�X���g�x�t��0 �q�e���Zf� ª�}�
-^�sB��UmY�ށ,A�j9L;�+u�)��~Ry�I��+�B�Tc���"у��$��E���&���eW�DN=���"�z�na8�o����H,�`�k�p6�����.X��o�B�do'�i�
+P۝
+O�-�W�~~�����_��� ��y�7Z�-�j�p�a��tJ7_�-��#3���aT�A�
+H�-�9�a8lQK�X;���w���%��;,W����!}+c	0l��?1^f��7���~.9E�"���$�Nf��Mg�y^���Y�҉�
+���Ć��EI�Q˧~�� �*r/�l����AX?-x���0'%���<��+����	e���+%H4

data/README.md

@@ -5,11 +5,12 @@
 [![Code Climate Coverage](https://codeclimate.com/github/bkuhlmann/gemsmith/coverage.svg)](https://codeclimate.com/github/bkuhlmann/gemsmith)
 [![Gemnasium Status](https://gemnasium.com/bkuhlmann/gemsmith.svg)](https://gemnasium.com/bkuhlmann/gemsmith)
 [![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/gemsmith.svg)](http://travis-ci.org/bkuhlmann/gemsmith)
+[![Patreon](https://img.shields.io/badge/patreon-donate-brightgreen.svg)](https://www.patreon.com/bkuhlmann)
 
 A command line interface for smithing new Ruby gems.
 
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+
 # Table of Contents
 
 - [Features](#features)
@@ -31,32 +32,33 @@ A command line interface for smithing new Ruby gems.
 - [History](#history)
 - [Credits](#credits)
 
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
 
 # Features
 
-- Builds a gem skeleton with Bundler functionality in mind.
+- Builds a gem skeleton with enhanced Bundler functionality.
 - Supports common settings to be applied when creating new gems.
-- Supports [Thor](https://github.com/wycats/thor) command line functionality.
+- Supports [Thor](https://github.com/wycats/thor) command line interface (CLI) functionality.
 - Supports [Ruby on Rails](http://rubyonrails.org).
-- Supports [RSpec](http://rspec.info).
-- Supports [Rubocop](https://github.com/bbatsov/rubocop).
 - Supports [Pry](http://pryrepl.org).
 - Supports [Guard](https://github.com/guard/guard).
+- Supports [RSpec](http://rspec.info).
+- Supports [Rubocop](https://github.com/bbatsov/rubocop).
 - Supports [Code Climate](https://codeclimate.com).
 - Supports [Gemnasium](https://gemnasium.com).
 - Supports [Travis CI](http://travis-ci.org).
+- Supports [Patreon](https://www.patreon.com).
 - Provides the ability to open the source code of any gem within your favorite editor.
 - Provides the ability to read the documentation of any gem within your default browser.
 - Adds commonly needed [README](README.md), [CHANGELOG](CHANGELOG.md), [CONTRIBUTING](CONTRIBUTING.md),
-  [LICENSE](LICENSE.md), etc. template files.
+  [CODE OF CONDUCT](CODE_OF_CONDUCT.md), [LICENSE](LICENSE.md), etc. documentation.
 
 # Requirements
 
-0. A UNIX-based system.
-0. [MRI 2.x.x](http://www.ruby-lang.org).
-0. [RubyGems](http://rubygems.org).
-0. [Bundler](https://github.com/carlhuda/bundler).
+0. A UNIX-based system
+0. [MRI 2.x.x](http://www.ruby-lang.org)
+0. [RubyGems](http://rubygems.org)
+0. [Bundler](https://github.com/carlhuda/bundler)
 
 # Setup
 
@@ -74,37 +76,60 @@ For an insecure install, type the following (not recommended):
 
 You can configure common settings for future gem builds by creating the following file:
 
-    ~/.gemsmith/settings.yml
-
-...using the following settings (for example):
-
-    ---
-    :author_name: Joe Smith
-    :author_email: joe@smithware.com
-    :author_url: https://www.smithware.com
-    :company_name: Smithware
-
-If no options are configured, then the defaults are as follows:
-
-    gem_platform: Gem::Platform::RUBY
-    gem_private_key: ~/.ssh/gem-private.pem
-    gem_public_key: ~/.ssh/gem-public.pem
-    author_name: <git name>
-    author_email: <git email>
-    author_url: https://www.unknown.com
-    gem_url: <author URL>
-    company_name: <author name>
-    company_url: <author URL>
-    github_user: <github user>
-    year: <current year>
-    ruby_version: 2.2.0
-    rails_version: 4.2
+    ~/.gemsmithrc
+
+...using the following settings (as a simple example):
+
+    :author:
+      :name: "Joe Smith"
+      :email: "joe@example.com"
+      :url: "https://www.example.com"
+    :organization:
+      :name: "ExampleSoft"
+      :url: "https://www.example.com"
+
+The following defaults are used when no options are configured:
+
+    :year: <current year>
+    :github_user: <git config GitHub user>
+    :gem:
+      :platform: "Gem::Platform::RUBY"
+      :home_url: ""
+      :license: "MIT"
+      :private_key: "~/.ssh/gem-private.pem"
+      :public_key: "~/.ssh/gem-public.pem"
+    :author:
+      :name: <git config user name>
+      :email: <git config user email>
+      :url: ""
+    :organization:
+      :name: ""
+      :url: ""
+    :versions:
+      :ruby: <current Ruby version>
+      :rails: "4.2"
+    :create:
+      :cli: false
+      :rails: false
+      :security: true
+      :pry: true
+      :guard: true
+      :rspec: true
+      :rubocop: true
+      :code_climate: true
+      :gemnasium: true
+      :travis: true
+      :patreon: true
+
+While Gemsmith is fully customizable, please keep in mind that these are *global* settings and, once set, will affect
+all future gem creations. Further customization is also provided via the CLI for a customizable experience per gem if
+necessary.
 
 # Usage
 
 ## Command Line Interface (CLI)
 
-From the command line, type: gemsmith help
+From the command line, type: `gemsmith --help`
 
     gemsmith -c, [create=CREATE]  # Create new gem.
     gemsmith -e, [--edit]         # Edit Gemsmith settings in default editor.
@@ -113,9 +138,9 @@ From the command line, type: gemsmith help
     gemsmith -r, [read=READ]      # Open a gem in default browser.
     gemsmith -v, [--version]      # Show Gemsmith version.
 
-For more gem creation options, type: gemsmith help create
+For more gem creation options, type: `gemsmith --help --create`
 
-    -b, [--bin], [--no-bin]                    # Add binary support.
+    -c, [--cli], [--no-cli]                    # Add CLI support.
     -r, [--rails], [--no-rails]                # Add Rails support.
     -S, [--security], [--no-security]          # Add security support.
                                                # Default: true
@@ -127,35 +152,45 @@ For more gem creation options, type: gemsmith help create
                                                # Default: true
     -R, [--rubocop], [--no-rubocop]            # Add Rubocop support.
                                                # Default: true
-    -c, [--code-climate], [--no-code-climate]  # Add Code Climate support.
+    -C, [--code-climate], [--no-code-climate]  # Add Code Climate support.
                                                # Default: true
     -G, [--gemnasium], [--no-gemnasium]        # Add Gemnasium support.
                                                # Default: true
     -t, [--travis], [--no-travis]              # Add Travis CI support.
                                                # Default: true
+    -P, [--patreon], [--no-patreon]            # Add Patreon support.
+                                               # Default: true
 
 ## Rake
 
 Once a gem skeleton has been created, the following tasks are available within the project via Bundler (i.e. rake -T):
 
-    rake build                 # Build example-0.1.0.gem into the pkg directory
+    rake build                 # Build gemsmith-6.0.0.gem into the pkg directory
     rake clean                 # Clean gem artifacts
-    rake install               # Build and install example-0.1.0.gem into system gems
-    rake install:local         # Build and install example-0.1.0.gem into system gems without network access
-    rake publish               # Build, tag v0.1.0 (signed), and push example-0.1.0.gem to RubyGems
-    rake readme:toc            # Update README Table of Contents
-    rake release               # Create tag v0.1.0 and build and push example-0.1.0.gem to Rubygems
+    rake doc                   # Update README (table of contents)
+    rake install               # Build and install gemsmith-6.0.0.gem into system gems
+    rake install:local         # Build and install gemsmith-6.0.0.gem into system gems without network access
+    rake publish               # Build, tag v6.0.0 (signed), and push gemsmith-6.0.0.gem to RubyGems
+    rake release               # Create tag v6.0.0 and build and push gemsmith-6.0.0.gem to Rubygems
     rake rubocop               # Run RuboCop
     rake rubocop:auto_correct  # Auto-correct RuboCop offenses
     rake spec                  # Run RSpec code examples
 
+Run `bundle exec rake` to run everything (includes all specs and code quality checks).
+
 ## Upgrades
 
-For those upgrading from Gemsmith 5.3.0 and wanting to use the new Rake tasks, do the following:
+For those upgrading from Gemsmith 5.6.0 please be aware of the following changes:
 
-- Edit your `gemspec` and add the following dependency: `spec.add_development_dependency "gemsmith"`.
-- Edit your `Rakefile` and remove the Bundler requirement `require "bundler/gem_tasks"` and replace it with
-  the Gemsmith tasks: `require "gemsmith/rake/setup"`. Don't worry, this includes the Bundler tasks too.
+- Move your `~/.gemsmith/settings.yml` settings to the new `~/.gemsmithrc` file. Refer to the Setup documentation
+  mentioned above for details.
+- The `--cli/-c` create option has been replaced with the `--bin/-b` create option.
+- The `--code-climate` create option shortcut is now `-C` instead of `-c`.
+- [Tocer](https://github.com/bkuhlmann/tocer) has replaced [DocToc](https://github.com/thlorenz/doctoc) as a pure Ruby
+  implementation for generating README table of contents and removing the dependency on NPM.
+- The `rake readme:toc` task has been replaced with `rake doc`.
+- Using Rake to build or publish a gem will fail if uncommitted Git changes are detected helping to prevent you
+  from publishing a gem with missing changes.
 
 # Tests
 
@@ -202,8 +237,8 @@ To create a certificate for your gems, run the following:
     gem cert --build you@example.com
     chmod 600 gem-*.pem
 
-The resulting *.pem keys can be referenced via the *gem_private_key- and *gem_public_key- settings mentioned in the
-Setup documentation.
+The resulting `*.pem` key files can be referenced via the `:private_key:` and `:public_key:` keys within the
+`~/.gemsmithrc` file.
 
 To learn more about gem certificates, read the following:
 
@@ -213,9 +248,10 @@ To learn more about gem certificates, read the following:
 
 # Promotion
 
-Once your gem is released, you might like to let the world know about the new awesomeness. Here are several resources:
+Once your gem is released, you might want to let the world know about your awesomeness. Here are several resources:
 
 - [How to Spread the Word About Your Code](https://hacks.mozilla.org/2013/05/how-to-spread-the-word-about-your-code)
+- [Ruby Green News](http://greenruby.org)
 - [Ruby Toolbox](https://www.ruby-toolbox.com)
 - [RubyFlow](http://www.rubyflow.com)
 - [The Ruby Show](http://rubyshow.com)

data/lib/gemsmith.rb

@@ -1,2 +1 @@
 require "gemsmith/identity"
-require "gemsmith/kit"

data/lib/gemsmith/aids/gem.rb

@@ -0,0 +1,24 @@
+module Gemsmith
+  module Aids
+    # Parses a raw string into a valid gem and/or class name which can be used to construct gem skeletons
+    # and related Ruby objects.
+    class Gem
+      def initialize string = "unknown", util: Thor::Util
+        @string = string
+        @util = util
+      end
+
+      def name
+        @name ||= util.snake_case(string).tr(" ", "_").tr "-", "_"
+      end
+
+      def klass
+        @klass ||= util.camel_case name
+      end
+
+      private
+
+      attr_reader :string, :util
+    end
+  end
+end

data/lib/gemsmith/aids/git.rb

@@ -0,0 +1,10 @@
+module Gemsmith
+  module Aids
+    # A thin wrapper to Git.
+    class Git
+      def self.config_value key
+        `git config #{key}`.chomp
+      end
+    end
+  end
+end

data/lib/gemsmith/aids/spec.rb

@@ -0,0 +1,41 @@
+require "open3"
+
+module Gemsmith
+  module Aids
+    # A convenience aid to the Gem::Specification object.
+    class Spec
+      def initialize specification: ::Gem::Specification, shell: Open3
+        @specification = specification
+        @shell = shell
+      end
+
+      def editor
+        ENV["EDITOR"]
+      end
+
+      def open spec = nil
+        return unless spec
+        shell.capture2 editor, spec.full_gem_path
+      end
+
+      def read spec = nil
+        return unless spec
+        return if spec.homepage.nil? || spec.homepage.empty?
+
+        shell.capture2 "open", spec.homepage
+      end
+
+      def find name, version
+        specification.find_by_name name, version
+      end
+
+      def find_all name
+        specification.find_all_by_name name
+      end
+
+      private
+
+      attr_reader :specification, :shell
+    end
+  end
+end

data/lib/gemsmith/cli.rb

@@ -2,8 +2,9 @@ require "yaml"
 require "thor"
 require "thor/actions"
 require "thor_plus/actions"
-require "gemsmith/cli_options"
-require "gemsmith/cli_helpers"
+require "gemsmith/aids/gem"
+require "gemsmith/aids/git"
+require "gemsmith/aids/spec"
 require "gemsmith/skeletons/base_skeleton"
 require "gemsmith/skeletons/bundler_skeleton"
 require "gemsmith/skeletons/cli_skeleton"
@@ -11,19 +12,21 @@ require "gemsmith/skeletons/documentation_skeleton"
 require "gemsmith/skeletons/gem_skeleton"
 require "gemsmith/skeletons/git_skeleton"
 require "gemsmith/skeletons/guard_skeleton"
+require "gemsmith/skeletons/pry_skeleton"
 require "gemsmith/skeletons/rails_skeleton"
 require "gemsmith/skeletons/rake_skeleton"
 require "gemsmith/skeletons/rspec_skeleton"
 require "gemsmith/skeletons/rubocop_skeleton"
 require "gemsmith/skeletons/ruby_skeleton"
 require "gemsmith/skeletons/travis_skeleton"
+require "gemsmith/cli_helpers"
+require "gemsmith/configuration"
 
 module Gemsmith
   # The Command Line Interface (CLI) for the gem.
   class CLI < Thor
     include Thor::Actions
     include ThorPlus::Actions
-    include CLIOptions
     include CLIHelpers
 
     package_name Gemsmith::Identity.version_label
@@ -44,6 +47,7 @@ module Gemsmith
         Skeletons::RspecSkeleton,
         Skeletons::RubocopSkeleton,
         Skeletons::GuardSkeleton,
+        Skeletons::PrySkeleton,
         Skeletons::TravisSkeleton,
         Skeletons::BundlerSkeleton,
         Skeletons::GitSkeleton
@@ -53,29 +57,29 @@ module Gemsmith
     # Initialize.
     def initialize args = [], options = {}, config = {}
       super args, options, config
-      @settings_file = File.join ENV["HOME"], ".gemsmith", "settings.yml"
-      @settings = load_yaml @settings_file
-      @template_options = {}
+      @configuration = Configuration.new
+      @spec_aid = Aids::Spec.new
     end
 
     desc "-c, [create=CREATE]", "Create new gem."
     map %w(-c --create) => :create
-    method_option :bin, aliases: "-b", desc: "Add binary support.", type: :boolean, default: false
+    method_option :cli, aliases: "-c", desc: "Add CLI support.", type: :boolean, default: false
     method_option :rails, aliases: "-r", desc: "Add Rails support.", type: :boolean, default: false
     method_option :security, aliases: "-S", desc: "Add security support.", type: :boolean, default: true
     method_option :pry, aliases: "-p", desc: "Add Pry support.", type: :boolean, default: true
     method_option :guard, aliases: "-g", desc: "Add Guard support.", type: :boolean, default: true
     method_option :rspec, aliases: "-s", desc: "Add RSpec support.", type: :boolean, default: true
     method_option :rubocop, aliases: "-R", desc: "Add Rubocop support.", type: :boolean, default: true
-    method_option :code_climate, aliases: "-c", desc: "Add Code Climate support.", type: :boolean, default: true
+    method_option :code_climate, aliases: "-C", desc: "Add Code Climate support.", type: :boolean, default: true
     method_option :gemnasium, aliases: "-G", desc: "Add Gemnasium support.", type: :boolean, default: true
     method_option :travis, aliases: "-t", desc: "Add Travis CI support.", type: :boolean, default: true
+    method_option :patreon, aliases: "-P", desc: "Add Patreon support.", type: :boolean, default: true
     def create name
       say
       info "Creating gem..."
 
-      initialize_template_options name, options
-      self.class.skeletons.each { |skeleton| skeleton.create self }
+      setup_configuration name, options
+      self.class.skeletons.each { |skeleton| skeleton.create self, configuration: configuration }
 
       info "Gem created."
       say
@@ -96,7 +100,8 @@ module Gemsmith
     desc "-e, [--edit]", "Edit #{Gemsmith::Identity.label} settings in default editor."
     map %w(-e --edit) => :edit
     def edit
-      `#{editor} #{@settings_file}`
+      info "Editing: #{configuration.file_path}..."
+      `#{spec_aid.editor} #{configuration.file_path}`
     end
 
     desc "-v, [--version]", "Show #{Gemsmith::Identity.label} version."
@@ -110,5 +115,15 @@ module Gemsmith
     def help task = nil
       say && super
     end
+
+    private
+
+    attr_reader :configuration, :spec_aid
+
+    def setup_configuration name, options
+      gem = Aids::Gem.new name
+      @configuration = Configuration.new gem_name: gem.name, gem_class: gem.klass
+      options.each { |key, value| configuration.public_send "create_#{key}=", value }
+    end
   end
 end

data/lib/gemsmith/cli_helpers.rb

@@ -1,97 +1,48 @@
 module Gemsmith
-  # Command Line Interface (CLI) helpers that aid the CLI class. These are extracted to a module
-  # in order to not clutter up the main CLI object.
+  # Command Line Interface (CLI) helpers for the CLI class.
   module CLIHelpers
-    # Answers default editor.
-    # NOTE: This will be replaced by the Thor+ gem in the future.
-    def editor
-      ENV["EDITOR"]
+    def gem_name
+      configuration.gem_name
     end
 
-    # Answers the gem name (snake case).
-    # ==== Parameters
-    # * +name+ - Optional. The gem name. Default: nil
-    def gem_name name = nil
-      @gem_name ||= Thor::Util.snake_case name
+    def gem_class
+      configuration.gem_class
     end
 
-    # Answers the gem class (camel case).
-    # ==== Parameters
-    # * +name+ - Optional. The gem class. Default: nil
-    def gem_class name = nil
-      @gem_class ||= Thor::Util.camel_case name
-    end
-
-    # Answers all gem template options.
-    def template_options
-      @template_options
+    def rails_version
+      configuration.rails_version
     end
 
     module_function
 
-    # Converts hash keys from strings to symbols (if any).
-    # ===== Parameters
-    # * +options+ - Optional. The hash to convert. Default: {}
-    def enforce_symbol_keys options = {}
-      options.each.with_object({}) { |(key, value), hash| hash[key.to_sym] = value }
-    end
-
-    # Prints currently installed gem name and version information.
-    # ===== Parameters
-    # * +gems+ - Required. The array of gem names (i.e. gem specifications).
     def print_gems gems
-      say "Multiple versions found:"
-      gems.each.with_index do |spec, index|
-        say "#{index + 1}. #{spec.name} #{spec.version.version}"
-      end
+      say "Multiple versions found:\n\n"
+      gems.each.with_index { |spec, index| say "#{index + 1}. #{spec.name} #{spec.version.version}" }
+      say "q. Quit.\n\n"
     end
 
-    # Picks a gem specification for processing.
-    # ===== Parameters
-    # * +gems+ - Required. The array of gem specifications.
-    # * +name+ - Required. The gem name to search for.
     def pick_gem gems, name
-      result = ask "Please pick one (or type 'q' to quit):"
+      answer = ask "Enter selection:"
+      return if answer == "q"
 
-      return if result == "q" # Exit early.
-
-      if (1..gems.size).include?(result.to_i)
-        Gem::Specification.find_by_name name, gems[result.to_i - 1].version.version
+      if (1..gems.size).include?(answer.to_i)
+        spec_aid.find name, gems[answer.to_i - 1].version.version
       else
-        error "Invalid option: #{result}"
-        nil
+        error "Invalid option: #{answer}"
       end
     end
 
-    # Opens selected gem within default editor.
-    # ===== Parameters
-    # * +spec+ - Required. The gem specification.
-    def open_gem spec
-      `#{editor} #{spec.full_gem_path}` if spec
-    end
-
-    # Opens selected gem within default browser.
-    # ===== Parameters
-    # * +spec+ - Required. The gem specification.
-    def read_gem spec
-      `open #{spec.homepage}` if spec
-    end
-
-    # Processes a gem for given name and command.
-    # ===== Parameters
-    # * +name+ - Required. The gem name.
-    # * +command+ - Required. The command to process the gem.
-    def process_gem name, command
-      specs = Gem::Specification.find_all_by_name name
+    def process_gem name, method
+      specs = spec_aid.find_all name
 
       case
         when specs.size == 1
-          send "#{command}_gem", specs.first
+          spec_aid.send method, specs.first
         when specs.size > 1
           print_gems specs
-          send "#{command}_gem", pick_gem(specs, name)
+          spec_aid.send method, pick_gem(specs, name)
         else
-          say "Unable to find gem: #{name}"
+          error "Unable to find gem: #{name}."
       end
     end
   end