gemsmith 0.1.0 → 0.2.0

data/CHANGELOG.rdoc

@@ -1,3 +1,20 @@
+= v0.2.0
+
+* Fixed typo in upgrade generator doc.
+* Fixed README typo with command line options.
+* Added Ruby on Rails skeleton generation support.
+* Added RSpec skeleton generation support.
+* Added a cli.rb template with basic Thor setup for binary skeletons.
+* Added binary executable name to gemspec template for binary skeletons.
+* Added gem dependencies to gemspec template for binary and RSpec skeletons.
+* Added proper support for underscoring/camelcasing gem names and classes during skeleton generation.
+* Added common setup options to the README template.
+* Added Ruby on Rails requirements to the README template (only if the Rails options is used).
+* Added Ruby on Rails generator templates for installs and upgrades.
+* Added Git initialization, addition, and first commit message of all skeleton files during gem creation.
+* Updated the gem description.
+* Updated the documentation to include Bundler rake tasks.
+
 = v0.1.0
 
 * Initial version.

data/README.rdoc

@@ -6,12 +6,17 @@ command then you'll enjoy this gem since it is essentially an enhanced version o
 
 = Features
 
-* Common custom settings that you can configure once and use for every new gem that you build.
-* Additional skeleton files such as a README, CHANGELOG, and LICENCE (which you pretty much always need).
+* Builds a gem skeleton with Bundler functionality in mind.
+* Allows for common settings that you can configure once and use for every new gem that you build.
+* 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.
+* Adds commonly needed README, CHANGELOG, LICENSE, etc. template files.
 
 = Requirements
 
-* A desire to develop professional gems.
+* Bundler[https://github.com/carlhuda/bundler]
+* Basic familiarity with gem building.
 
 = Setup
 
@@ -34,8 +39,8 @@ simply create the following file:
   :company_name: Red Alchmist
   :company_url: http://www.redalchemist.com 
 
-NOTE: All of the options above are optional. You don't have to create the setting.yml at all or you can pick and
-choose what you want to define. Up to you. If you don't specify any settings then everything defaults as follows:
+NOTE: All options above are optional. You don't have to create the setting.yml at all or you can pick and
+choose what options to define. Up to you. If no options are configured, then the default options are as follows:
 
   gem_platform: Gem::Platform::RUBY
   author_name: <git user name>
@@ -46,15 +51,25 @@ choose what you want to define. Up to you. If you don't specify any settings the
 
 = Usage
 
-From the command line, type: tweeter help
+From the command line, type: gemsmith help
 
   gemsmith -c, [create=GEM_NAME]  # Create new gem.
   gemsmith -h, [help]             # Show this message.
   gemsmith -v, [version]          # Show version.
 
-For more gem creation options, type: tweeter help create
+For more gem creation options, type: gemsmith help create
 
-  -b, [--bin]  # Add binary to gem build.
+  -r, [--rspec]  # Add RSpec support.
+                 # Default: true
+  -b, [--bin]    # Adds binary support.
+  -R, [--rails]  # Adds Rails support.
+
+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):
+
+  rake build    # Build <gem>-<version>.gem into the pkg directory
+  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
 
 = Author
 

data/gemsmith.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Brooke Kuhlmann"]
   s.email       = ["brooke@redalchemist.com"]
   s.homepage    = "http://www.redalchemist.com"
-  s.summary     = "Craft new gems with custom settings."
-  s.description = "Craft new gems with custom settings and reduce setup redundancy."
+  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.rdoc_options << "CHANGELOG.rdoc"
   s.add_dependency "thor", "~> 0.14.0"

data/lib/gemsmith/cli.rb

@@ -25,13 +25,15 @@ module Gemsmith
 
     desc "-c, [create=GEM_NAME]", "Create new gem."
     map "-c" => :create
-    method_option :bin, :aliases => "-b", :desc => "Add binary to gem build.", :type => :boolean, :default => false
+    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 :rspec, :aliases => "-r", :desc => "Add RSpec support.", :type => :boolean, :default => true
     def create name
       shell.say "\nCreating gem..."
 
       # Initialize options.
-      gem_name = name.downcase
-      gem_class = gem_name.capitalize
+      gem_name = underscore name
+      gem_class = classify gem_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 = {
@@ -43,12 +45,16 @@ module Gemsmith
         :author_url => author_url,
         :company_name => (@settings[:company_name] || author_name),
         :company_url => (@settings[:company_url] || author_url),
-        :year => Time.now.year
+        :year => Time.now.year,
+        :bin => options[:bin],
+        :rails => options[:rails],
+        :rspec => options[:rspec]
       }
 
-      # Apply templates.
+      # Configure templates.
       target_path = File.join Dir.pwd, gem_name
