gemsmith 9.6.0 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2437c54efda433409f6ed6dff97d4479ab8c911
-  data.tar.gz: 92226a891da304566e93489e37bce5fb71727cff
+  metadata.gz: 0dc045c4ae1d57ae19dfab6dc5b8cab656b73350
+  data.tar.gz: 9848b73d3ab5110e1f022e089cd8abf382bdea36
 SHA512:
-  metadata.gz: 35465e2422c5ea38b93a0dc84bdb282b3b6866083335cef8fbd3ba65c3cb44a865d634788755dc16d3796867a639d005e4af36b1c8cf632484a2c62d0594f23d
-  data.tar.gz: 1e36cd61e6df3f1ee340506770ba9b82b186ef880485a16c10ca3dcda2b199a4668c50f026f5082b42bb460762fe4866262aa2d88ed6b1973a6212bb2b8e2602
+  metadata.gz: ea41d7745d67c0c8fd8a114a81dd60ffc092bd9413c267b133fbcaff8d82abd4b5c510e03415ffc945adcd37bcf7ff806fbb9cfa1a0ab590b08dfdea5340d2e7
+  data.tar.gz: a3514b43626d2be71b40790785ee552458b0cdd86039dfd1467ae1f25a190ceb0b82ac4e70a61cac1f6b4bea3e7dc7d1a66b0770addfddb0fb75b0b19893eb58

checksums.yaml.gz.sig

