gemsmith 0.2.0 → 0.3.0

data/CHANGELOG.rdoc

@@ -1,3 +1,16 @@
+= v0.3.0
+
+* Added Best Practices section to the README.
+* Added the -e (edit) option for editing gem settings in default editor.
+* Added Thor utilities for info and error messaging.
+* Removed the classify and underscore methods since their equivalents are found in the Thor::Util class.
+* Removed the print_version method.
+* Added Rails generator USAGE documentation for the install and update generator templates.
+* Removed excess shell calls from the CLI template.
+* Added Thor::Actions to CLI class template.
+* Added "Built with Gemsmith" to README template.
+* Updated README template so that Gemfile mention is only provided when Rails is enabled.
+
 = v0.2.0
 
 * Fixed typo in upgrade generator doc.

data/README.rdoc

@@ -54,6 +54,7 @@ choose what options to define. Up to you. If no options are configured, then the
 From the command line, type: gemsmith help
 
   gemsmith -c, [create=GEM_NAME]  # Create new gem.
+  gemsmith -e, [edit]             # Edit gem settings in default editor (assumes $EDITOR environment variable).
   gemsmith -h, [help]             # Show this message.
   gemsmith -v, [version]          # Show version.
 
@@ -71,6 +72,10 @@ 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
 
+= Best Practices
+
+1. Ensure your RUBYOPT env variable includes the -w option. {Read the reasons why here}[http://avdi.org/devblog/2011/06/23/how-ruby-helps-you-fix-your-broken-code/].
+
 = Author
 
 {Red Alchemist}[http://www.redalchemist.com]

data/lib/gemsmith.rb

@@ -1,4 +1,5 @@
 require File.join File.dirname(__FILE__), "gemsmith", "version.rb"
+require File.join File.dirname(__FILE__), "gemsmith", "utilities.rb"
 
 module Gemsmith
   # Placeholder.

data/lib/gemsmith/cli.rb

@@ -5,8 +5,9 @@ require "thor/actions"
 module Gemsmith
   class CLI < Thor
     include Thor::Actions
+    include Gemsmith::Utilities
 
-    # Overwritten Thor template source root.
+    # Overwrites the Thor template source root.
     def self.source_root
       File.expand_path File.join(File.dirname(__FILE__), "templates")
     end
@@ -14,26 +15,22 @@ module Gemsmith
     # Initialize.
     def initialize args = [], options = {}, config = {}
       super
-      
-      # Defaults.
-      @shell = shell
       @settings_file = File.join ENV["HOME"], ".gemsmith", "settings.yml"
-
-      # Load and apply custom settings (if any).
       load_settings
     end
 
     desc "-c, [create=GEM_NAME]", "Create new gem."
     map "-c" => :create
-    method_option :bin, :aliases => "-b", :desc => "Adds binary support.", :type => :boolean, :default => false
-    method_option :rails, :aliases => "-R", :desc => "Adds Rails support.", :type => :boolean, :default => false
+    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 => "-r", :desc => "Add RSpec support.", :type => :boolean, :default => true
     def create name
-      shell.say "\nCreating gem..."
+      say
+      say_info "Creating gem..."
 
       # Initialize options.
-      gem_name = underscore name
-      gem_class = classify gem_name
+      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: Write full name here."
       author_url = @settings[:author_url] || "TODO: Write home page URL here."
       template_options = {
@@ -84,7 +81,9 @@ module Gemsmith
         # Generators
         empty_directory File.join(target_path, "lib", "generators", gem_name, "templates")
         template File.join("lib", "generators", "gem", "install", "install_generator.rb.tmp"), File.join(target_path, "lib", "generators", gem_name, "install", "install_generator.rb"), template_options
+        template File.join("lib", "generators", "gem", "install", "USAGE.tmp"), File.join(target_path, "lib", "generators", gem_name, "install", "USAGE"), template_options
         template File.join("lib", "generators", "gem", "upgrade", "upgrade_generator.rb.tmp"), File.join(target_path, "lib", "generators", gem_name, "upgrade", "upgrade_generator.rb"), template_options
+        template File.join("lib", "generators", "gem", "upgrade", "USAGE.tmp"), File.join(target_path, "lib", "generators", gem_name, "upgrade", "USAGE"), template_options
       end
 
       # RSpec (optional).
@@ -101,48 +100,29 @@ module Gemsmith
         `git commit -a -n -m "Gemsmith skeleton created."`
       end
       
-      shell.say "Gem created: #{gem_name}\n\n"
+      say_info "Gem created."
+      say
+    end
+    
+    desc "-e, [edit]", "Edit gem settings in default editor (assumes $EDITOR environment variable)."
+    map "-e" => :edit
+    def edit
+      `$EDITOR #{@settings_file}`
     end
 
     desc "-v, [version]", "Show version."
     map "-v" => :version
     def version
-      print_version
+      say "Gemsmith " + VERSION
     end
     
     desc "-h, [help]", "Show this message."
     def help task = nil
-      shell.say and super
+      say and super
     end
 
     private
 
-    # Transforms a camelcased string to an underscored equivalent (code stolen from the Ruby on Rails ActiveSupport underscore method).
-    # ==== Examples
-    # * "ExampleGem" -> "example_gem"
-    # * "SSLGem" -> "ssl_gem"
-    # ==== Parameters
-    # * +string+ - The string to underscore.
-    def underscore string
-      string = string.to_s.dup
-      string.gsub! /([A-Z]+)([A-Z][a-z])/, '\1_\2'
-      string.gsub! /([a-z\d])([A-Z])/, '\1_\2'
-      string.tr! "-", "_"
-      string.downcase
-     end
-     
-     # Transforms a lowercased/camelcased to a proper class name (code inspired by the Ruby on Rails ActiveSupport classify method).
-     # ==== Examples
-     # * "example" -> "example"
-     # * "my_cool_gem" -> "MyCoolGem"
-     # ==== Parameters
-     # * +string+ - The string to classify.
-     def classify string
-       string = string.to_s.dup
-       string.gsub!(/(^.{1}|_.)/) {$1.upcase}
-       string.tr '_', ''
-     end
-    
     # Load settings.
     def load_settings
       if File.exists? @settings_file
@@ -150,14 +130,9 @@ module Gemsmith
           settings = YAML::load_file @settings_file
           @settings = settings.reject {|key, value| value.nil?}
         rescue
-          shell.say "ERROR: Invalid settings: #{@settings_file}."
+          say_error "Invalid settings: #{@settings_file}."
         end
       end
     end
-    
-    # Print version information.
-    def print_version
-      shell.say "Gemsmith " + VERSION
-    end
   end
 end

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

@@ -11,11 +11,11 @@
 Type the following from the command line to install:
 
   gem install <%= config[:gem_name] %>
-
+<% if config[:rails] %>
 Add the following to your Gemfile:
 
   gem "<%= config[:gem_name] %>"
-
+<% end %>
 = Usage
 
 = Author
@@ -30,3 +30,4 @@ Read the LICENSE for details.
 = History
 
 Read the CHANGELOG for details.
+Built with Gemsmith[https://github.com/bkuhlmann/gemsmith].

data/lib/gemsmith/templates/lib/gem/cli.rb.tmp

@@ -1,8 +1,9 @@
-require "yaml"
 require "thor"
+require "thor/actions"
 
 module <%= config[:gem_class] %>
   class CLI < Thor
+  	include Thor::Actions
 
     # Initialize.
     def initialize args = [], options = {}, config = {}
@@ -12,19 +13,12 @@ module <%= config[:gem_class] %>
     desc "-v, [version]", "Show version."
     map "-v" => :version
     def version
-      print_version
+    	say "<%= config[:gem_class] %> " + VERSION
     end
     
     desc "-h, [help]", "Show this message."
     def help task = nil
-      shell.say and super
-    end
-
-    private
-
-    # Print version information.
-    def print_version
-      shell.say "<%= config[:gem_class] %> " + VERSION
+      say and super
     end
   end
 end

data/lib/gemsmith/templates/lib/generators/gem/install/USAGE.tmp

@@ -0,0 +1,8 @@
+Description:
+    Installs additional <%= config[:gem_class] %> resources.
+
+Example:
+    rails generate <%= config[:gem_name] %>:install
+
+    This will create:
+        what/will/it/create

data/lib/gemsmith/templates/lib/generators/gem/upgrade/USAGE.tmp

@@ -0,0 +1,8 @@
+Description:
+    Upgrades previously installed <%= config[:gem_class] %> resources.
+
+Example:
+    rails generate <%= config[:gem_name] %>:upgrade
+
+    This will create:
+        what/will/it/create

data/lib/gemsmith/utilities.rb

@@ -0,0 +1,14 @@
+module Gemsmith
+  # Additional utilities for the command line.
+  module Utilities
+    # Prints info to the console.
+    def say_info message
+      say_status :info, message, :white
+    end
+    
+    # Prints an error to the console.
+    def say_error message
+      say_status :error, message, :red
+    end
+  end
+end

data/lib/gemsmith/version.rb

@@ -1,3 +1,3 @@
 module Gemsmith
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gemsmith
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Brooke Kuhlmann
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-12 00:00:00 Z
+date: 2011-07-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thor
@@ -97,11 +97,14 @@ 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/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/upgrade/upgrade_generator.rb.tmp
 - lib/gemsmith/templates/rspec.tmp
 - lib/gemsmith/templates/spec/gem_spec.rb.tmp
 - lib/gemsmith/templates/spec/spec_helper.rb.tmp
+- lib/gemsmith/utilities.rb
 - lib/gemsmith/version.rb
 homepage: http://www.redalchemist.com
 licenses: []