gemsmith 1.1.0 → 1.2.0

data/CHANGELOG.rdoc

@@ -1,3 +1,12 @@
+= v1.2.0
+
+* Updated README and README template with new layout for test instructions.
+* Upgraded to Thor+ 0.2.0 and removed the settings_file, settings, and load_settings methods.
+* Added Why You Should Use a BSD license to the README Best Practices section.
+* Added the Best Practices While Cutting Gems to the Best Practices section of the README.
+* Added the ruby warning and encoding option formats to the binary template.
+* Removed the do block from RSpec template so that initial tests show pending instead of successful results.
+
 = v1.1.0
 
 * Fixed bug where args, options, and config were not being passed to super for CLI initialize for gem and gem template generation.

data/README.rdoc

@@ -16,9 +16,9 @@ gem. Gemsmith is essentially an enhanced version of Bundler's gem building capab
 
 = Requirements
 
-1. Basic understanding of gem building.
-2. A UNIX-based system.
-3. {Ruby 1.9.x}[http://www.ruby-lang.org]
+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]
 
 = Setup
@@ -77,20 +77,24 @@ available to you via Bundler (i.e. rake -T):
   rake install  # Build and install <gem>-<version>.gem into system gems
   rake release  # Create tag v0.1.1 and build and push <gem>-<version>.gem to Rubygems
 
-= Tests
+= Best Practices
 
-To test, change directory to the gem root and run:
+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].
 
-  bundle exec rspec spec
+= Tests
 
-= Best Practices
+To test, do the following:
 
-1. {Ruby on Rails Gem Packaging}[http://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices]
-2. 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/].
+1. cd to the gem root.
+2. bundle install
+3. bundle exec rspec spec
 
 = Contributions
 
-Please log all feedback/issues via {GitHub Issues}[https://github.com/bkuhlmann/gemsmith/issues] for the project. Thanks.
+Please log all feedback/issues via {GitHub Issues}[https://github.com/bkuhlmann/gemsmith/issues]. Thanks.
 
 = Credits
 

data/lib/gemsmith/cli.rb

@@ -16,7 +16,8 @@ module Gemsmith
     # Initialize.
     def initialize args = [], options = {}, config = {}
       super args, options, config
-      load_settings settings_file
+      @settings_file = File.join ENV["HOME"], ".gemsmith", "settings.yml"
+      @settings = load_yaml @settings_file
     end
 
     desc "-c, [create=GEM_NAME]", "Create new gem."
@@ -117,7 +118,7 @@ module Gemsmith
     desc "-e, [edit]", "Edit gem settings in default editor (assumes $EDITOR environment variable)."
     map "-e" => :edit
     def edit
-      `$EDITOR #{settings_file}`
+      `$EDITOR #{@settings_file}`
     end
 
     desc "-v, [version]", "Show version."
@@ -133,30 +134,6 @@ module Gemsmith
 
     private
 
-    # Answers the default settings file path.
-    def settings_file
-      @settings_file ||= File.join ENV["HOME"], ".gemsmith", "settings.yml"
-    end
-
-    # Load settings.
-    # ==== Parameters
-    # * +file+ - Required. The path to the settings (YAML) file.
-    def load_settings file
-      if file && File.exists?(file)
-        begin
-          settings = YAML::load_file file
-          @settings = settings.reject {|key, value| value.nil?}
-        rescue
-          error "Invalid settings: #{file}."
-        end
-      end
-    end
-
-    # Answers current settings.
-    def settings
-      @settings ||= {}
-    end
-    
     # Builds template options with default and/or custom settings (where the custom
     # settings trump default settings).
     # ==== Parameters
@@ -165,23 +142,23 @@ module Gemsmith
     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"
+      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: 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),
+        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]),

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

@@ -25,14 +25,16 @@ Add the following to your Gemfile:
 <%- if config[:rspec] -%>
 = Tests
 
-To test, change directory to the gem root and run:
+To test, do the following:
 
-  bundle exec rspec spec
+1. cd to the gem root.
+2. bundle install
+3. bundle exec rspec spec
 <%- end -%>
 
 = Contributions
 
-Please log all feedback/issues via GitHub Issues for the project. Thanks.
+Please log all feedback/issues via GitHub Issues. Thanks.
 
 = Credits
 

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

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

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

@@ -1,6 +1,5 @@
 require "spec_helper"
 
 describe "<%= config[:gem_class] %>" do
-	it "should be tested" do
-	end
+	it "should be tested"
 end

data/lib/gemsmith/version.rb

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

data/spec/settings_spec.rb

@@ -4,28 +4,26 @@ describe "Settings" do
   before :each do
     # Default settings.
     class Gemsmith::CLI
-      private
-      def settings_file
-        nil
+      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
-      private
-      def settings_file
-        File.join File.dirname(__FILE__), "support", "settings.yml"
+      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 be empty" do
-      @cli_default.send(:settings).should be_empty
-    end
-    
     it "should build defaults" do
       author_name = `git config user.name`.chomp || "TODO: Add full name here."
       author_url = "https://www.unknown.com"

metadata

@@ -1,70 +1,68 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: gemsmith
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.2.0
   prerelease: 
-  version: 1.1.0
 platform: ruby
-authors: 
+authors:
 - Brooke Kuhlmann
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-20 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: thor
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70133761355280 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.14.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: thor_plus
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70133761355280
+- !ruby/object:Gem::Dependency
+  name: thor_plus
+  requirement: &70133761354820 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.1.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70133761354820
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70133761354440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: aruba
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70133761354440
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: &70133761384180 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-description: "Ruby gem skeleton generation for the professional gemsmith. Includes custom settings, binary, Ruby on Rails, and RSpec support. "
+  prerelease: false
+  version_requirements: *70133761384180
+description: ! 'Ruby gem skeleton generation for the professional gemsmith. Includes
+  custom settings, binary, Ruby on Rails, and RSpec support. '
 email: brooke@redalchemist.com
-executables: 
+executables:
 - gemsmith
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - CHANGELOG.rdoc
@@ -104,33 +102,32 @@ files:
 - spec/spec_helper.rb
 - spec/support/settings.yml
 homepage: http://www.redalchemist.com
-licenses: 
+licenses:
 - MIT
-post_install_message: "(W): www.redalchemist.com. (T): @ralchemist."
-rdoc_options: 
+post_install_message: ! '(W): www.redalchemist.com. (T): @ralchemist.'
+rdoc_options:
 - CHANGELOG.rdoc
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
+  requirements:
   - - ~>
-    - !ruby/object:Gem::Version 
+    - !ruby/object:Gem::Version
       version: 1.9.0
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.13
 signing_key: 
 specification_version: 3
 summary: Ruby gem skeleton generation for the professional gemsmith.
-test_files: 
+test_files:
 - spec/settings_spec.rb
 - spec/spec_helper.rb
 - spec/support/settings.yml