@@ -0,0 +1,3 @@
+u=�)'¯S{R��Ec���^��͘�l;m$�(��l���eT���J��=C;k0:ȧ��YS �}�V%g��²��㩖>҈��Z��〦ݤ�w�϶*U��ѽ���0�= G�KK�8V�w�V��;�S&$"�]�:��1d�I�4݆.��8�<��:H4�����&�~b�`K)7I��u�e{�}��,y>�O��ߔ�.>i�
++�[R�R�\����2�c[,��8��
+r��'?��pmۜn�
�%

data/README.md

@@ -4,44 +4,44 @@
 [![Code Climate GPA](https://codeclimate.com/github/bkuhlmann/gemsmith.svg)](https://codeclimate.com/github/bkuhlmann/gemsmith)
 [![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)](https://travis-ci.org/bkuhlmann/gemsmith)
+[![Circle CI Status](https://circleci.com/gh/bkuhlmann/gemsmith.svg?style=svg)](https://circleci.com/gh/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.
 
 <!-- Tocer[start]: Auto-generated, don't remove. -->
 
-# Table of Contents
-
-- [Features](#features)
-- [Screencasts](#screencasts)
-- [Requirements](#requirements)
-- [Setup](#setup)
-  - [Install](#install)
-  - [Configuration](#configuration)
-  - [Existing Gems](#existing-gems)
-- [Usage](#usage)
-  - [Command Line Interface (CLI)](#command-line-interface-cli)
-  - [Rake](#rake)
-- [Tests](#tests)
-- [Security](#security)
-  - [Git Signing Key](#git-signing-key)
-  - [Gem Certificates](#gem-certificates)
-- [Private Gem Servers](#private-gem-servers)
-  - [Gem Specification Metadata](#gem-specification-metadata)
-  - [Gem Credentials](#gem-credentials)
-- [Promotion](#promotion)
-- [Troubleshooting](#troubleshooting)
-- [Versioning](#versioning)
-- [Code of Conduct](#code-of-conduct)
-- [Contributions](#contributions)
-- [License](#license)
-- [History](#history)
-- [Credits](#credits)
+## Table of Contents
+
+  - [Features](#features)
+  - [Screencasts](#screencasts)
+  - [Requirements](#requirements)
+  - [Setup](#setup)
+    - [Install](#install)
+    - [Configuration](#configuration)
+    - [Existing Gems](#existing-gems)
+  - [Usage](#usage)
+    - [Command Line Interface (CLI)](#command-line-interface-cli)
+    - [Rake](#rake)
+  - [Tests](#tests)
+  - [Security](#security)
+    - [Git Signing Key](#git-signing-key)
+    - [Gem Certificates](#gem-certificates)
+  - [Private Gem Servers](#private-gem-servers)
+    - [Gem Specification Metadata](#gem-specification-metadata)
+    - [Gem Credentials](#gem-credentials)
+  - [Promotion](#promotion)
+  - [Troubleshooting](#troubleshooting)
+  - [Versioning](#versioning)
+  - [Code of Conduct](#code-of-conduct)
+  - [Contributions](#contributions)
+  - [License](#license)
+  - [History](#history)
+  - [Credits](#credits)
 
 <!-- Tocer[finish]: Auto-generated, don't remove. -->
 
-# Features
+## Features
 
 - Builds a gem skeleton with enhanced Bundler functionality.
 - Uses [Refinements](https://github.com/bkuhlmann/refinements) Ruby core library enhancements.
@@ -56,13 +56,14 @@ A command line interface for smithing new Ruby gems.
 - Supports [Pry](http://pryrepl.org).
 - Supports [Guard](https://github.com/guard/guard).
 - Supports [RSpec](http://rspec.info).
+- Supports [Git Cop](https://github.com/bkuhlmann/git-cop).
 - Supports [Reek](https://github.com/troessner/reek).
 - Supports [Rubocop](https://github.com/bbatsov/rubocop).
 - Supports [SCSS Lint](https://github.com/brigade/scss-lint).
 - Supports [GitHub](https://github.com).
 - Supports [Code Climate](https://codeclimate.com).
 - Supports [Gemnasium](https://gemnasium.com).
-- Supports [Travis CI](https://travis-ci.org).
+- Supports [Circle CI](https://circleci.com).
 - Supports [Patreon](https://www.patreon.com).
 - Supports common settings and a structured layout for building new gems.
 - Supports publishing to public or private gem servers.
@@ -75,20 +76,20 @@ A command line interface for smithing new Ruby gems.
 - Aids in viewing source code of semantically versioned gems within your favorite editor.
 - Aids in viewing documentation of semantically versioned within your default browser.
 
-# Screencasts
+## Screencasts
 
-[![asciicast](https://asciinema.org/a/92550.png)](https://asciinema.org/a/92550)
+[![asciicast](https://asciinema.org/a/125222.png)](https://asciinema.org/a/125222)
 
-# Requirements
+## Requirements
 
 0. A UNIX-based system.
 0. [Ruby 2.4.x](https://www.ruby-lang.org).
 0. [RubyGems](https://rubygems.org).
 0. [Bundler](https://github.com/bundler/bundler).
 
-# Setup
+## Setup
 
-## Install
+### Install
 
 For a secure install, type the following from the command line (recommended):
 
@@ -103,17 +104,21 @@ For an insecure install, type the following (not recommended):
 
     gem install gemsmith
 
-## Configuration
+### Configuration
 
-You can configure common settings for future gem builds by creating the following file:
+This gem can be configured via a global configuration:
 
-    ~/.gemsmithrc
+    ~/.config/gemsmith/configuration.yml
 
-The following defaults are used when no options are configured:
+It can also be configured via [XDG environment variables](https://github.com/bkuhlmann/runcom#xdg)
+as provided by the [Runcom](https://github.com/bkuhlmann/runcom) gem.
+
+The default configuration is as follows:
 
     :year: <current year>
     :github_user: "<Git config GitHub user>",
     :gem:
+      :label: "Undefined"
       :name: "undefined"
       :path: "undefined"
       :class: "Undefined"
@@ -129,13 +134,14 @@ The following defaults are used when no options are configured:
       :url: ""
     :versions:
       :ruby: "<current Ruby version>"
-      :rails: "5.0"
+      :rails: "5.1"
     :generate:
       :cli: false
       :rails: false
       :security: true
       :pry: true
       :guard: true
+      :git_cop: true
       :rspec: true
       :reek: true
       :rubocop: true
@@ -143,16 +149,15 @@ The following defaults are used when no options are configured:
       :git_hub: false
       :code_climate: false
       :gemnasium: false
-      :travis: false
+      :circle_ci: false
       :patreon: false
     :publish:
       :sign: false
 
-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.
+Feel free to take this default configuration, modify, and save as your own custom
+`configuration.yml`.
 
-## Existing Gems
+### Existing Gems
 
 If you have gems that were not originally crafted by Gemsmith, you can add Gemsmith support to them
 by modifying the following files:
@@ -175,9 +180,9 @@ Replace or add a modified version of the following to your gem's `Rakefile`:
 
 With those changes, you can leverage the benefits of Gemsmith within your existing gem.
 
-# Usage
+## Usage
 
-## Command Line Interface (CLI)
+### Command Line Interface (CLI)
 
 From the command line, type: `gemsmith --help`
 
@@ -198,6 +203,8 @@ For more gem generation options, type: `gemsmith --help --generate`
                                            # Default: true
     [--guard], [--no-guard]                # Add Guard support.
                                            # Default: true
+    [--git-cop], [--no-git-cop]            # Add Git Cop support.
+                                           # Default: true
     [--rspec], [--no-rspec]                # Add RSpec support.
                                            # Default: true
     [--reek], [--no-reek]                  # Add Reek support.
@@ -208,20 +215,21 @@ For more gem generation options, type: `gemsmith --help --generate`
     [--git-hub], [--no-git-hub]            # Add GitHub support.
     [--code-climate], [--no-code-climate]  # Add Code Climate support.
     [--gemnasium], [--no-gemnasium]        # Add Gemnasium support.
-    [--travis], [--no-travis]              # Add Travis CI support.
+    [--circle-ci], [--no-circle-ci]        # Add Circle CI support.
     [--patreon], [--no-patreon]            # Add Patreon support.
 
-## Rake
+### Rake
 
 Once a gem skeleton has been created, the following tasks are available (i.e. `bundle exec rake
 -T`):
 
-    rake build                 # Build gemsmith-9.6.0.gem package
+    rake build                 # Build example-0.1.0.gem package
     rake clean                 # Clean gem artifacts
     rake code_quality          # Run code quality checks
     rake doc                   # Update README (table of contents)
-    rake install               # Install gemsmith-9.6.0.gem package
-    rake publish               # Build, tag as v9.6.0 (signed), and push gemsmith-9.6.0.gem to RubyGems
+    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 reek                  # Check for code smells
     rake rubocop               # Run RuboCop
     rake rubocop:auto_correct  # Auto-correct RuboCop offenses
@@ -237,15 +245,15 @@ When satified with your gem, builds are green, and ready to publish, run:
 
     bundle exec rake publish
 
-# Tests
+## Tests
 
 To test, run:
 
     bundle exec rake
 
-# Security
+## Security
 
-## Git Signing Key
+### Git Signing Key
 
 To securely sign your Git tags, install and configure [GPG](https://www.gnupg.org):
 
@@ -274,7 +282,7 @@ Now, when publishing your gems with Gemsmith (i.e. `bundle exec rake publish`),
 tag will happen automatically. You will be prompted for the GPG Passphrase each time but that is to
 be expected.
 
-## Gem Certificates
+### Gem Certificates
 
 To create a certificate for your gems, run the following:
 
@@ -291,7 +299,7 @@ To learn more about gem certificates, read the following:
 - [A Practical Guide to Using Signed Ruby Gems - Part 1: Bundler](http://blog.meldium.com/home/2013/3/3/signed-rubygems-part)
 - [A Practical Guide to Using Signed Ruby Gems - Part 2: Heroku](http://blog.meldium.com/home/2013/3/6/signed-gems-on-heroku)
 
-# Private Gem Servers
+## Private Gem Servers
 
 By default, the following Rake task will publish your gem to [RubyGems](https://rubygems.org):
 
@@ -301,7 +309,7 @@ You can change this behavior by adding metadata to your gemspec that will allow
 mentioned above, to publish your gem to an alternate/private gem server instead. This can be done by
 updating your gem specification and RubyGems credentials.
 
-## Gem Specification Metadata
+### Gem Specification Metadata
 
 Add the following metadata to your gemspec:
 
@@ -320,7 +328,7 @@ represents the following:
   file so that sensitive credentials are not used within your gemspec.
 - `allowed_push_host`: Provides the URL of the private gem server to push your gem to.
 
-## Gem Credentials
+### Gem Credentials
 
 With your gem specification metadata established, you are ready to publish your gem to a public or
 private server. If this is your first time publishing a gem and no gem credentials have been
@@ -336,21 +344,21 @@ Should you need to delete a credential (due to a bad login/password for example)
 `~/.gem/credentials` in your default editor and remove the line(s) you don't need. Upon next publish
 of your gem, you'll be prompted for the missing credentials.
 
-# Promotion
+## Promotion
 
 Once your gem is released, you might want to let the world know about your accomplishment:
 
 - [How to Spread the Word About Your Code](https://hacks.mozilla.org/2013/05/how-to-spread-the-word-about-your-code)
 - [RubyFlow](http://www.rubyflow.com)
 
-# Troubleshooting
+## Troubleshooting
 
 When running `bundle exec rake install` or `bundle exec rake publish` with modified, staged, or
 uncommitted Git changes, the rake task will throw an error to this effect. When this occurs, it is
 recommended that you commit your changes or [stash](https://git-scm.com/docs/git-stash) them before
 proceeding.
 
-# Versioning
+## Versioning
 
 Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
 
@@ -358,25 +366,25 @@ Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
 - Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
 - Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
 
-# Code of Conduct
+## 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.
 
-# Contributions
+## Contributions
 
 Read [CONTRIBUTING](CONTRIBUTING.md) for details.
 
-# License
+## License
 
 Copyright (c) 2011 [Alchemists](https://www.alchemists.io).
 Read [LICENSE](LICENSE.md) for details.
 
-# History
+## History
 
 Read [CHANGES](CHANGES.md) for details.
 
-# Credits
+## Credits
 
 Developed by [Brooke Kuhlmann](https://www.alchemists.io) at
 [Alchemists](https://www.alchemists.io).

data/lib/gemsmith.rb

@@ -13,11 +13,13 @@ require "gemsmith/gem/requirement"
 require "gemsmith/gem/specification"
 require "gemsmith/generators/base"
 require "gemsmith/generators/bundler"
+require "gemsmith/generators/circle_ci"
 require "gemsmith/generators/cli"
 require "gemsmith/generators/code_climate"
 require "gemsmith/generators/documentation"
 require "gemsmith/generators/gem"
 require "gemsmith/generators/git"
+require "gemsmith/generators/git_cop"
 require "gemsmith/generators/git_hub"
 require "gemsmith/generators/guard"
 require "gemsmith/generators/pragma"
@@ -28,7 +30,6 @@ require "gemsmith/generators/rspec"
 require "gemsmith/generators/rubocop"
 require "gemsmith/generators/ruby"
 require "gemsmith/generators/scss_lint"
-require "gemsmith/generators/travis"
 require "gemsmith/rake/builder"
 require "gemsmith/rake/publisher"
 require "gemsmith/rake/tasks"

data/lib/gemsmith/cli.rb

@@ -2,7 +2,6 @@
 
 require "thor"
 require "thor/actions"
-require "thor_plus/actions"
 require "refinements/strings"
 require "refinements/hashes"
 require "runcom"
@@ -14,7 +13,6 @@ module Gemsmith
   # rubocop:disable Metrics/ClassLength
   class CLI < Thor
     include Thor::Actions
-    include ThorPlus::Actions
     include Helpers::CLI
     include Helpers::Template
 
@@ -30,10 +28,11 @@ module Gemsmith
 
     # rubocop:disable Metrics/MethodLength
     def self.configuration
-      Runcom::Configuration.new file_name: Identity.file_name, defaults: {
+      Runcom::Configuration.new project_name: Identity.name, defaults: {
         year: Time.now.year,
         github_user: Git.github_user,
         gem: {
+          label: "Undefined",
           name: "undefined",
           path: "undefined",
           class: "Undefined",
@@ -60,6 +59,7 @@ module Gemsmith
           security: true,
           pry: true,
           guard: true,
+          git_cop: true,
           rspec: true,
           reek: true,
           rubocop: true,
@@ -67,7 +67,7 @@ module Gemsmith
           git_hub: false,
           code_climate: false,
           gemnasium: false,
-          travis: false,
+          circle_ci: false,
           patreon: false
         },
         publish: {
@@ -85,12 +85,13 @@ module Gemsmith
         Generators::Ruby,
         Generators::Rails,
         Generators::Rspec,
+        Generators::GitCop,
         Generators::Reek,
         Generators::Rubocop,
         Generators::SCSSLint,
         Generators::CodeClimate,
         Generators::Guard,
-        Generators::Travis,
+        Generators::CircleCI,
         Generators::Bundler,
         Generators::GitHub,
         Generators::Pragma,
@@ -126,6 +127,10 @@ module Gemsmith
                   desc: "Add Guard support.",
                   type: :boolean,
                   default: configuration.to_h.dig(:generate, :guard)
+    method_option :git_cop,
+                  desc: "Add Git Cop support.",
+                  type: :boolean,
+                  default: configuration.to_h.dig(:generate, :git_cop)
     method_option :rspec,
                   desc: "Add RSpec support.",
                   type: :boolean,
@@ -154,24 +159,25 @@ module Gemsmith
                   desc: "Add Gemnasium support.",
                   type: :boolean,
                   default: configuration.to_h.dig(:generate, :gemnasium)
-    method_option :travis,
-                  desc: "Add Travis CI support.",
+    method_option :circle_ci,
+                  desc: "Add Circle CI support.",
                   type: :boolean,
-                  default: configuration.to_h.dig(:generate, :travis)
+                  default: configuration.to_h.dig(:generate, :circle_ci)
     method_option :patreon,
                   desc: "Add Patreon support.",
                   type: :boolean,
                   default: configuration.to_h.dig(:generate, :patreon)
     # rubocop:disable Metrics/AbcSize
+    # :reek:TooManyStatements
     def generate name
       print_cli_and_rails_engine_option_error && return if options.cli? && options.rails?
 
-      info "Generating gem..."
+      say_status :info, "Generating gem...", :green
 
       setup_configuration name: name, options: options.to_h
       self.class.generators.each { |generator| generator.run self, configuration: configuration }
 
-      info "Gem generation finished."
+      say_status :info, "Gem generation finished.", :green
     end
 
     desc "-o, [--open=GEM]", "Open a gem in default editor."
@@ -183,10 +189,10 @@ module Gemsmith
     desc "-r, [--read=GEM]", "Open a gem in default browser."
     map %w[-r --read] => :read
     def read name
-      error "Gem home page is not defined." unless process_gem(name, "visit")
+      say_status :error, "Gem home page is not defined.", :red unless process_gem(name, "visit")
     end
 
-    desc "-c, [--config]", %(Manage gem configuration ("#{configuration.computed_path}").)
+    desc "-c, [--config]", "Manage gem configuration."
     map %w[-c --config] => :config
     method_option :edit,
                   aliases: "-e",
@@ -197,10 +203,11 @@ module Gemsmith
                   desc: "Print gem configuration.",
                   type: :boolean, default: false
     def config
-      path = self.class.configuration.computed_path
+      path = self.class.configuration.path
 
-      if options.edit? then `#{editor} #{path}`
-      elsif options.info? then say(path)
+      if options.edit? then `#{ENV["EDITOR"]} #{path}`
+      elsif options.info?
+        path ? say(path) : say("Configuration doesn't exist.")
       else help(:config)
       end
     end
@@ -224,6 +231,7 @@ module Gemsmith
     def setup_configuration name:, options: {}
       @configuration = self.class.configuration.to_h.merge(
         gem: {
+          label: name.titleize,
           name: name,
           path: name.snakecase,
           class: name.camelcase,
@@ -236,8 +244,10 @@ module Gemsmith
     end
 
     def print_cli_and_rails_engine_option_error
-      error "Generating a gem with CLI and Rails Engine functionality is not allowed. " \
-            "Build separate gems for improved separation of concerns and design."
+      say_status :error,
+                 "Generating a gem with CLI and Rails Engine functionality is not allowed. " \
+                 "Build separate gems for improved separation of concerns and design.",
+                 :red
     end
   end
 end