reagent-simple-gem 0.1.1

data/README.markdown

@@ -0,0 +1,59 @@
+# SimpleGem
+
+## Description
+
+Creating RubyGems is fun work, but dealing with the complexity of hoe / bones / newgem is not (for me, at least).  SimpleGem is a way to quickly create a gem structure with the bare minimum needed to build and deploy. 
+
+## Installation
+
+Ideally:
+
+    sudo gem install reagent-simple-gem --source=http://gems.github.com
+    
+But GitHub doesn't seem to consistently build gems, so use this as a fallback:
+
+    $ git clone git://github.com/reagent/simple-gem.git
+    $ cd simple-gem
+    $ rake gem
+    $ sudo gem install pkg/simple-gem-x.x.x.gem
+    
+## Usage
+
+    $ simple-gem my-gem
+    
+This will create a gem structure under the 'my-gem' directory.  The command is pretty forgiving with the name you supply, it will automatically transform anything that is camelcased into something more ruby-like.
+
+After generating your gem, go ahead and add information about your gem to both the `Rakefile` and `README.markdown` files.  The default version number is "0.1.0", but if you want to change that, take a look at `lib/my_gem/version.rb` to make the change - this will automatically be picked up when you rebuild your gem.
+
+Your new gem provides some Rake tasks for convenience:
+
+* `rake gem` - Build the gem and drop it into the `pkg/` directory for installation.
+* `rake test` - The default test task, it will run the tests in `test`. If this is a newly-created gem, your tests will flunk.
+* `rake github` - Generate `my_gem.gemspec` file to use if you're serving your gem from GitHub (requires flagging your GitHub project as a rubygem).
+
+That's it. Enjoy.
+
+## License
+
+Copyright (c) 2008 Patrick Reagan (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,37 @@
+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.markdown)
+  s.summary          = "Make gems. Simple."
+  s.author           = 'Patrick Reagan'
+  s.email            = 'reaganpr@gmail.com'
+  s.homepage         = 'http://sneaq.net'
+  s.executables      = ['simple-gem']
+  s.files            = %w(README.markdown Rakefile) + Dir.glob("{lib,test,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 :github 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,59 @@
+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('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.markdown.erb', 'README.markdown')
+      generate_file('test.rb.erb', "test/#{self.ruby_name}_test.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("#{self.root_path}/#{self.name}")
+    end
+    
+    def generate_subdirectories
+      ['lib', 'test', "lib/#{self.ruby_name}"].each do |dir|
+        FileUtils.mkdir("#{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 = 1
+    TINY  = 1
+    
+    def self.to_s
+      [MAJOR, MINOR, TINY].join('.')
+    end
+    
+  end
+end

data/templates/README.markdown.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,39 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+require 'lib/<%= self.ruby_name %>/version'
+
+task :default => :test
+
+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.markdown)
+  s.summary          = "This gem does ... "
+  s.author           = 'First Last'
+  s.email            = 'user@example.com'
+  s.homepage         = 'http://my-site.net'
+  s.files            = %w(README.markdown Rakefile) + Dir.glob("{lib,test}/**/*")
+  # 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
+
+desc 'Generate the gemspec to serve this Gem from Github'
+task :github do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end

data/templates/lib.rb.erb

@@ -0,0 +1 @@
+# 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
+      [MAJOR, MINOR, TINY].join('.')
+    end
+    
+  end
+end

data/templates/test.rb.erb

@@ -0,0 +1,9 @@
+require 'test/unit'
+
+class <%= self.module_name %>Test < Test::Unit::TestCase
+
+  def test_truth
+    flunk "Please provide some tests"
+  end
+
+end

data/test/simple_gem/gem_test.rb

@@ -0,0 +1,104 @@
+require 'rubygems'
+require 'context'
+require 'matchy'
+
+require File.dirname(__FILE__) + '/../../lib/simple_gem/gem'
+
+module SimpleGem
+  class GemTest < Test::Unit::TestCase
+
+    def self.should_generate(expectations)
+      describe "An instance of Gem when given a #{expectations[:from]} name" do
+        before do
+          path = '/this/path'
+          @name = expectations[:from]
+          @gem = Gem.new(path, @name)
+        end
+
+        expectations.each do |k,v|
+          unless k == :from
+            it "should know its #{k}" do
+              @gem.send(k).should == v
+            end
+          end
+        end
+      end
+    end
+
+    should_generate :name        => 'simple_gem', 
+    :module_name => 'SimpleGem', 
+    :ruby_name   => 'simple_gem', 
+    :from        => 'SimpleGem'
+
+
+    should_generate :name        => 'simple-gem', 
+    :module_name => 'SimpleGem', 
+    :ruby_name   => 'simple_gem', 
+    :from        => 'simple-gem'
+
+    should_generate :name        => 'simple_gem', 
+    :module_name => 'SimpleGem', 
+    :ruby_name   => 'simple_gem', 
+    :from        => 'simple_gem'
+
+    should_generate :name        => 'simple_gem', 
+    :module_name => 'SimpleGem', 
+    :ruby_name   => 'simple_gem', 
+    :from        => 'simpleGem'
+
+    describe "An instance of Gem" do
+      before { @path = '/this/path' }
+
+      it "should know its root path" do
+        Gem.new(@path, 'name').root_path.should == @path
+      end
+
+      context "when generating the directory structure" do
+
+        before do
+          @tmp_dir = File.dirname(__FILE__) + '/../../tmp'
+          FileUtils.mkdir(@tmp_dir) unless File.exist?(@tmp_dir)
+
+          @name = 'simple-gem'
+          Gem.new(@tmp_dir, @name).generate
+        end
+
+        after do
+          FileUtils.rm_rf(@tmp_dir)
+        end
+
+        it "should be able to make the root directory" do
+          File.exist?("#{@tmp_dir}/#{@name}").should == true
+        end
+
+        %w(lib test lib/simple_gem).each do |dir|
+          it "should create the #{dir} subdirectory" do
+            File.exist?("#{@tmp_dir}/#{@name}/#{dir}").should == true
+          end
+        end
+
+        it "should create the main library file" do
+          File.exist?("#{@tmp_dir}/#{@name}/lib/simple_gem.rb").should == true
+        end
+        
+        it "should create the version file" do
+          File.exist?("#{@tmp_dir}/#{@name}/lib/simple_gem/version.rb").should == true
+        end
+
+        it "should create the main Rakefile" do
+          File.exist?("#{@tmp_dir}/#{@name}/Rakefile").should == true
+        end
+
+        it "should create the README file" do
+          File.exist?("#{@tmp_dir}/#{@name}/README.markdown").should == true
+        end
+
+        it "should generate the test file" do
+          File.exist?("#{@tmp_dir}/#{@name}/test/simple_gem_test.rb").should == true
+        end
+
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: reagent-simple-gem
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Patrick Reagan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-30 00:00:00 -07:00
+default_executable: simple-gem
+dependencies: []
+
+description: 
+email: reaganpr@gmail.com
+executables: 
+- simple-gem
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- lib/simple_gem
+- lib/simple_gem/gem.rb
+- lib/simple_gem/version.rb
+- lib/simple_gem.rb
+- test/simple_gem
+- test/simple_gem/gem_test.rb
+- templates/lib.rb.erb
+- templates/lib_version.rb.erb
+- templates/Rakefile.erb
+- templates/README.markdown.erb
+- templates/test.rb.erb
+- bin/simple-gem
+has_rdoc: true
+homepage: http://sneaq.net
+post_install_message: 
+rdoc_options: []
+
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Make gems. Simple.
+test_files: []
+