-      empty_directory File.join(target_path, "lib", gem_name)
+      
+      # 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 "LICENSE.rdoc.tmp", File.join(target_path, "LICENSE.rdoc"), template_options
@@ -58,8 +64,41 @@ module Gemsmith
       template "gem.gemspec.tmp", File.join(target_path, "#{gem_name}.gemspec"), template_options
       template File.join("lib", "gem.rb.tmp"), File.join(target_path, "lib", "#{gem_name}.rb"), template_options
       template File.join("lib", "gem", "version.rb.tmp"), File.join(target_path, "lib", gem_name, "version.rb"), template_options
+      
+      # Binary (optional).
       if options[:bin]
         template File.join("bin", "gem.tmp"), File.join(target_path, "bin", gem_name), template_options
+        template File.join("lib", "gem", "cli.rb.tmp"), File.join(target_path, "lib", gem_name, "cli.rb"), template_options
+      end
+
+      # Ruby on Rails (optional).
+      if options[:rails]
+        # ActionController
+        template File.join("lib", "gem", "action_controller", "class_methods.rb.tmp"), File.join(target_path, "lib", gem_name, "action_controller", "class_methods.rb"), template_options
+        template File.join("lib", "gem", "action_controller", "instance_methods.rb.tmp"), File.join(target_path, "lib", gem_name, "action_controller", "instance_methods.rb"), template_options
+        # ActionView
+        template File.join("lib", "gem", "action_view", "instance_methods.rb.tmp"), File.join(target_path, "lib", gem_name, "action_view", "instance_methods.rb"), template_options
+        # ActiveRecord
+        template File.join("lib", "gem", "active_record", "class_methods.rb.tmp"), File.join(target_path, "lib", gem_name, "active_record", "class_methods.rb"), template_options
+        template File.join("lib", "gem", "active_record", "instance_methods.rb.tmp"), File.join(target_path, "lib", gem_name, "active_record", "instance_methods.rb"), template_options
+        # 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", "upgrade", "upgrade_generator.rb.tmp"), File.join(target_path, "lib", "generators", gem_name, "upgrade", "upgrade_generator.rb"), template_options
+      end
+
+      # RSpec (optional).
+      if options[:rspec]
+        template "rspec.tmp", File.join(target_path, ".rspec"), template_options
+        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
+      
+      # Git
+      Dir.chdir(target_path) do
+        `git init`
+        `git add .`
+        `git commit -a -n -m "Gemsmith skeleton created."`
       end
       
       shell.say "Gem created: #{gem_name}\n\n"
@@ -77,6 +116,32 @@ module Gemsmith
     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

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

@@ -3,9 +3,19 @@
 = Features
 
 = Requirements
