kelredd-simple-gem 0.5.0

data/README.rdoc

@@ -0,0 +1,54 @@
+= SimpleGem
+
+== Description
+
+SimpleGem is a gem to help quickly generate a ruby gem project ready to build, test, and deploy. 
+
+== Installation
+
+    sudo gem install kelredd-simple-gem --source=http://gems.github.com
+    
+== Usage
+
+    $ simple-gem my-gem
+    
+This will create a gem structure under the './my-gem'.  The command is pretty forgiving with the name you supply, it will automatically transform anything that is camelcased into something more ruby-like.  If you have an existing gem structure, it will just add/overwrite where necessary and not remove anything.
+
+After generating your gem, go ahead and add information about your gem to both the <tt>Rakefile</tt> and <tt>README.rdoc</tt> files.  The default version number is "0.1.0", but if you want to change that, take a look at <tt>lib/my_gem/version.rb</tt> to make the change - this will automatically be picked up when you rebuild your gem.
+
+Your new gem provides some Rake tasks for convenience:
+
+* <tt>rake gem</tt> - Build the gem and drop it into the <tt>pkg/</tt> directory for installation.
+* <tt>rake test</tt> - The default test task, it will run the tests in <tt>test</tt>. If this is a newly-created gem, your tests will flunk.
+* <tt>rake features</tt> - a rake task to run any cucumber features you have defined.
+* <tt>rake gemspec</tt> - Generate <tt>my_gem.gemspec</tt> file to use if you're serving your gem (via Github or your own server).
+
+That's it. Enjoy.
+
+== Credit
+Many thanks to Patrick Reagan (mailto:reaganpr@gmail.com) who is the original author of this gem.  The source and credit is largely his.  I simply forked his source on Github and extended it for my purposes.  The original source can be found here: http://github.com/reagent/simple-gem/tree/master.  
+
+== License
+
+Copyright (c) 2008-2009 Kelly Redding (mailto: kelly@kelredd.com) and Patrick Reagan (mailto:reaganpr@gmail.com)
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+require 'lib/simple_gem/version'
+
+task :default => :test
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'simple-gem'
+  s.version          = SimpleGem::Version.to_s
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README.rdoc)
+  s.rdoc_options     = %w(--main README.rdoc)
+  s.summary          = "A gem to help quickly generate a ruby gem project ready to build, test, and deploy."
+  s.author           = 'Kelly Redding (and Patrick Reagan)'
+  s.email            = 'kelly@kelredd.com'
+  s.homepage         = 'http://github.com/kelredd/simple-gem'
+  s.executables      = ['simple-gem']
+  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib,templates}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc 'Generate the gemspec to serve this Gem from Github'
+task :gemspec do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end

data/bin/simple-gem

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'simple_gem/gem'
+
+if ARGV[0]
+  gem = SimpleGem::Gem.new(`pwd`.strip, ARGV[0])
+  gem.generate
+else
+  puts "Please specify a name for your gem"
+end

data/lib/simple_gem.rb

@@ -0,0 +1,2 @@
+require 'simple_gem/version'
+require 'simple_gem/gem'

data/lib/simple_gem/gem.rb

@@ -0,0 +1,64 @@
+require 'erb'
+
+module SimpleGem
+  class Gem
+    
+    attr_reader :root_path, :name
+    
+    def initialize(path, name)
+      @root_path = path
+      self.name = name
+    end
+    
+    def name=(name)
+      @name = name.gsub(/([A-Z])([a-z])/, '_\1\2').sub(/^_/, '').downcase
+    end
+    
+    def module_name
+      transform_name {|part| part.capitalize }
+    end
+    
+    def ruby_name
+      transform_name('_') {|part| part.downcase }
+    end
+
+    def generate
+      generate_root_directory
+      generate_subdirectories
+      generate_file('gitignore.erb', '.gitignore')
+      generate_file('lib.rb.erb', "lib/#{self.ruby_name}.rb")
+      generate_file('lib_version.rb.erb', "lib/#{self.ruby_name}/version.rb")
+      generate_file('Rakefile.erb', 'Rakefile')
+      generate_file('README.rdoc.erb', 'README.rdoc')
+      generate_file('test_helper.rb.erb', 'test/test_helper.rb')
+      generate_file('test.rb.erb', "test/unit/#{self.ruby_name}_test.rb")
+      generate_file('feature.feature.erb', "test/features/#{self.ruby_name}.feature")
+      generate_file('feature_steps.rb.erb', "test/features/step_definitions/#{self.ruby_name}_steps.rb")
+      generate_file('feature_env.rb.erb', "test/features/step_definitions/support/env.rb")
+    end
+    
+    private
+    def transform_name(glue = nil, &block)
+      self.name.split(/[_-]/).map {|part| block.call(part) }.join(glue)
+    end
+    
+    def generate_root_directory
+      FileUtils.mkdir_p("#{self.root_path}/#{self.name}")
+    end
+    
+    def generate_subdirectories
+      ["lib/#{self.ruby_name}", 'test/unit', 'test/features/step_definitions/support'].each do |dir|
+        FileUtils.mkdir_p("#{self.root_path}/#{self.name}/#{dir}")
+      end
+    end
+    
+    def generate_file(source, output)
+      source_file = File.dirname(__FILE__) + "/../../templates/#{source}"
+      output_file = "#{self.root_path}/#{self.name}/#{output}"
+      
+      erb = ERB.new(File.read(source_file))
+      File.open(output_file, 'w') {|f| f << erb.result(binding) }
+    end
+    
+  end
+end

