gem-this 0.3.3 → 0.3.4

data/Rakefile

@@ -20,7 +20,7 @@ spec = Gem::Specification.new do |s|
 
   # Change these as appropriate
   s.name              = "gem-this"
-  s.version           = "0.3.3"
+  s.version           = "0.3.4"
   s.summary           = "Make existing code into a gem, without any fuss."
   s.author            = "James Adam"
   s.email             = "james@lazyatom.com"
@@ -31,7 +31,7 @@ spec = Gem::Specification.new do |s|
   # s.rdoc_options      = %w(--main Readme.markdown)
 
   # Add any extra files to include in the gem
-  s.files             = %w(Rakefile Readme.markdown Rakefile.erb) + Dir.glob("{bin,lib}/**/*")
+  s.files             = %w(Rakefile Readme.markdown Rakefile.erb) + Dir.glob("{bin,lib,test}/**/*")
   s.executables       = FileList["bin/**"].map { |f| File.basename(f) }
   s.require_paths     = ["bin", "lib"]
 
@@ -79,45 +79,18 @@ task :clean => [:clobber_rdoc, :clobber_package] do
   rm "#{spec.name}.gemspec"
 end
 
-# If you want to publish to RubyForge automatically, here's a simple
-# task to help do that. If you don't, just get rid of this.
-# Be sure to set up your Rubyforge account details with the Rubyforge
-# gem; you'll need to run `rubyforge setup` and `rubyforge config` at
-# the very least.
-begin
-  require "rake/contrib/sshpublisher"
-  namespace :rubyforge do
-
-    desc "Release gem and RDoc documentation to RubyForge"
-    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
-
-    namespace :release do
-      desc "Release a new version of this gem"
-      task :gem => [:package] do
-        require 'rubyforge'
-        rubyforge = RubyForge.new
-        rubyforge.configure
-        rubyforge.login
-        rubyforge.userconfig['release_notes'] = spec.summary
-        path_to_gem = File.join(File.dirname(__FILE__), "pkg", "#{spec.name}-#{spec.version}.gem")
-        puts "Publishing #{spec.name}-#{spec.version.to_s} to Rubyforge..."
-        rubyforge.add_release(spec.rubyforge_project, spec.name, spec.version.to_s, path_to_gem)
-      end
-
-      desc "Publish RDoc to RubyForge."
-      task :docs => [:rdoc] do
-        config = YAML.load(
-            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
-        )
-
-        host = "#{config['username']}@rubyforge.org"
-        remote_dir = "/var/www/gforge-projects/gem-this/" # Should be the same as the rubyforge project name
-        local_dir = 'rdoc'
-
-        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
-      end
+desc 'Tag the repository in git with gem version number'
+task :tag => [:gemspec, :package] do
+  if `git diff --cached`.empty?
+    if `git tag`.split("\n").include?("v#{spec.version}")
+      raise "Version #{spec.version} has already been released"
     end
+    `git add #{File.expand_path("../#{spec.name}.gemspec", __FILE__)}`
+    `git commit -m "Released version #{spec.version}"`
+    `git tag v#{spec.version}`
+    `git push --tags`
+    `git push`
+  else
+    raise "Unstaged changes still waiting to be committed"
   end
-rescue LoadError
-  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
 end

data/Rakefile.erb

@@ -3,11 +3,10 @@ require "rake/gempackagetask"
 require "rake/rdoctask"
 
 <% if using_rspec? %>
-require "spec"
-require "spec/rake/spectask"
-Spec::Rake::SpecTask.new do |t|
-  t.spec_opts = %w(--format specdoc --colour)
-  t.libs = ["spec"]
+require "rspec"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w(--format specdoc --colour)
 end
 <% elsif using_test_unit? %>
 require "rake/testtask"
@@ -63,7 +62,7 @@ spec = Gem::Specification.new do |s|
 
   # Add any extra files to include in the gem (like your README)
 <% end %>
-  s.files             = %w(<%= files_in_root %>) + Dir.glob("{<%= dirs_to_include_glob %>}")
+  s.files             = %w(<%= files_in_root %>) + Dir.glob(<%= dirs_to_include_glob.inspect %>)
 <% if has_executables? %>
   s.executables       = FileList["bin/**"].map { |f| File.basename(f) }
 <% end %>
@@ -111,6 +110,11 @@ task :gemspec do
   File.open(file, "w") {|f| f << spec.to_ruby }
 end
 
+# If you don't want to generate the .gemspec file, just remove this line. Reasons
+# why you might want to generate a gemspec:
+#  - using bundler with a git source
+#  - building the gem without rake (i.e. gem build blah.gemspec)
+#  - maybe others?
 task :package => :gemspec
 
 # Generate documentation

data/lib/gem_this.rb

@@ -84,11 +84,11 @@ class GemThis
 
   def dirs_to_include_glob
     dirs = %w(bin test spec lib).select { |d| File.directory?(d) }
+    glob_parts = ["**", "*"]
     if dirs.any?
-      dirs.join(",") + "/**/*"
-    else
-      "**/*"
+      glob_parts.unshift("{"+dirs.join(",")+"}")
     end
+    File.join(*glob_parts)
   end
 
   def readme

data/test/gem_this_test.rb

