gemsmith 1.2.0 → 1.3.0

data/CHANGELOG.rdoc

@@ -1,3 +1,18 @@
+= v1.3.0
+
+* Specified Thor+ 0.2.x version dependency.
+* Added Travis CI support.
+* Added Travis CI template support (can be disable via your settings.yml or during new gem creation).
+* Added the spec/tmp directory to the gitignore template.
+* Added Gemsmith::Kit class with a supplementary utility method for obtaining .gitconfig values.
+* Added github user support - Defaults to github config file or settings.yml.
+* Updated RSpec format to better represent class and instance methods.
+* Removed the -w option from gem binary and the binary template.
+* No longer shell out to Git when referencing the gem/template files in gemspecs - This increases Rails boot performance.
+* Switched Gemfile and Gemfile.tmp reference from "http://rubygems.org" to :rubygems.
+* Moved documentation files to the extra_rdoc_files option for gem specifications
+* Removed the packaging of test files.
+
 = v1.2.0
 
 * Updated README and README template with new layout for test instructions.

data/README.rdoc

@@ -1,5 +1,7 @@
 = Overview
 
+{<img src="https://secure.travis-ci.org/bkuhlmann/gemsmith.png" />}[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
 gem. Gemsmith is essentially an enhanced version of Bundler's gem building capabilities.
@@ -7,10 +9,11 @@ gem. Gemsmith is essentially an enhanced version of Bundler's gem building capab
 = Features
 
 * Builds a gem skeleton with Bundler functionality in mind.
-* Allows for common settings that can be applied to new gem creations.
+* 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] test skeletons.
+* Supports RSpec[http://rspec.info] skeletons.
+* 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.
 
@@ -48,10 +51,10 @@ If no options are configured, then the defaults are as follows:
   gem_url: <author URL>
   company_name: <author name>
   company_url: <author URL>
+  github_user: <github user>
   year: <current year>
   ruby_version: 1.9.0
   rails_version: 3.1.0
-  post_install_message: nil
 
 = Usage
 
@@ -65,10 +68,12 @@ 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
+  -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
 
 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):

data/bin/gemsmith

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby -w
+#!/usr/bin/ruby
 # encoding: UTF-8
 
 require "gemsmith"

data/lib/gemsmith.rb

@@ -1 +1,2 @@
 require File.join File.dirname(__FILE__), "gemsmith", "version.rb"
+require File.join File.dirname(__FILE__), "gemsmith", "kit.rb"

data/lib/gemsmith/cli.rb

@@ -25,12 +25,13 @@ module Gemsmith
     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 :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
     def create name
       say
       info "Creating gem..."
-
+      
       # Initialize options.
-      template_options = build_template_options name, options
+      template_options = build_template_options name, @settings, options
       gem_name = template_options[:gem_name]
 
       # Configure templates.
@@ -77,6 +78,11 @@ module Gemsmith
         template File.join("spec", "spec_helper.rb.tmp"), File.join(target_path, "spec", "spec_helper.rb"), template_options
         template File.join("spec", "gem_spec.rb.tmp"), File.join(target_path, "spec", "#{gem_name}_spec.rb"), template_options
       end
+
+      # Travis CI (optional).
+      if template_options[:travis]
+        template "travis.yml.tmp", File.join(target_path, ".travis.yml"), template_options
+      end
       
       # Git
       Dir.chdir(target_path) do
@@ -137,31 +143,34 @@ module Gemsmith
     # Builds template options with default and/or custom settings (where the custom
     # settings trump default settings).
     # ==== Parameters
