gemsmith 6.1.0 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9329b2e9dca4bc7a89b0f35efe95087229a87005
-  data.tar.gz: 34077b66b9fa3b699307768ba60ba9afa13cfbc8
+  metadata.gz: 78f200738db26103b3c22eb26ebbe8fee20a87ff
+  data.tar.gz: 526f1f4e024c68ec73c621fd7417836e6bc7f52c
 SHA512:
-  metadata.gz: 9e49338d46f9adb532cf3d74df1e8190283d88777f6eb1fc2a63378fde3f10cb2f1bfdd8b4689daff9a988fcf7b256585460436829f0d667003823e7d56d347d
-  data.tar.gz: a74bb88641c78e1c4c49de6dff0660de1ad8cbe0faf53a6a70700c82d13d0102b537bdc7716f155af6fe1fa7f0766a9189defee614e1c4a380406d21f66f8a2b
+  metadata.gz: 9e9470682da74ef0758b4c2e7069e795c3604357b1f876211e1797a32735a5fb6846d09fe1be0384f71c94251357c3d7cdeaf59489c263c714dcdb6fdede4286
+  data.tar.gz: 980c3b30a186b60011ba34b0adb5b05bdb850dd6ab725fe8b11851c8cdc3ac01f1bc1b843a1303f0f5eed444571409af18156021b54dec9a7b4ebe3eb99ae89f

data/README.md