@@ -0,0 +1,95 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class GemThisTest < Test::Unit::TestCase
+  context "When building a gem" do
+    setup do
+      build_gem do
+        touch "README"
+        touch "lib/thing.rb"
+        touch "lib/thing/some/aspect/many/levels/deep.rb"
+      end
+    end
+
+    should "contain lib files" do
+      assert_gem_contains "lib/thing.rb"
+    end
+    
+    should "contain deeply nested files" do
+      assert_gem_contains "lib/thing/some/aspect/many/levels/deep.rb"
+    end
+
+    should "include the README" do
+      assert_gem_contains "README"
+    end
+
+    should "put lib in require path" do
+      assert_gem_spec :require_paths, ["lib"]
+    end
+  end
+  
+  context "When building a gem with tests" do
+    setup do
+      build_gem do
+        touch "lib/thing.rb"
+        touch "test/thing_test.rb"
+      end
+    end
+
+    should "contain test files" do
+      assert_gem_contains "test/thing_test.rb"
+    end
+    
+    should "create a rake task for running tests" do
+      assert_rake_task :test
+    end
+    
+  end
+
+  context "When building a gem with specs" do
+    setup do
+      build_gem do
+        touch "lib/thing.rb"
+        touch "spec/my_spec.rb"
+      end
+    end
+    
+    should "contain spec files" do
+      assert_gem_contains "spec/my_spec.rb"
+    end
+
+    should "create a rake task for running specs" do
+      assert_rake_task :spec
+    end
+  end
+
+  context "When building a gem with features" do
+    setup do
+      build_gem do
+        touch "lib/thing.rb"
+        touch "features/gem-this.feature"
+      end
+    end
+
+    should "create a rake task for running features" do
+      assert_rake_task :features
+    end
+
+    should "add a features task to the default rake task dependencies" do
+      assert_default_rake_task_dependencies_contains :features
+    end
+  end
+
+  context "When building a gem without a lib directory" do
+    setup do
+      create_gem do
+        touch "code/my_code_is_in_here_for_some_reason.rb"
+      end
+    end
+
+    should "not build the gem" do
+      assert_doesnt_hang do
+        assert !@gem.build # the real test is whether or not this returns at all.
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,107 @@
+require 'rubygems'
+require 'shoulda'
+require 'fileutils'
+require 'tempfile'
+require 'yaml'
+require 'timeout'
+require 'rake'
+
+class GemBuilder
+  attr_reader :gem_path
+
+  def initialize(name, &block)
+    @name = name
+    @gem_path = temporary_gem_name
+    FileUtils.mkdir_p(@gem_path)
+    FileUtils.cd(@gem_path) do
+      instance_eval &block
+    end
+  end
+
+  def touch(name)
+    FileUtils.mkdir_p(File.dirname(name))
+    FileUtils.touch(name)
+  end
+
+  def path_to_gem
+    File.join(@gem_path, "pkg", @name + "-0.1.0.gem")
+  end
+
+  def build
+    result = nil
+    FileUtils.cd(@gem_path) do
+      result = GemThis.new(@name, :debug => false, :silent => true).create_rakefile
+      `rake package 2>&1`
+    end
+    result
+  end
+
+  private
+
+  def temporary_gem_name
+    t = Tempfile.new('gem-this')
+    gem_name = t.path
+    t.unlink
+    File.join(gem_name, @name)
+  end
+end
+
+class Test::Unit::TestCase
+  def assert_gem_contains(*paths)
+    paths.each do |path|
+      assert gem_spec.files.include?(path), "gem should include #{path}"
+    end
+  end
+
+  def assert_gem_spec(part, value, message = nil)
+    assert_equal value, gem_spec.send(part), message
+  end
+
+  def assert_rake_task(task)
+    tasks =  in_gem { `rake -T`.split("\n").map { |line| line.split[1] } }
+    assert tasks.include?(task.to_s), tasks.inspect
+  end
+
+  def assert_default_rake_task_dependencies_contains(task)
+    in_gem {
+      assert prerequisites_for('default').include?(task.to_s), prerequisites_for('default').inspect
+    }
+  end
+
+  def assert_doesnt_hang(duration=5, message=nil, &block)
+    assert_nothing_raised("should return within #{duration} seconds") do
+      Timeout::timeout(duration, &block)
+    end
+  end
+
+  def in_gem(&block)
+    result = nil
+    FileUtils.cd(@gem.gem_path) do
+      load 'RakeFile'
+      result = block.call
+    end
+    result
+  end
+
+  def create_gem(name="test_gem", &block)
+    @gem = GemBuilder.new(name, &block)
+  end
+
+  def build_gem(name="test_gem", &block)
+    create_gem(name, &block).build
+  end
+
+  def gem_spec
+    in_gem { YAML.load(`gem specification #{@gem.path_to_gem}`) }
+  end
+
+  private
+  def find_task(task_name)
+    @tasks ||= Rake.application.tasks
+    @tasks.find {|task| task.name == task_name}
+  end
+
+  def prerequisites_for(task_name)
+    find_task(task_name).prerequisites
+  end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gem-this
 version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 3
-  - 3
-  version: 0.3.3
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - James Adam
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-10 00:00:00 +00:00
+date: 2010-11-19 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: shoulda
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -33,9 +36,11 @@ dependencies:
   name: rspec
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -45,9 +50,11 @@ dependencies:
   name: cucumber
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -68,6 +75,8 @@ files:
 - bin/gem-this
 - lib/gem_this.rb
 - lib/rubygems_plugin.rb
+- test/gem_this_test.rb
+- test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/lazyatom/gem-this
 licenses: []
@@ -79,16 +88,20 @@ require_paths:
 - bin
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 9
       segments: 
       - 1
       - 3
@@ -96,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: gem-this
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Make existing code into a gem, without any fuss.