-    # * +name+ - Required. The gem name.
-    # * +options+ - Optional. Additional command line options. Default: {}
-    def build_template_options name, options = {}
-      gem_name = Thor::Util.snake_case name
-      gem_class = Thor::Util.camel_case name
-      author_name = @settings[:author_name] || `git config user.name`.chomp || "TODO: Add full name here."
-      author_email = @settings[:author_email] || `git config user.email`.chomp || "TODO: Add email address here."
-      author_url = @settings[:author_url] || "https://www.unknown.com"
+    # * +gem_name+ - Required. The gem name.
+    # * +settings+ - Optional. The custom settings. Default: {}.
+    # * +options+ - Optional. Additional command line options. Default: {}.
+    def build_template_options gem_name, settings = {}, options = {}
+      gem_name = Thor::Util.snake_case gem_name
+      gem_class = Thor::Util.camel_case gem_name
+      author_name = settings[:author_name] || Gemsmith::Kit.git_config_value("user.name") || "TODO: Add full name here."
+      author_email = settings[:author_email] || Gemsmith::Kit.git_config_value("user.email") || "TODO: Add email address here."
+      author_url = settings[:author_url] || "https://www.unknown.com"
       {
         gem_name: gem_name,
         gem_class: gem_class,
-        gem_platform: (@settings[:gem_platform] || "Gem::Platform::RUBY"),
+        gem_platform: (settings[:gem_platform] || "Gem::Platform::RUBY"),
         author_name: author_name,
         author_email: author_email,
         author_url: (author_url || "http://www.unknown.com"),
-        gem_url: (@settings[:gem_url] || author_url),
-        company_name: (@settings[:company_name] || author_name),
-        company_url: (@settings[:company_url] || author_url),
-        year: (@settings[:year] || Time.now.year),
-        ruby_version: (@settings[:ruby_version] || "1.9.0"),
-        rails_version: (@settings[:rails_version] || "3.1.0"),
-        post_install_message: @settings[:post_install_message],
+        gem_url: (settings[:gem_url] || author_url),
+        company_name: (settings[:company_name] || author_name),
+        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"),
+        rails_version: (settings[:rails_version] || "3.1.0"),
+        post_install_message: settings[:post_install_message],
         bin: (options[:bin] || false),
         rails: (options[:rails] || false),
-        rspec: (options[:rspec].nil? ? true : options[:rspec]),
+        rspec: (options[:rspec] || true),
+        travis: (options[:travis] || true)
       }
     end
   end

data/lib/gemsmith/kit.rb

@@ -0,0 +1,12 @@
+module Gemsmith
+  # Provides supplementary utility methods.
+  class Kit
+    # Answers the git config (i.e. ~/.gitconfig) value for a given key, otherwise nil.
+    # ==== Parameters
+    # # * +key+ - Required. The git config key to search for.
+    def self.git_config_value key
+      value = `git config #{key}`.chomp
+      value.nil? || value.empty? ? nil : value
+    end
+  end
+end

data/lib/gemsmith/templates/Gemfile.tmp

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

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

@@ -1,5 +1,9 @@
 = Overview
 
+<%- 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] %>]
+<%- end -%>
+
 = Features
 
 = Requirements

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

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby -w
+#!/usr/bin/ruby
 # encoding: UTF-8
 
 require "<%= config[:gem_name] %>"

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

@@ -16,7 +16,6 @@ Gem::Specification.new do |s|
 	s.post_install_message	= "<%= config[:post_install_message] %>"
 	<%- end -%>
 
-  s.rdoc_options << "CHANGELOG.rdoc"
 	s.required_ruby_version = "~> <%= config[:ruby_version] %>"
   <%- if config[:bin] -%>
 	s.add_dependency "thor"
@@ -25,18 +24,20 @@ Gem::Specification.new do |s|
   <%- if config[:rails] -%>
 	s.add_dependency "rails", "~> <%= config[:rails_version] %>"
 	<%- end -%>
+  <%- if config[:travis] -%>
+	s.add_development_dependency "rake"
+	<%- end -%>
   <%- if config[:rspec] -%>
 	s.add_development_dependency "rspec"
 	<%- end -%>
   <%- if config[:bin] -%>
 	s.add_development_dependency "aruba"
 	<%- end -%>
+
+  s.files            = Dir["lib/**/*"]
+  s.extra_rdoc_files = Dir["README*", "CHANGELOG*", "LICENSE*"]
   <%- if config[:bin] -%>
-	s.executables << "<%= config[:gem_name] %>"
+	s.executables      << "<%= config[:gem_name] %>"
 	<%- end -%>
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map {|f| File.basename f}
-  s.require_paths = ["lib"]
+  s.require_paths    = ["lib"]
 end

data/lib/gemsmith/templates/gitignore.tmp

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+spec/tmp