-
+<% if config[:rails] %>
+1. {Ruby on Rails}[http://rubyonrails.org].
+<% end %>
 = Setup
 
+Type the following from the command line to install:
+
+  gem install <%= config[:gem_name] %>
+
+Add the following to your Gemfile:
+
+  gem "<%= config[:gem_name] %>"
+
 = Usage
 
 = Author

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

@@ -13,9 +13,10 @@ Gem::Specification.new do |s|
   s.description = "TODO: Write gem description."
 
   s.rdoc_options << "CHANGELOG.rdoc"
-  # s.add_dependency "thor", "~> 1.0.0"
-  # s.add_development_dependency "some_gem"
-  # s.executables << "gemsmith"
+  <% if config[:bin] %>s.add_dependency "thor"<% end %>
+  <% if config[:rspec] %>s.add_development_dependency "rspec"<% end %>
+  <% if config[:bin] %>s.add_development_dependency "aruba"<% end %>
+  <% if config[:bin] %>s.executables << "<%= config[:gem_name] %>"<% end %>
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")

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

@@ -1,5 +1,33 @@
+# Dependencies
 require File.join File.dirname(__FILE__), "<%= config[:gem_name] %>", "version.rb"
+<% if config[:rails] %>
+require File.join File.dirname(__FILE__), "<%= config[:gem_name] %>", "active_record", "class_methods.rb"
+require File.join File.dirname(__FILE__), "<%= config[:gem_name] %>", "active_record", "instance_methods.rb"
+require File.join File.dirname(__FILE__), "<%= config[:gem_name] %>", "action_view", "instance_methods.rb"
+require File.join File.dirname(__FILE__), "<%= config[:gem_name] %>", "action_controller", "class_methods.rb"
+require File.join File.dirname(__FILE__), "<%= config[:gem_name] %>", "action_controller", "instance_methods.rb"
+<% end %>
 
+# Namespace
 module <%= config[:gem_class] %>
   # Placeholder.
 end
+<% if config[:rails] %>
+# Rails Enhancements
+if defined? Rails
+  # Model
+  if defined? ActiveRecord
+    ActiveRecord::Base.send :include, <%= config[:gem_class] %>::ActiveRecord
+  end
+
+  # View
+  if defined? ActionView
+    ActionView::Base.send :include, <%= config[:gem_class] %>::InstanceMethods
+  end
+ 
+  # Controller
+  if defined? ActionController
+    ActionController::Base.send :include, <%= config[:gem_class] %>::ActionController
+  end
+end
+<% end %>

data/lib/gemsmith/templates/lib/gem/action_controller/class_methods.rb.tmp

@@ -0,0 +1,18 @@
+module <%= config[:gem_class] %>
+  module ActionController
+    def self.included base
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+			# TODO - Rename the method name to your liking.
+      def is_<%= config[:gem_name] %>_enhanced options = {}
+        self.send :include, InstanceMethods
+        
+        # Default Options
+        class_inheritable_reader :<%= config[:gem_name] %>_options
+        write_inheritable_attribute :<%= config[:gem_name] %>_options
+      end
+    end
+  end
+end

data/lib/gemsmith/templates/lib/gem/action_controller/instance_methods.rb.tmp

@@ -0,0 +1,7 @@
+module <%= config[:gem_class] %>
+  module ActionController
+    module InstanceMethods
+			# TODO - Write some code.
+    end
+  end
+end

data/lib/gemsmith/templates/lib/gem/action_view/instance_methods.rb.tmp

@@ -0,0 +1,7 @@
+module <%= config[:gem_class] %>
+  module ActionView
+    module InstanceMethods
+			# TODO - Write some code.
+    end
+  end
+end

data/lib/gemsmith/templates/lib/gem/active_record/class_methods.rb.tmp

@@ -0,0 +1,18 @@
+module <%= config[:gem_class] %>
+  module ActiveRecord
+    def self.included base
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+			# TODO - Rename the method name to your liking.
+      def is_<%= config[:gem_name] %>_enhanced options = {}
+        self.send :include, InstanceMethods
+        
+        # Default Options
+        class_inheritable_reader :<%= config[:gem_name] %>_options
+        write_inheritable_attribute :<%= config[:gem_name] %>_options
+      end
+    end
+  end
+end

data/lib/gemsmith/templates/lib/gem/active_record/instance_methods.rb.tmp

@@ -0,0 +1,7 @@
+module <%= config[:gem_class] %>
+  module ActiveRecord
+    module InstanceMethods
+			# TODO - Write some code.
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+require "yaml"
+require "thor"
+
+module <%= config[:gem_class] %>
+  class CLI < Thor
+
+    # Initialize.
+    def initialize args = [], options = {}, config = {}
+      super
+    end
+
+    desc "-v, [version]", "Show version."
+    map "-v" => :version
+    def version
+      print_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
+    end
+  end
+end

data/lib/gemsmith/templates/lib/generators/gem/install/install_generator.rb.tmp

@@ -0,0 +1,20 @@
+module <%= config[:gem_class] %>
+  class InstallGenerator < Rails::Generators::Base
+    desc "Installs additional <%= config[:gem_class] %> resources."
+
+    # Override the default source path by pulling from a shared templates directory for all generators.
+    def self.source_root
+      @source_root ||= File.join(File.dirname(__FILE__), "..", "templates")
+    end
+
+    # Let others know about you.
+    def self.banner
+      "rails generate <%= config[:gem_name] %>:install"
+    end
+
+    # TODO - Explain yourself.
+    def copy_files
+      # TODO - Add your fancy/schmancy install code here.
+    end
+  end
+end

data/lib/gemsmith/templates/lib/generators/gem/upgrade/upgrade_generator.rb.tmp

@@ -0,0 +1,20 @@
+module <%= config[:gem_class] %>
+  class UpgradeGenerator < Rails::Generators::Base
+    desc "Upgrades previously installed <%= config[:gem_class] %> resources."
+
+    # Override the default source path by pulling from a shared templates directory for all generators.
+    def self.source_root
+      @source_root ||= File.join(File.dirname(__FILE__), "..", "templates")
+    end
+
+    # Let others know about you.
+    def self.banner
+      "rails generate <%= config[:gem_name] %>:upgrade"
+    end
+
+    # TODO - Explain yourself.
+    def copy_files
+      # TODO - Add your fancy/schmancy upgrade code here.
+    end
+  end
+end

data/lib/gemsmith/templates/rspec.tmp

@@ -0,0 +1 @@
+--color

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

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

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

@@ -0,0 +1,6 @@
+require "rubygems"
+require "bundler/setup"
+require "<%= config[:gem_name] %>"
+
+RSpec.configure do |config|
+end

data/lib/gemsmith/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gemsmith
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Brooke Kuhlmann
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-05 00:00:00 Z
+date: 2011-06-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thor
@@ -61,7 +61,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
-description: Craft new gems with custom settings and reduce setup redundancy.
+description: "Ruby gem skeleton generation for the professional gemsmith. Includes custom settings, binary, Ruby on Rails, and RSpec support. "
 email: 
 - brooke@redalchemist.com
 executables: 
@@ -90,7 +90,18 @@ files:
 - 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
+- lib/gemsmith/templates/lib/gem/active_record/class_methods.rb.tmp
+- 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/install_generator.rb.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/version.rb
 homepage: http://www.redalchemist.com
 licenses: []
@@ -121,9 +132,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.4
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
-summary: Craft new gems with custom settings.
+summary: Ruby gem skeleton generation for the professional gemsmith.
 test_files: []