gemsmith 1.5.0 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f099b61afd087c4dc64b7850b0d5f1d69130b11
+  data.tar.gz: d7078655ebcc3e7f4ae7528be679573a47fb638c
+SHA512:
+  metadata.gz: db87fed1447b0b7a73c93f8459c482faeed8f2e0d10872b412e1b2266013552d2d566eb213053b0618b7ee29f56ce6069010c3a5d59e34a88ff9e05a067efc02
+  data.tar.gz: e87478defe7ab4402bcc565db390d7bd139bf310592dbdf53427c808001d7ad0c366efed332c7324c7a1536c7fa0b74de8e32ebcfebd3c66b08c3d1a113b8b9a

data/CHANGELOG.rdoc

@@ -1,3 +1,19 @@
+= v2.0.0
+
+* Added Railtie best practices to README.
+* Added Guard support.
+* Converted/detailed the CONTRIBUTING guidelines per GitHub requirements.
+* Updated the contribution details in the README template to point to the CONTRIBUTING template.
+* Added spec focus capability.
+* Added Gem Badge support.
+* Added Code Climate support.
+* Added Campfire notification support.
+* Switched from HTTP to HTTPS when sourcing from RubyGems.
+* Added Pry support.
+* Cleaned up Guard gem dependency requirements.
+* Added Guard support to gem generation.
+* Upgraded to Ruby 2.0.0.
+
 = v1.5.0
 
 * Added auto-linking to GitHub Issues via README template.

data/README.rdoc

@@ -1,6 +1,8 @@
 = Overview
 