data/lib/gemsmith/templates/rspec.tmp

@@ -1,2 +1,2 @@
 --color
---format documentation
+--format documentation

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

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+script: bundle exec rspec spec

data/lib/gemsmith/version.rb

@@ -1,3 +1,3 @@
 module Gemsmith
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemsmith
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-02 00:00:00.000000000Z
+date: 2012-01-14 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70133761355280 !ruby/object:Gem::Requirement
+  requirement: &70314477299460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,21 +21,32 @@ dependencies:
         version: 0.14.0
   type: :runtime
   prerelease: false
-  version_requirements: *70133761355280
+  version_requirements: *70314477299460
 - !ruby/object:Gem::Dependency
   name: thor_plus
-  requirement: &70133761354820 !ruby/object:Gem::Requirement
+  requirement: &70314477299000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70133761354820
+  version_requirements: *70314477299000
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70314477298620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70314477298620
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70133761354440 !ruby/object:Gem::Requirement
+  requirement: &70314477298160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70133761354440
+  version_requirements: *70314477298160
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &70133761384180 !ruby/object:Gem::Requirement
+  requirement: &70314477297740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,26 +65,20 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70133761384180
+  version_requirements: *70314477297740
 description: ! 'Ruby gem skeleton generation for the professional gemsmith. Includes
   custom settings, binary, Ruby on Rails, and RSpec support. '
 email: brooke@redalchemist.com
 executables:
 - gemsmith
 extensions: []
-extra_rdoc_files: []
-files:
-- .gitignore
-- .rspec
+extra_rdoc_files:
+- README.rdoc
 - CHANGELOG.rdoc
-- Gemfile
 - LICENSE.rdoc
-- README.rdoc
-- Rakefile
-- bin/gemsmith
-- gemsmith.gemspec
-- lib/gemsmith.rb
+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
@@ -82,7 +87,6 @@ files:
 - lib/gemsmith/templates/bin/gem.tmp
 - lib/gemsmith/templates/gem.gemspec.tmp
 - lib/gemsmith/templates/gitignore.tmp
-- lib/gemsmith/templates/lib/gem.rb.tmp
 - lib/gemsmith/templates/lib/gem/action_controller/class_methods.rb.tmp
 - lib/gemsmith/templates/lib/gem/action_controller/instance_methods.rb.tmp
 - lib/gemsmith/templates/lib/gem/action_view/instance_methods.rb.tmp
@@ -90,6 +94,7 @@ files:
 - lib/gemsmith/templates/lib/gem/active_record/instance_methods.rb.tmp
 - 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
@@ -97,16 +102,18 @@ files:
 - lib/gemsmith/templates/rspec.tmp
 - lib/gemsmith/templates/spec/gem_spec.rb.tmp
 - lib/gemsmith/templates/spec/spec_helper.rb.tmp
+- lib/gemsmith/templates/travis.yml.tmp
 - lib/gemsmith/version.rb
-- spec/settings_spec.rb
-- spec/spec_helper.rb
-- spec/support/settings.yml
+- lib/gemsmith.rb
+- README.rdoc
+- CHANGELOG.rdoc
+- LICENSE.rdoc
+- bin/gemsmith
 homepage: http://www.redalchemist.com
 licenses:
 - MIT
 post_install_message: ! '(W): www.redalchemist.com. (T): @ralchemist.'
-rdoc_options:
-- CHANGELOG.rdoc
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -127,7 +134,4 @@ rubygems_version: 1.8.13
 signing_key: 
 specification_version: 3
 summary: Ruby gem skeleton generation for the professional gemsmith.
-test_files:
-- spec/settings_spec.rb
-- spec/spec_helper.rb
-- spec/support/settings.yml
+test_files: []

data/.gitignore

@@ -1,4 +0,0 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*

data/.rspec

@@ -1,2 +0,0 @@
---color
---format documentation

data/Gemfile

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

data/Rakefile

@@ -1 +0,0 @@
-require 'bundler/gem_tasks'

data/gemsmith.gemspec

