gemsmith 2.4.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fdd006f550a4e31a4ad659194efbbc64dfbae75f
-  data.tar.gz: 11738811bb63aec5ac10e81d7bd6c7284a6d439c
+  metadata.gz: 84a491143e9618a2c16fe353a1f10289e4c7a3b1
+  data.tar.gz: 4b780c701602dcff1ff14657beb8745c1790e28d
 SHA512:
-  metadata.gz: e203671e5e4ce164bb32497fbb0d03675d5885906145ce092419fda66e7a06719e7eacb4b8b9fc8bc032ba08613ba2d9e997bcac8b55db393d251c2289d0b53c
-  data.tar.gz: 03fd924777d7102e15461a87c5a415d428163d38be510bd02b57218ef6e31610a1516266384344d4e9897243fef16beacabcb421922db26102b1f312e6749ef5
+  metadata.gz: 6ca5bc323bb417612a1ff81b37340a2897a12de76343122208902f7cff99d555dcdd8bee57c5c53c49a77aad476b5856d074a4ee8567247df9f9bc6dca0a52a5
+  data.tar.gz: e8d4c75dbfe4cb4a84e1189fff4101c150affd13ba47560f58c158d582f334d4b8fccf75b1023340cc37514ed07edb53ae88e95852107e9d2182521cda516155

data/README.md