@@ -4,7 +4,7 @@
 [![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)](http://travis-ci.org/bkuhlmann/gemsmith)
+[![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/gemsmith.svg)](https://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.
@@ -37,8 +37,10 @@ A command line interface for smithing new Ruby gems.
 # Features
 
 - 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 interface (CLI) functionality.
+- Uses [Milestoner](https://github.com/bkuhlmann/milestoner) for consistent project/gem versioning.
+- Uses [Tocer](https://github.com/bkuhlmann/tocer) for README table of contents generation.
+- Uses common settings and a structured layout for building new gems.
+- Supports [Thor](https://github.com/erikhuda/thor).
 - Supports [Ruby on Rails](http://rubyonrails.org).
 - Supports [Pry](http://pryrepl.org).
 - Supports [Guard](https://github.com/guard/guard).
@@ -46,21 +48,21 @@ A command line interface for smithing new Ruby gems.
 - 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 [Travis CI](https://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),
   [CODE OF CONDUCT](CODE_OF_CONDUCT.md), [LICENSE](LICENSE.md), etc. documentation.
+- 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.
 
 [![asciicast](https://asciinema.org/a/30728.png)](https://asciinema.org/a/30728)
 
 # 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. [MRI 2.x.x](https://www.ruby-lang.org)
+0. [RubyGems](https://rubygems.org)
+0. [Bundler](https://github.com/bundler/bundler)
 
 # Setup
 
@@ -133,12 +135,12 @@ necessary.
 
 From the command line, type: `gemsmith --help`
 
-    gemsmith -c, [create=CREATE]  # Create new gem.
-    gemsmith -e, [--edit]         # Edit Gemsmith settings in default editor.
-    gemsmith -h, [--help=HELP]    # Show this message or get help for a command.
-    gemsmith -o, [open=OPEN]      # Open a gem in default editor.
-    gemsmith -r, [read=READ]      # Open a gem in default browser.
-    gemsmith -v, [--version]      # Show Gemsmith version.
+    gemsmith -c, [--create=CREATE]  # Create new gem.
+    gemsmith -e, [--edit]           # Edit Gemsmith settings in default editor.
+    gemsmith -h, [--help=HELP]      # Show this message or get help for a command.
+    gemsmith -o, [--open=OPEN]      # Open a gem in default editor.
+    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`
 
@@ -165,7 +167,7 @@ For more gem creation options, type: `gemsmith --help --create`
 
 ## Rake
 
-Once a gem skeleton has been created, the following tasks are available within the project via Bundler (i.e. rake -T):
+Once a gem skeleton has been created, the following tasks are available (i.e. `bundle exec rake -T`):
 
     rake build                 # Build gemsmith-6.0.0.gem into the pkg directory
     rake clean                 # Clean gem artifacts
@@ -178,7 +180,27 @@ Once a gem skeleton has been created, the following tasks are available within t
     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).
+Out of all Rake tasks listed above, the following are provided by [Bundler](http://bundler.io) and enhanced by
+Gemsmith:
+
+    rake build - Cleans and regenerates the README table of contents in addition to building the gem.
+    rake install - Inherits the `build` modifications mentioned above.
+    rake install:local - Inherits the `build` modifications mentioned above.
+    rake release - Inherits the `build` modifications mentioned above.
+
+When building/testing your gem locally, a typical workflow is:
+
+0. `gem uninstall <your gem name>`
+0. `bundle exec rake install`
+0. Test your gem locally.
+0. Repeat until satisfied.
+
+When satified with your gem, builds are green, and ready to publish, run:
+
+    bundle exec rake publish
+
+Alternatively, you can run `bundle exec rake release` if you don't wish to sign your gem releases (i.e default Bundler
+behavior) but the added security that `publish` provides is strongly recommended.
 
 ## Upgrades
 
@@ -186,13 +208,13 @@ For those upgrading from Gemsmith 5.6.0 please be aware of the following changes
 
 - 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 `--cli/-c` create option has replaced 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.
+- Using Rake to build, release, or publish a gem will fail if uncommitted Git changes are detected which prevent you
+  from publishing a gem prematurely.
 
 # Tests
 
@@ -228,8 +250,7 @@ Add your key to your global Git configuration in the `[user]` section. Example:
       signingkey = <your GPG key>
 
 Now, when publishing your gems with Gemsmith (i.e. `bundle exec rake publish`), signing of your Git tag will happen
-automatically. Should you not want to sign your tags, use `bundle exec rake release` which is the same as
-`bundle exec rake publish` except the Git tag is not signed.
+automatically.
 
 ## Gem Certificates
 
@@ -244,7 +265,7 @@ The resulting `*.pem` key files can be referenced via the `:private_key:` and `:
 
 To learn more about gem certificates, read the following:
 
-- [Ruby Gems](http://guides.rubygems.org/security/#building_gems)
+- [RubyGems](http://guides.rubygems.org/security/#building_gems)
 - [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)
 
@@ -253,11 +274,7 @@ To learn more about gem certificates, read the following:
 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)
-- [Ruby 5](https://ruby5.codeschool.com)
 
 # Versioning
 

data/lib/gemsmith/cli.rb

@@ -61,7 +61,7 @@ module Gemsmith
       @spec_aid = Aids::Spec.new
     end
 
-    desc "-c, [create=CREATE]", "Create new gem."
+    desc "-c, [--create=CREATE]", "Create new gem."
     map %w(-c --create) => :create
     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
@@ -85,14 +85,14 @@ module Gemsmith
       say
     end
 
-    desc "-o, [open=OPEN]", "Open a gem in default editor."
+    desc "-o, [--open=OPEN]", "Open a gem in default editor."
     map %w(-o --open) => :open
     def open name
       result = process_gem name, "open"
       info("Opening: #{result}") unless result.nil? || result.empty?
     end
 
-    desc "-r, [read=READ]", "Open a gem in default browser."
+    desc "-r, [--read=READ]", "Open a gem in default browser."
     map %w(-r --read) => :read
     def read name
       result = process_gem name, "read"

data/lib/gemsmith/identity.rb

@@ -10,7 +10,7 @@ module Gemsmith
     end
 
     def self.version
-      "6.1.0"
+      "6.2.0"
     end
 
     def self.version_label

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

@@ -9,7 +9,7 @@
 [![Gemnasium Status](https://gemnasium.com/<%= config.fetch :github_user %>/<%= config.fetch(:gem).fetch(:name) %>.svg)](https://gemnasium.com/<%= config.fetch :github_user %>/<%= config.fetch(:gem).fetch(:name) %>)
 <%- end -%>
 <%- if config.fetch(:create).fetch(:travis) -%>
-[![Travis CI Status](https://secure.travis-ci.org/<%= config.fetch :github_user %>/<%= config.fetch(:gem).fetch(:name) %>.svg)](http://travis-ci.org/<%= config.fetch :github_user %>/<%= config.fetch(:gem).fetch(:name) %>)
+[![Travis CI Status](https://secure.travis-ci.org/<%= config.fetch :github_user %>/<%= config.fetch(:gem).fetch(:name) %>.svg)](https://travis-ci.org/<%= config.fetch :github_user %>/<%= config.fetch(:gem).fetch(:name) %>)
 <%- end -%>
 <%- if config.fetch(:create).fetch(:patreon) -%>
 [![Patreon](https://img.shields.io/badge/patreon-donate-brightgreen.svg)](https://www.patreon.com/<%= config.fetch :github_user %>)
@@ -22,6 +22,7 @@
 
 # Requirements
 
+0. [MRI <%= config.fetch(:versions).fetch(:ruby) %>](https://www.ruby-lang.org)
 <%- if config.fetch(:create).fetch(:rails) -%>
 0. [Ruby on Rails](http://rubyonrails.org).
 <%- end -%>
@@ -31,7 +32,7 @@
 <%- if config.fetch(:create).fetch(:security) -%>
 For a secure install, type the following (recommended):
 
-    gem cert --add <(curl -Ls http://www.my-website.com/gem-public.pem)
+    gem cert --add <(curl -Ls https://www.my-website.com/gem-public.pem)
     gem install <%= config.fetch(:gem).fetch(:name) %> --trust-policy MediumSecurity
 
 NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification while

metadata

@@ -1,36 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gemsmith
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.2.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
 autorequire: 
 bindir: bin
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMQ8wDQYDVQQDDAZicm9v
-  a2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQBGRYC
-  aW8wHhcNMTUwNzA1MTQ1MzExWhcNMTYwNzA0MTQ1MzExWjBBMQ8wDQYDVQQDDAZi
-  cm9va2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQB
-  GRYCaW8wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCzhOVcvLGBCceM
-  PppVpJLUKsnskWzc1VqBXmv30feKNw+MOxMQaDsIP421qwqGO/2JHY60Kuobssk+
-  8/wqZkVFF/FFKxoQjuhlhc+VWLm8jWgXd4N1kwO2yytscQTzxc5qXarwA+36fqVH
-  RhBAHhjka+HdBI+6o3CXRHJoC47iav+QpR7u/wYl3gNq6MJO3MmTKqHegEDLjRN0
-  FJAr3bRAwq03ZtTuAVA2bdKLGThehe1RRRtJHJ/PHpmL2c203/GTXYtG6C8ILZIp
-  ZroTqQ8yglCJ+3hSOmodZqSAQ0Rj7GJgtuNH81qlSrHu5sTvoZjGmEqSIhvsSJ80
-  wKoPdZnFAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
-  BBSUnF478a5lB4xuOBiktJdMJv6JmDAfBgNVHREEGDAWgRRicm9va2VAYWxjaGVt
-  aXN0cy5pbzAfBgNVHRIEGDAWgRRicm9va2VAYWxjaGVtaXN0cy5pbzANBgkqhkiG
-  9w0BAQUFAAOCAQEAT7KtBXWsq1KA7NOSMeFEDeSvhrgdLwCG/37pIu0rjvx9iAW4
-  gncxV0MccqIUtaF+lekjlXkIO+rXAVjvdha23KtpFTW90dYXp4NLPnPlSdyvYzJy
-  FIAaWGvujOT8xEu4umd45q5aepE8li4bR071i5Z7F0trKNVYYrxjQFmH5SSKYRT/
-  fXtICtAh1de3z3SOSK58IMPwjuoApYBxiqlmx0Uhla7mrzCE5+NmLPit3hLH6JFK
-  aSif+qBc6oHD7EQWPF5cZkzkIURuwNwPBngZGxIKaMAgRhjGFXzUMAaq++r59cS9
-  xTfQ4k6fglKEgpnLAXiKdo2c8Ym+X4rIKFfedQ==
-  -----END CERTIFICATE-----
-date: 2015-11-28 00:00:00.000000000 Z
+cert_chain: []
+date: 2015-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor

checksums.yaml.gz.sig

@@ -1,3 +0,0 @@
-9�~i�+�n@���(�4J�a�(�8f�x\[d���^[�x�F+�����"}6BK��p�O
-M�G���RGĖ4*X���
-�^�n�T(�Pw;��+x*�_���������pP-r&�s��-��:/�v�p��Z/<�`{R�#����Fa��}���Cܘ

data.tar.gz.sig

@@ -1,3 +0,0 @@
-H3B2�б���qw������ܐ�Aq�N����Zir'����d�n����ì��/�
x	[ܫ^s���!C�g�K�NFv��~
-����s�e��孉0`�
'�
-�(��23&%[�P�����@��������E`�n4g��∬=I{Ro��a��+ʙ؏9�K�mP����͠lG/:v��\�#���/���'��F�D����nb�h��=a)�H�������o���4׉