@@ -1,30 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "gemsmith/version"
-
-Gem::Specification.new do |s|
-  s.name                  = "gemsmith"
-  s.version               = Gemsmith::VERSION
-  s.platform              = Gem::Platform::RUBY
-  s.author                = "Brooke Kuhlmann"
-  s.email                 = "brooke@redalchemist.com"
-  s.homepage              = "http://www.redalchemist.com"
-  s.summary               = "Ruby gem skeleton generation for the professional gemsmith."
-  s.description           = "Ruby gem skeleton generation for the professional gemsmith. Includes custom settings, binary, Ruby on Rails, and RSpec support. "
-  s.license               = "MIT"
-  s.post_install_message	= "(W): www.redalchemist.com. (T): @ralchemist."
-
-  s.rdoc_options << "CHANGELOG.rdoc"
-  s.required_ruby_version = "~> 1.9.0"
-  s.add_dependency "thor", "~> 0.14.0"
-  s.add_dependency "thor_plus", ">= 0.1.0"
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "aruba"
-  s.executables << "gemsmith"
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-end
-

data/spec/settings_spec.rb

@@ -1,69 +0,0 @@
-require "spec_helper"
-
-describe "Settings" do
-  before :each do
-    # Default settings.
-    class Gemsmith::CLI
-      def initialize
-        super
-        @settings_file = File.join File.dirname(__FILE__), "support", "settings.yml"
-        @settings = {}
-      end
-    end
-    @cli_default = Gemsmith::CLI.new
-
-    # Custom settings.
-    class Gemsmith::CLI
-      def initialize
-        super
-        @settings_file = File.join File.dirname(__FILE__), "support", "settings.yml"
-        @settings = load_yaml @settings_file
-      end
-    end
-    @cli_custom = Gemsmith::CLI.new
-  end
-  
-  context "Load" do
-    it "should build defaults" do
-      author_name = `git config user.name`.chomp || "TODO: Add full name here."
-      author_url = "https://www.unknown.com"
-      options = @cli_default.send :build_template_options, "test"
-      options[:gem_name].should be == "test"
-      options[:gem_class].should be == "Test"
-      options[:gem_platform].should be == "Gem::Platform::RUBY"
-      options[:author_name].should be == author_name
-      options[:author_email].should be == (`git config user.email`.chomp || "TODO: Add email address here.")
-      options[:author_url].should be == author_url
-      options[:gem_url].should be == "https://www.unknown.com"
-      options[:company_name].should be == author_name
-      options[:company_url].should be == author_url
-      options[:year].should be == Time.now.year
-      options[:ruby_version].should be == "1.9.0"
-      options[:rails_version].should be == "3.1.0"
-      options[:post_install_message].should be == nil
-      options[:bin].should be_false
-      options[:rails].should be_false
-      options[:rspec].should be_true
-    end
-    
-    it "should be custom" do
-      options = @cli_custom.send :build_template_options, "test"
-      options[:gem_name].should be == "test"
-      options[:gem_class].should be == "Test"
-      options[:gem_platform].should be == "Gem::Platform::CURRENT"
-      options[:author_name].should be == "Testy Tester"
-      options[:author_email].should be == "test@test.com"
-      options[:author_url].should be == "https://www.test.com"
-      options[:gem_url].should be == "https://www.gem.com"
-      options[:company_name].should be == "ACME"
-      options[:company_url].should be == "https://www.acme.com"
-      options[:year].should be == 1920
-      options[:ruby_version].should be == "1.8.0"
-      options[:rails_version].should be == "2.3.0"
-      options[:post_install_message].should be == "Follow @tester on Twitter for more info."
-      options[:bin].should be_false
-      options[:rails].should be_false
-      options[:rspec].should be_true
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,3 +0,0 @@
-require "bundler/setup"
-require "gemsmith"
-require File.join "gemsmith", "cli"

data/spec/support/settings.yml

@@ -1,12 +0,0 @@
---- 
-:gem_platform: Gem::Platform::CURRENT
-:author_name: "Testy Tester"
-:author_email: "test@test.com"
-:author_url: "https://www.test.com"
-:gem_url: "https://www.gem.com"
-:company_name: "ACME"
-:company_url: "https://www.acme.com"
-:year: 1920
-:ruby_version: 1.8.0
-:rails_version: 2.3.0
-:post_install_message: "Follow @tester on Twitter for more info."