@@ -2,7 +2,9 @@
 
 [![Gem Version](https://badge.fury.io/rb/gemsmith.png)](http://badge.fury.io/rb/gemsmith)
 [![Code Climate GPA](https://codeclimate.com/github/bkuhlmann/gemsmith.png)](https://codeclimate.com/github/bkuhlmann/gemsmith)
+[![Gemnasium Status](https://gemnasium.com/bkuhlmann/gemsmith.png)](https://gemnasium.com/bkuhlmann/gemsmith)
 [![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/gemsmith.png)](http://travis-ci.org/bkuhlmann/gemsmith)
+[![Coverage Status](https://coveralls.io/repos/bkuhlmann/gemsmith/badge.png)](https://coveralls.io/r/bkuhlmann/gemsmith)
 
 Gemsmith allows you to easily craft new gems via the command line with custom settings (if desired). If you are
 a fan of [Bundler](https://github.com/carlhuda/bundler), then you'll appreciate the additional capabilities of this
@@ -12,15 +14,18 @@ gem. Gemsmith is essentially an enhanced version of Bundler's gem building capab
 
 * Builds a gem skeleton with Bundler functionality in mind.
 * Supports common settings that can be applied to new gem creations.
-* Supports binary skeletons with [Thor](https://github.com/wycats/thor) command line functionality.
+* Supports [Thor](https://github.com/wycats/thor) command line functionality.
 * Supports [Ruby on Rails](http://rubyonrails.org).
 * Supports [RSpec](http://rspec.info).
 * Supports [Pry](http://pryrepl.org).
 * Supports [Guard](https://github.com/guard/guard).
 * Supports [Code Climate](https://codeclimate.com).
-* Supports [Travis CI](http://travis-ci.org) skeletons.
-* Adds commonly needed README, CHANGELOG, LICENSE, etc. template files.
-* Provides the ability to open any installed gem within your favorite editor.
+* Supports [Gemnasium](https://gemnasium.com).
+* Supports [Travis CI](http://travis-ci.org).
+* Supports [Coveralls](https://coveralls.io).
+* 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, CHANGELOG, CONTRIBUTING, LICENSE, etc. template files.
 
 # Requirements
 
@@ -37,7 +42,7 @@ gem. Gemsmith is essentially an enhanced version of Bundler's gem building capab
 For a secure install, type the following from the command line (recommended):
 
     gem cert --add <(curl -Ls http://www.redalchemist.com/gem-public.pem)
-    gem install gemsmith -P HighSecurity
+    gem install gemsmith --trust-policy HighSecurity
 
 ...or, for an insecure install, type the following (not recommended):
 
@@ -58,6 +63,8 @@ You can configure common settings for future gem builds by creating the followin
 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
@@ -68,7 +75,7 @@ If no options are configured, then the defaults are as follows:
     year: <current year>
     ruby_version: 2.0.0
     ruby_patch: p0
-    rails_version: 3.2.0
+    rails_version: 4.0
 
 # Usage
 
@@ -83,18 +90,22 @@ From the command line, type: gemsmith help
 
 For more gem creation options, type: gemsmith help create
 
-    -b, [--bin]           # Add binary support.
-    -r, [--rails]         # Add Rails support.
-    -p, [--pry]           # Add Pry support.
-                          # Default: true
-    -g, [--guard]         # Add Guard support.
-                          # Default: true
-    -s, [--rspec]         # Add RSpec support.
-                          # Default: true
-    -t, [--travis]        # Add Travis CI support.
-                          # Default: true
-    -c, [--code-climate]  # Add Code Climate support.
-                          # Default: true
+    -b, [--bin], [--no-bin]                    # Add binary support.
+    -r, [--rails], [--no-rails]                # Add Rails support.
+    -p, [--pry], [--no-pry]                    # Add Pry support.
+                                               # Default: true
+    -g, [--guard], [--no-guard]                # Add Guard support.
+                                               # Default: true
+    -s, [--rspec], [--no-rspec]                # Add RSpec support.
+                                               # Default: true
+    -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
+    -C, [--coveralls], [--no-coveralls]        # Add Coveralls support.
+                                               # Default: true
 
 Once a gem skeleton has been created, the following tasks are available within the project via Bundler (i.e. rake -T):
 
@@ -112,12 +123,15 @@ To test, do the following:
 
 # Security
 
-To creat a certificate for your gems, run the following:
+To create a certificate for your gems, run the following:
 
     cd ~/.ssh
     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.
+
 To learn more about gem certificates, read the following:
 
 * [Ruby Gems](http://guides.rubygems.org/security/#building_gems)

data/lib/gemsmith/cli.rb

@@ -40,8 +40,10 @@ module Gemsmith
     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 :travis, aliases: "-t", desc: "Add Travis CI 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 :coveralls, aliases: "-C", desc: "Add Coveralls support.", type: :boolean, default: true
     def create name
       say
       info "Creating gem..."

data/lib/gemsmith/cli_options.rb

@@ -18,6 +18,8 @@ module Gemsmith
         gem_class: gem_class,
         gem_platform: gem_platform,
         gem_url: gem_url,
+        gem_private_key: gem_private_key,
+        gem_public_key: gem_public_key,
         author_name: author_name,
         author_email: author_email,
         author_url: author_url,
@@ -34,8 +36,10 @@ module Gemsmith
         pry: default_boolean(:pry, true),
         guard: default_boolean(:guard, true),
         rspec: default_boolean(:rspec, true),
+        code_climate: default_boolean(:code_climate, true),
+        gemnasium: default_boolean(:gemnasium, true),
         travis: default_boolean(:travis, true),
-        code_climate: default_boolean(:code_climate, true)
+        coveralls: default_boolean(:coveralls, true)
       }
     end
 
@@ -47,6 +51,14 @@ module Gemsmith
       @settings[:gem_url] || author_url
     end
 
+    def gem_private_key
+      @settings.fetch :gem_private_key, "~/.ssh/gem-private.pem"
+    end
+
+    def gem_public_key
+      @settings.fetch :gem_public_key, "~/.ssh/gem-public.pem"
+    end
+
     def author_name
       @settings[:author_name] || Gemsmith::Kit.git_config_value("user.name") || "TODO: Add full name here."
     end
@@ -84,7 +96,7 @@ module Gemsmith
     end
 
     def rails_version
-      @settings[:rails_version] || "3.0"
+      @settings[:rails_version] || "4.0"
     end
 
     def default_boolean key, value = false

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

@@ -1,62 +1,82 @@
 $:.push File.expand_path("../lib", __FILE__)
 require "<%=config[:gem_name]%>/version"
 
+def add_security_key specification, method, files
+  file = files.is_a?(Array) ? files.first : files
+  if File.exists? file
+    specification.send "#{method}=", files
+  else
+    puts "WARNING: Security key not found for #{specification.name} gem specification: #{file}"
+  end
+end
+
 Gem::Specification.new do |s|
-  s.name									= "<%= config[:gem_name] %>"
-  s.version								= <%= config[:gem_class] %>::VERSION
-  s.platform							= <%= config[:gem_platform] %>
-  s.author								= "<%= config[:author_name] %>"
-  s.email									= "<%= config[:author_email] %>"
-  s.homepage							= "<%= config[:gem_url] %>"
-  s.summary								= "TODO: Add gem summary here."
-  s.description						= "TODO: Add gem description here."
-	s.license								= "MIT"
+  s.name = "<%= config[:gem_name] %>"
+  s.version = <%= config[:gem_class] %>::VERSION
+  s.platform = <%= config[:gem_platform] %>
+  s.author = "<%= config[:author_name] %>"
+  s.email = "<%= config[:author_email] %>"
+  s.homepage = "<%= config[:gem_url] %>"
+  s.summary = "TODO: Add gem summary here."
+  s.description = "TODO: Add gem description here."
+  s.license = "MIT"
   <%- if config[:post_install_message] -%>
-	s.post_install_message	= "<%= config[:post_install_message] %>"
-	<%- end -%>
+  s.post_install_message	= "<%= config[:post_install_message] %>"
+  <%- end -%>
 
-  unless ENV["TRAVIS"]
-    s.signing_key = File.expand_path("~/.ssh/gem-private.pem")
-    s.cert_chain  = [File.expand_path("~/.ssh/gem-public.pem")]
+  add_security_key s, "signing_key", File.expand_path("<%= config[:gem_private_key] %>")
+  add_security_key s, "cert_chain", [File.expand_path("<%= config[:gem_public_key] %>")]
+
+  <%- if config[:pry] -%>
+  case Gem.ruby_engine
+    when "ruby"
+      s.add_development_dependency "pry-byebug"
+      s.add_development_dependency "pry-stack_explorer"
+    when "jruby"
+      s.add_development_dependency "pry-nav"
+    when "rbx"
+      s.add_development_dependency "pry-nav"
+      s.add_development_dependency "pry-stack_explorer"
+    else
+      raise RuntimeError.new("Unsupported Ruby Engine!")
   end
+  <%- end -%>
 
-	s.required_ruby_version = "~> <%= config[:ruby_version] %>"
+  s.required_ruby_version = "~> <%= config[:ruby_version] %>"
   <%- if config[:bin] -%>
-	s.add_dependency "thor"
-	s.add_dependency "thor_plus"
-	<%- end -%>
+  s.add_dependency "thor"
+  s.add_dependency "thor_plus"
+  <%- end -%>
   <%- if config[:rails] -%>
-	s.add_dependency "rails", "~> <%= config[:rails_version] %>"
-	<%- end -%>
+  s.add_dependency "rails", "~> <%= config[:rails_version] %>"
+  <%- end -%>
   <%- if config[:travis] -%>
   s.add_development_dependency "rake"
-	<%- end -%>
+  <%- end -%>
   <%- if config[:pry] -%>
   s.add_development_dependency "pry"
-  s.add_development_dependency "pry-byebug"
   s.add_development_dependency "pry-remote"
   s.add_development_dependency "pry-rescue"
-  s.add_development_dependency "pry-stack_explorer"
-  s.add_development_dependency "pry-vterm_aliases"
-  s.add_development_dependency "pry-git"
-  s.add_development_dependency "pry-doc"
   <%- end -%>
   <%- if config[:rspec] -%>
   <%- rspec_gem = config[:rails] ? "rspec-rails" : "rspec" -%>
   s.add_development_dependency "<%= rspec_gem %>"
-	<%- end -%>
+  <%- end -%>
   <%- if config[:bin] -%>
   s.add_development_dependency "aruba"
   <%- end -%>
   <%- if config[:guard] -%>
   s.add_development_dependency "rb-fsevent" # Guard file events for OSX.
   s.add_development_dependency "guard-rspec"
-	<%- end -%>
+  <%- end -%>
+  <%- if config[:coveralls] -%>
+  s.add_development_dependency "coveralls"
+  <%- end -%>
 
-  s.files            = Dir["lib/**/*", "vendor/**/*"]
+  s.files = Dir["lib/**/*", "vendor/**/*"]
   s.extra_rdoc_files = Dir["README*", "LICENSE*"]
   <%- if config[:bin] -%>
-	s.executables      << "<%= config[:gem_name] %>"
-	<%- end -%>
-  s.require_paths    = ["lib"]
+  s.executables << "<%= config[:gem_name] %>"
+  <%- end -%>
+  s.require_paths = ["lib"]
 end

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

@@ -4,9 +4,15 @@
 <%- if config[:code_climate] -%>
 [![Code Climate GPA](https://codeclimate.com/github/<%= config[:github_user] %>/<%= config[:gem_name] %>.png)](https://codeclimate.com/github/<%= config[:github_user] %>/<%= config[:gem_name] %>)
 <%- end -%>
+<%- if config[:gemnasium] -%>
+[![Gemnasium Status](https://gemnasium.com/<%= config[:github_user] %>/<%= config[:gem_name] %>.png)](https://gemnasium.com/<%= config[:github_user] %>/<%= config[:gem_name] %>)
+<%- end -%>
 <%- if config[:travis] -%>
 [![Travis CI Status](https://secure.travis-ci.org/<%= config[:github_user] %>/<%= config[:gem_name] %>.png)](http://travis-ci.org/<%= config[:github_user] %>/<%= config[:gem_name] %>)
 <%- end -%>
+<%- if config[:coveralls] -%>
+[![Coveralls Status](https://coveralls.io/repos/<%= config[:github_user] %>/<%= config[:gem_name] %>/badge.png)](https://coveralls.io/r/<%= config[:github_user] %>/<%= config[:gem_name] %>)
+<%- end -%>
 
 # Features
 
@@ -18,7 +24,12 @@
 
 # Setup
 
-Type the following from the command line to install:
+For a secure install, type the following from the command line (recommended):
+
+    gem cert --add <(curl -Ls http://www.my-website.com/gem-public.pem)
+    gem install <%= config[:gem_name] %> --trust-policy HighSecurity
+
+...or, for an insecure install, type the following (not recommended):
 
     gem install <%= config[:gem_name] %>
 

data/lib/gemsmith/templates/%gem_name%/spec/spec_helper.rb.tt

@@ -2,13 +2,28 @@ require "bundler/setup"
 require "<%= config[:gem_name] %>"
 <%- if config[:pry] -%>
 require "pry"
-require "pry-byebug"
 require "pry-remote"
 require "pry-rescue"
-require "pry-stack_explorer"
-require "pry-vterm_aliases"
-require "pry-git"
-require "pry-doc"
+<%- end -%>
+<%- if config[:coveralls] -%>
+require "coveralls"
+<%- end -%>
+
+<%- if config[:pry] -%>
+case Gem.ruby_engine
+  when "ruby"
+    require "pry-byebug"
+    require "pry-stack_explorer"
+  when "jruby"
+    require "pry-nav"
+  when "rbx"
+    require "pry-nav"
+    require "pry-stack_explorer"
+end
+<%- end -%>
+
+<%- if config[:coveralls] -%>
+Coveralls.wear!
 <%- end -%>
 
 RSpec.configure do |config|

data/lib/gemsmith/version.rb

@@ -1,3 +1,3 @@
 module Gemsmith
-  VERSION = "2.4.0"
+  VERSION = "3.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemsmith
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -30,7 +30,7 @@ cert_chain:
   SJpzzzZ8gO6BKn4fhd+ENNQ333Qy3nuNk07TVIaNnlgeHhowUDuD9T7Z8Lka0pt3
   4PteiTppsf0SSVAM9zSO5IuFngXMRwWgvjOfXE70f43RDuUVTCSyylc=
   -----END CERTIFICATE-----
-date: 2014-02-16 00:00:00.000000000 Z
+date: 2014-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -145,7 +145,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-vterm_aliases
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -159,7 +159,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -173,7 +173,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rb-fsevent
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -187,7 +187,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="