-{<img src="https://secure.travis-ci.org/bkuhlmann/gemsmith.png" />}[http://travis-ci.org/bkuhlmann/gemsmith]
+{<img src="https://badge.fury.io/rb/gemsmith.png" alt="Gem Version" />}[http://badge.fury.io/rb/gemsmith]
+{<img src="https://codeclimate.com/github/bkuhlmann/gemsmith.png" alt="Code Climate GPA" />}[https://codeclimate.com/github/bkuhlmann/gemsmith]
+{<img src="https://secure.travis-ci.org/bkuhlmann/gemsmith.png" alt="Travis CI Status" />}[http://travis-ci.org/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
@@ -11,8 +13,11 @@ 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 {Ruby on Rails}[http://rubyonrails.org] skeletons.
-* Supports RSpec[http://rspec.info] skeletons.
+* 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.
@@ -20,9 +25,9 @@ gem. Gemsmith is essentially an enhanced version of Bundler's gem building capab
 = Requirements
 
 1. A UNIX-based system.
-2. {Ruby 1.9.x}[http://www.ruby-lang.org]
-3. RubyGems[http://rubygems.org]
-4. Bundler[https://github.com/carlhuda/bundler]
+2. {Ruby 2.0.x}[http://www.ruby-lang.org].
+3. RubyGems[http://rubygems.org].
+4. Bundler[https://github.com/carlhuda/bundler].
 
 = Setup
 
@@ -53,7 +58,7 @@ If no options are configured, then the defaults are as follows:
   company_url: <author URL>
   github_user: <github user>
   year: <current year>
-  ruby_version: 1.9.0
+  ruby_version: 2.0.0
   rails_version: 3.2.0
 
 = Usage
@@ -68,12 +73,18 @@ 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.
-  -s, [--rspec]   # Add RSpec support.
-                  # Default: true
-  -t, [--travis]  # Add Travis CI support.
-                  # Default: true
+  -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
 
 Also, don't forget that once you have created your gem skeleton, the following rake tasks are also
 available to you via Bundler (i.e. rake -T):
@@ -87,7 +98,14 @@ available to you via Bundler (i.e. rake -T):
 1. {Best Practices While Cutting Gems}[http://rubysource.com/crafting-rubies-best-practices-while-cutting-gems].
 2. {Ruby on Rails Gem Packaging}[http://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices].
 3. {Why You Should Use a BSD Style License}[http://www.freebsd.org/doc/en/articles/bsdl-gpl/article.html].
-4. Ensure the RUBYOPT env variable includes the -w option. {Details}[http://avdi.org/devblog/2011/06/23/how-ruby-helps-you-fix-your-broken-code].
+4. Add -w to the RUBYOPT environment variable when testing. {Details}[http://avdi.org/devblog/2011/06/23/how-ruby-helps-you-fix-your-broken-code].
+
+== When To Include a Railtie (quoted from {Crafting Rails Applications}[http://pragprog.com/book/jvrails/crafting-rails-applications] - Page 93 by José Valim)
+
+* "Your gem needs to perform a given task while or after the Rails application is initialized."
+* "Your gem needs to change a configuration value, such as setting a generator."
+* "Your gem must provide Rake tasks and generators in nondefault locations (the default location for the former is lib/tasks and lib/gen- erators or lib/rails/generators for the latter)."
+* "You want your gem to provide configuration options to the appli- cation, such as config.my_gem.key = :value."
 
 = Tests
 
@@ -99,7 +117,7 @@ To test, do the following:
 
 = Contributions
 
-Please log all feedback/issues via {GitHub Issues}[https://github.com/bkuhlmann/gemsmith/issues]. Thanks.
+Read CONTRIBUTING for details.
 
 = Credits
 

data/lib/gemsmith/cli.rb

@@ -24,8 +24,11 @@ module Gemsmith
     map "-c" => :create
     method_option :bin, aliases: "-b", desc: "Add binary support.", type: :boolean, default: false
     method_option :rails, aliases: "-r", desc: "Add Rails support.", type: :boolean, default: false
+    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
     def create name
       say
       info "Creating gem..."
@@ -39,8 +42,9 @@ module Gemsmith
       
       # Default templates.
       template "README.rdoc.tmp", File.join(target_path, "README.rdoc"), template_options
-      template "CHANGELOG.rdoc.tmp", File.join(target_path, "CHANGELOG.rdoc"), template_options
+      template "CONTRIBUTING.md.tmp", File.join(target_path, "CONTRIBUTING.md"), template_options
       template "LICENSE.rdoc.tmp", File.join(target_path, "LICENSE.rdoc"), template_options
+      template "CHANGELOG.rdoc.tmp", File.join(target_path, "CHANGELOG.rdoc"), template_options
       template "Gemfile.tmp", File.join(target_path, "Gemfile"), template_options
       template "Rakefile.tmp", File.join(target_path, "Rakefile"), template_options
       template "gitignore.tmp", File.join(target_path, ".gitignore"), template_options
@@ -170,13 +174,16 @@ module Gemsmith
         company_url: (settings[:company_url] || author_url),
         github_user: (settings[:github_user] || Gemsmith::Kit.git_config_value("github.user") || "unknown"),
         year: (settings[:year] || Time.now.year),
-        ruby_version: (settings[:ruby_version] || "1.9.0"),
+        ruby_version: (settings[:ruby_version] || "2.0.0"),
         rails_version: (settings[:rails_version] || "3.0"),
         post_install_message: settings[:post_install_message],
         bin: (options[:bin] || false),
         rails: (options[:rails] || false),
+        pry: (options[:pry] || true),
+        guard: (options[:guard] || true),
         rspec: (options[:rspec] || true),
-        travis: (options[:travis] || true)
+        travis: (options[:travis] || true),
+        code_climate: (options[:code_climate] || true)
       }
     end
   end

data/lib/gemsmith/templates/CONTRIBUTING.md.tmp

@@ -0,0 +1,46 @@
+# Overview
+
+Thanks for taking an interest in this open source project. Your support
+and involvement is greatly appreciated.  The following details what you need to know
+in order to contribute back.
+
+# Requirements
+
+* Document the code - Explain the intent/purpose along with usage examples (where appropriate).
+* Write tests that demonstration passing and failing requirements.
+* Use two spaces, no tabs for indentation.
+* Remove trailing whitespace.
+* Remove spaces from blank lines.
+* Write methods as "example_method example_params", not "example_method(example_params)" for one-liners.
+* Write methods as "outer_method inner_method(example_params)" for nested method calls.
+* Use &&/|| instead of and/or where appropriate.
+* Define a = b instead of a=b.
+* In the end, follow the conventions found in the source code.
+* Use common sense, keep it simple.
+
+# Contributing Code (awesome option)
+
+1. Fork the repository (master branch).
+2. Ensure there are no setup issues (see README for details).
+3. Run the tests (see README for details).
+4. Add tests for new functionality (refactoring and documentation changes can be excluded).
+5. Ensure all tests pass.
+6. Push your fork and submit a pull request.
+
+# Contributing Issues (lazy, but sometimes necessary, option)
+
+1. Submit an issue via the GitHub Issues tab (assuming one does not already exist).
+2. Clearly describe the issue (including steps to reproduce).
+3. Specify your enviroment setup (OS, browser, language, etc. with version info).
+4. Provide a stack dump (if possible).
+5. Explain any additional details that might help diagnose the problem quickly.
+
+# Feedback
+
+Expect a response with one to three business days (normally responses are faster than mentioned).
+Changes, alternatives, and/or improvements might be suggested upon review.
+
+# Resources
+
+* [GitHub Documentation](http://help.github.com)
+* [GitHub Pull Request Documentation](http://help.github.com/send-pull-requests)

data/lib/gemsmith/templates/Gemfile.tmp

@@ -1,2 +1,2 @@
-source :rubygems
+source "https://rubygems.org"
 gemspec

data/lib/gemsmith/templates/README.rdoc.tmp

@@ -1,7 +1,11 @@
 = Overview
 
+{<img src="https://badge.fury.io/rb/<%= config[:gem_name] %>.png" alt="Gem Version" />}[http://badge.fury.io/rb/<%= config[:gem_name] %>]
+<%- if config[:code_climate] -%>
+{<img src="https://codeclimate.com/github/<%= config[:github_user] %>/<%= config[:gem_name] %>.png" alt="Code Climate GPA" />}[https://codeclimate.com/github/<%= config[:github_user] %>/<%= config[:gem_name] %>]
+<%- end -%>
 <%- if config[:travis] -%>
-{<img src="https://secure.travis-ci.org/<%= config[:github_user] %>/<%= config[:gem_name] %>.png" />}[http://travis-ci.org/<%= config[:github_user] %>/<%= config[:gem_name] %>]
+{<img src="https://secure.travis-ci.org/<%= config[:github_user] %>/<%= config[:gem_name] %>.png" alt="Travis CI Status" />}[http://travis-ci.org/<%= config[:github_user] %>/<%= config[:gem_name] %>]
 <%- end -%>
 
 = Features
@@ -38,7 +42,7 @@ To test, do the following:
 
 = Contributions
 
-Please log all feedback/issues via {GitHub Issues}[https://github.com/<%= config[:github_user] %>/<%= config[:gem_name] %>/issues]. Thanks.
+Read CONTRIBUTING for details.
 
 = Credits
 

data/lib/gemsmith/templates/gem.gemspec.tmp

@@ -27,12 +27,23 @@ Gem::Specification.new do |s|
   <%- if config[:travis] -%>
   s.add_development_dependency "rake"
 	<%- end -%>
+  <%- if config[:pry] -%>
+  s.add_development_dependency "pry"
+  s.add_development_dependency "pry-nav"
+  s.add_development_dependency "pry-stack_explorer"
+  s.add_development_dependency "pry-vterm_aliases"
+  <%- end -%>
   <%- if config[:rspec] -%>
   <%- rspec_gem = config[:rails] ? "rspec-rails" : "rspec" -%>
   s.add_development_dependency "<%= rspec_gem %>"
 	<%- end -%>
   <%- if config[:bin] -%>
-	s.add_development_dependency "aruba"
+  s.add_development_dependency "aruba"
+  <%- end -%>
+  <%- if config[:guard] -%>
+  s.add_development_dependency "rb-fsevent" # Guard file events for OSX.
+  s.add_development_dependency "rb-inotify" # Guard file events for Linux.
+  s.add_development_dependency "guard-rspec"
 	<%- end -%>
 	
   s.files            = Dir["lib/**/*", "vendor/**/*"]

data/lib/gemsmith/templates/spec/spec_helper.rb.tmp

@@ -1,5 +1,10 @@
 require "bundler/setup"
 require "<%= config[:gem_name] %>"
+<%- if config[:pry] -%>
+require "pry"
+<%- end -%>
 
 RSpec.configure do |config|
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
 end

data/lib/gemsmith/templates/travis.yml.tmp

@@ -1,7 +1,6 @@
 language: ruby
 rvm:
-  - 1.9.2
-  - 1.9.3
+  - 2.0.0
 <%- if config[:rails] -%>
 gemfile:
   - gemfiles/rails-3.0.x.gemfile

data/lib/gemsmith/version.rb

@@ -1,3 +1,3 @@
 module Gemsmith
-  VERSION = "1.5.0"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,97 +1,170 @@
 --- !ruby/object:Gem::Specification
 name: gemsmith
 version: !ruby/object:Gem::Version
-  version: 1.5.0
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-19 00:00:00.000000000 Z
+date: 2013-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: thor_plus
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-vterm_aliases
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aruba
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! 'Ruby gem skeleton generation for the professional gemsmith. Includes
+description: 'Ruby gem skeleton generation for the professional gemsmith. Includes
   custom settings, binary, Ruby on Rails, and RSpec support. '
 email: brooke@redalchemist.com
 executables:
@@ -104,13 +177,11 @@ extra_rdoc_files:
 files:
 - lib/gemsmith/cli.rb
 - lib/gemsmith/kit.rb
-- lib/gemsmith/templates/CHANGELOG.rdoc.tmp
-- lib/gemsmith/templates/Gemfile.tmp
-- lib/gemsmith/templates/LICENSE.rdoc.tmp
-- lib/gemsmith/templates/README.rdoc.tmp
-- lib/gemsmith/templates/Rakefile.tmp
 - lib/gemsmith/templates/bin/gem.tmp
+- lib/gemsmith/templates/CHANGELOG.rdoc.tmp
+- lib/gemsmith/templates/CONTRIBUTING.md.tmp
 - lib/gemsmith/templates/gem.gemspec.tmp
+- lib/gemsmith/templates/Gemfile.tmp
 - lib/gemsmith/templates/gemfiles/rails-3.0.x.gemfile.tmp
 - lib/gemsmith/templates/gemfiles/rails-3.1.x.gemfile.tmp
 - lib/gemsmith/templates/gemfiles/rails-3.2.x.gemfile.tmp
@@ -123,10 +194,13 @@ files:
 - lib/gemsmith/templates/lib/gem/cli.rb.tmp
 - lib/gemsmith/templates/lib/gem/version.rb.tmp
 - lib/gemsmith/templates/lib/gem.rb.tmp
-- lib/gemsmith/templates/lib/generators/gem/install/USAGE.tmp
 - lib/gemsmith/templates/lib/generators/gem/install/install_generator.rb.tmp
-- lib/gemsmith/templates/lib/generators/gem/upgrade/USAGE.tmp
+- lib/gemsmith/templates/lib/generators/gem/install/USAGE.tmp
 - lib/gemsmith/templates/lib/generators/gem/upgrade/upgrade_generator.rb.tmp
+- lib/gemsmith/templates/lib/generators/gem/upgrade/USAGE.tmp
+- lib/gemsmith/templates/LICENSE.rdoc.tmp
+- lib/gemsmith/templates/Rakefile.tmp
+- lib/gemsmith/templates/README.rdoc.tmp
 - lib/gemsmith/templates/rspec.tmp
 - lib/gemsmith/templates/spec/gem_spec.rb.tmp
 - lib/gemsmith/templates/spec/spec_helper.rb.tmp
@@ -140,26 +214,25 @@ files:
 homepage: http://www.redalchemist.com
 licenses:
 - MIT
-post_install_message: ! '(W): www.redalchemist.com. (T): @ralchemist.'
+metadata: {}
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ~>
     - !ruby/object:Gem::Version
-      version: 1.9.0
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby gem skeleton generation for the professional gemsmith.
 test_files: []