data/lib/simple_gem/version.rb

@@ -0,0 +1,13 @@
+module SimpleGem
+  module Version
+    
+    MAJOR = 0
+    MINOR = 5
+    TINY  = 0
+    
+    def self.to_s
+      [MAJOR, MINOR, TINY].join('.')
+    end
+    
+  end
+end

data/templates/README.rdoc.erb

@@ -0,0 +1,38 @@
+= <%= self.module_name %>
+
+== Description
+
+Describe your gem here ... 
+
+== Installation
+
+    sudo gem install <%= self.name %>
+
+== Usage
+
+    require '<%= self.ruby_name %>'
+
+== License
+
+Copyright (c) <year> <copyright holders>
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/templates/Rakefile.erb

@@ -0,0 +1,63 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+require 'lib/<%= self.ruby_name %>/version'
+
+spec = Gem::Specification.new do |s|
+  s.name             = '<%= self.name %>'
+  s.version          = <%= self.module_name %>::Version.to_s
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README.rdoc)
+  s.rdoc_options     = %w(--main README.rdoc)
+  s.summary          = "This gem does ... "
+  s.author           = 'First Last'
+  s.email            = 'user@example.com'
+  s.homepage         = 'http://my-site.net'
+  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib}/**/*")
+  # s.executables    = ['<%= self.name %>']
+  
+  # s.add_dependency('gem_name', '~> 0.0.1')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+
+  Rcov::RcovTask.new(:coverage) do |t|
+    t.libs       = ['test']
+    t.test_files = FileList["test/**/*_test.rb"]
+    t.verbose    = true
+    t.rcov_opts  = ['--text-report', "-x #{Gem.path}", '-x /Library/Ruby', '-x /usr/lib/ruby']
+  end
+  
+  task :default => :coverage
+  
+rescue LoadError
+  warn "\n**** Install rcov (sudo gem install relevance-rcov) to get coverage stats ****\n"
+  task :default => :test
+end
+
+
+desc 'Generate the gemspec to serve this Gem from Github'
+task :gemspec do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end
+
+require 'cucumber'
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "test/features --format pretty" 
+end

data/templates/feature.feature.erb

@@ -0,0 +1,4 @@
+Feature: <%= self.module_name %>
+  In order to test this gem
+  As a requirer of this gem
+  I want to ensure this gem behaves as expected

data/templates/feature_env.rb.erb

@@ -0,0 +1,6 @@
+require 'test/unit/assertions'
+World(Test::Unit::Assertions)
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'lib', '<%= self.ruby_name %>.rb'))
+
+# TODO: setup your feature environment here

data/templates/feature_steps.rb.erb

@@ -0,0 +1 @@
+# TODO: define any pending feature steps here

data/templates/gitignore.erb

@@ -0,0 +1,4 @@
+/pkg/
+/doc/
+/coverage/
+*.log

data/templates/lib.rb.erb

@@ -0,0 +1,3 @@
+$:.unshift File.dirname(__FILE__)
+
+# require '<%= self.ruby_name %>/...'

data/templates/lib_version.rb.erb

@@ -0,0 +1,13 @@
+module <%= self.module_name %>
+  module Version
+    
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+    
+    def self.to_s # :nodoc:
+      [MAJOR, MINOR, TINY].join('.')
+    end
+    
+  end
+end

data/templates/test.rb.erb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class <%= self.module_name %>Test < Test::Unit::TestCase
+
+  describe "An instance of the <%= self.module_name %> class" do
+
+    it "should flunk" do
+      flunk "Please provide some tests"
+    end
+    
+  end
+
+end

data/templates/test_helper.rb.erb

@@ -0,0 +1,6 @@
+# http://sneaq.net/textmate-wtf
+$:.reject! { |e| e.include? 'TextMate' }
+
+require 'rubygems'
+
+require File.dirname(__FILE__) + '/../lib/<%= self.ruby_name %>'

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: kelredd-simple-gem
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Kelly Redding (and Patrick Reagan)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-28 00:00:00 -07:00
+default_executable: simple-gem
+dependencies: []
+
+description: 
+email: kelly@kelredd.com
+executables: 
+- simple-gem
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/simple_gem
+- lib/simple_gem/gem.rb
+- lib/simple_gem/version.rb
+- lib/simple_gem.rb
+- templates/feature.feature.erb
+- templates/feature_env.rb.erb
+- templates/feature_steps.rb.erb
+- templates/gitignore.erb
+- templates/lib.rb.erb
+- templates/lib_version.rb.erb
+- templates/Rakefile.erb
+- templates/README.rdoc.erb
+- templates/test.rb.erb
+- templates/test_helper.rb.erb
+- bin/simple-gem
+has_rdoc: true
+homepage: http://github.com/kelredd/simple-gem
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: A gem to help quickly generate a ruby gem project ready to build, test, and deploy.
+test_files: []
+