lib/simple_gem/version.rb templates/Rakefile.erb templates/lib_version.rb.erb @@ -1 +1,50 @@ -Generating gems is fun. Doing it with hoe / newgem / bones / etc... is a pain in (my) ass \ No newline at end of file +# 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 + + sudo gem install reagent-simple-gem --source=http://gems.github.com + +## 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. README.markdown @@ -1,7 +1,10 @@ require 'rubygems' require 'rake/gempackagetask' +require 'rake/testtask' -require 'lib/simple_gem' +require 'lib/simple_gem/version' + +task :default => :test spec = Gem::Specification.new do |s| s.name = 'simple-gem' @@ -20,6 +23,12 @@ 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" Rakefile @@ -1 +1,10 @@ -#!/usr/bin/env ruby \ No newline at end of file +#!/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 \ No newline at end of file bin/simple-gem @@ -1,13 +1,2 @@ -module SimpleGem - module Version - - MAJOR = 0 - MINOR = 1 - TINY = 0 - - def self.to_s - [MAJOR, MINOR, TINY].join('.') - end - - end -end \ No newline at end of file +require 'simple_gem/version' +require 'simple_gem/gem' \ No newline at end of file lib/simple_gem.rb @@ -1,3 +1,5 @@ +require 'erb' + module SimpleGem class Gem @@ -19,12 +21,39 @@ module SimpleGem 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) - # pattern = /_/ 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 \ No newline at end of file lib/simple_gem/gem.rb @@ -4,12 +4,12 @@ Gem::Specification.new do |s| s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= s.authors = ["Patrick Reagan"] - s.date = %q{2008-10-27} + s.date = %q{2008-10-29} s.default_executable = %q{simple-gem} s.email = %q{reaganpr@gmail.com} s.executables = ["simple-gem"] - s.extra_rdoc_files = ["README"] - s.files = ["README", "Rakefile", "lib/simple_gem.rb", "bin/simple-gem"] + s.extra_rdoc_files = ["README.markdown"] + s.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"] s.has_rdoc = true s.homepage = %q{http://sneaq.net} s.require_paths = ["lib"] simple-gem.gemspec @@ -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. templates/README.markdown.erb @@ -0,0 +1 @@ +# require '<%= self.ruby_name %>/...' \ No newline at end of file templates/lib.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 \ No newline at end of file templates/test.rb.erb @@ -8,7 +8,7 @@ module SimpleGem class GemTest < Test::Unit::TestCase def self.should_generate(expectations) - context "when given a #{expectations[:from]} name" do + describe "An instance of Gem when given a #{expectations[:from]} name" do before do path = '/this/path' @name = expectations[:from] @@ -25,19 +25,80 @@ module SimpleGem 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' + 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 \ No newline at end of file test/simple_gem/gem_test.rb templates/Rakefile.tmpl bc306562e2cb534c3f2447badfe72e6b0e5b9c7b Patrick Reagan patrick.reagan@viget.com http://github.com/reagent/simple-gem/commit/25d255e30b628a67882ba6c62e3371a666456eeb 25d255e30b628a67882ba6c62e3371a666456eeb 2008-10-29T07:59:37-07:00 2008-10-29T07:59:37-07:00 Implemented gem generation; updated documentation files 0a09a5d527d42f82f683397ed6a33a196fef3190 Patrick Reagan patrick.reagan@viget.com