namelessjon-jeweler 0.5.0

data/lib/jeweler/release.rb

@@ -0,0 +1,28 @@
+class Jeweler
+  module Release
+
+    def release
+      @repo.checkout('master')
+
+      raise "Hey buddy, try committing them files first" if any_pending_changes?
+
+      write_gemspec()
+
+      @repo.add(gemspec_path)
+      @repo.commit("Regenerated gemspec for version #{version}")
+      @repo.push
+
+      @repo.add_tag(release_tag)
+      @repo.push('origin', release_tag)
+    end
+
+    def release_tag
+      @release_tag ||= "v#{version}"
+    end
+
+  protected
+    def any_pending_changes?
+      @repo.status.added.empty? && @repo.status.deleted.empty? && @repo.status.changed.empty? && @repo.status.untracked.empty?
+    end
+  end
+end

data/lib/jeweler/tasks.rb

@@ -0,0 +1,88 @@
+require 'rake'
+require 'rake/tasklib'
+
+class Jeweler
+  class Tasks < ::Rake::TaskLib
+    def initialize(gemspec = nil, &block)
+      @gemspec = Gem::Specification.new()
+      block.call(@gemspec) if block
+
+      @jeweler = Jeweler.new(@gemspec)
+
+      define_tasks
+    end
+
+  private
+    def ensure_version_yml(&block)
+      unless File.exists? 'VERSION.yml'
+        @jeweler.write_version(ENV['MAJOR'], ENV['MINOR'], ENV['PATCH'])
+      end
+      block.call if block
+    end
+
+    def define_tasks
+      desc "Generate and validates gemspec"
+      task :gemspec => ['gemspec:generate', 'gemspec:validate']
+
+      namespace :gemspec do
+        desc "Validates the gemspec"
+        task :validate do
+          @jeweler.validate_gemspec
+        end
+
+        desc "Generates the gemspec"
+        task :generate do
+          ensure_version_yml do
+            @jeweler.write_gemspec
+          end
+        end
+      end
+
+      desc "Displays the current version"
+      task :version => 'version:display'
+
+      namespace :version do
+        desc "Creates an initial version file. Respects the following environment variables, or defaults to 0: MAJOR, MINOR, PATCH"
+        task :write do
+          @jeweler.write_version(ENV['MAJOR'], ENV['MINOR'], ENV['PATCH'])
+        end
+
+        desc "Displays the current version"
+        task :display do
+          ensure_version_yml do
+            puts "Current version: #{@jeweler.version}"
+          end
+        end
+
+        namespace :bump do
+          desc "Bump the gemspec by a major version."
+          task :major => 'version:display' do
+            ensure_version_yml do
+              @jeweler.bump_major_version
+            end
+          end
+
+          desc "Bump the gemspec by a minor version."
+          task :minor => 'version:display' do
+            ensure_version_yml do
+              @jeweler.bump_minor_version
+            end
+          end
+
+          desc "Bump the gemspec by a patch version."
+          task :patch => 'version:display' do
+            ensure_version_yml do
+              @jeweler.bump_patch_version
+            end
+          end
+        end
+      end
+
+      desc "Release the current version. Includes updating the gemspec, pushing, and tagging the release"
+      task :release do
+        @jeweler.release
+      end
+
+    end
+  end
+end

data/lib/jeweler/templates/.gitignore

@@ -0,0 +1,3 @@
+*.sw?
+.DS_Store
+coverage

data/lib/jeweler/templates/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 <%= user_name %>
+
+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/lib/jeweler/templates/README

@@ -0,0 +1,9 @@
+<%= github_repo_name %>
+<%= '=' * github_repo_name.length %>
+
+Description goes here.
+
+COPYRIGHT
+=========
+
+Copyright (c) 2008 <%= user_name %>. See LICENSE for details.

data/lib/jeweler/templates/Rakefile

@@ -0,0 +1,40 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rcov/rcovtask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "<%= github_repo_name %>"
+    s.summary = "TODO"
+    s.email = "<%= user_email %>"
+    s.homepage = "<%= github_url %>"
+    s.description = "TODO"
+    s.authors = ["<%= user_name %>"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = '<%= testspec %>/**/*_<%= testspec %>.rb'
+  t.verbose = false
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = '<%= github_repo_name %>'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Rcov::RcovTask.new do |t|
+  t.libs << "<%= testspec %>"
+  t.test_files = FileList['<%= testspec %>/**/*_<%= testspec %>.rb']
+  t.verbose = true
+end
+
+task :default => :rcov

data/lib/jeweler/templates/spec/flunking_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "<%= constant_name %>" do
+  it "fails" do
+    should.flunk "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/lib/jeweler/templates/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'bacon'
+
+# get a summary of errors raised and such
+Bacon.summary_on_exit

data/lib/jeweler/templates/test/flunking_test.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class <%= constant_name %>Test < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/lib/jeweler/templates/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+class Test::Unit::TestCase
+end

data/lib/jeweler/versioning.rb

@@ -0,0 +1,50 @@
+require 'yaml'
+class Jeweler
+  module Versioning
+    # Major version, as defined by the gemspec's Version module.
+    # For 1.5.3, this would return 1.
+    def major_version
+      version_yaml['major']
+    end
+
+    # Minor version, as defined by the gemspec's Version module.
+    # For 1.5.3, this would return 5.
+    def minor_version
+      version_yaml['minor']
+    end
+
+    # Patch version, as defined by the gemspec's Version module.
+    # For 1.5.3, this would return 5.
+    def patch_version
+      version_yaml['patch']
+    end
+
+    # Human readable version, which is used in the gemspec.
+    def version
+      "#{major_version}.#{minor_version}.#{patch_version}"
+    end
+
+  protected
+    def version_yaml_path
+      denormalized_path = File.join(@base_dir, 'VERSION.yml')
+      absolute_path = File.expand_path(denormalized_path)
+      absolute_path.gsub(Dir.getwd + File::SEPARATOR, '')
+    end
+
+    def version_yaml
+      @version_yaml ||= read_version_yaml
+    end
+
+    def read_version_yaml
+      if File.exists?(version_yaml_path)
+        YAML.load_file(version_yaml_path)
+      else
+        raise VersionYmlError, "#{version_yaml_path} does not exist!"
+      end
+    end
+
+    def refresh_version
+      @version_yaml = read_version_yaml
+    end
+  end
+end

data/test/fixtures/bar/VERSION.yml

@@ -0,0 +1,4 @@
+---
+major: 1
+minor: 5
+patch: 2

data/test/jeweler_generator_test.rb

@@ -0,0 +1,451 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class JewelerTest < Test::Unit::TestCase
+
+  def self.should_create_directory(directory)
+    should "create #{directory} directory" do
+      assert File.exists?(File.join(@tmp_dir, directory))
+      assert File.directory?(File.join(@tmp_dir, directory))
+    end
+  end
+
+  def self.should_create_file(file)
+    should "create file #{file}" do
+      assert File.exists?(File.join(@tmp_dir, file))
+      assert File.file?(File.join(@tmp_dir, file))
+    end
+  end
+
+  def self.should_be_checked_in(file)
+    should "have #{file} checked in" do
+      status = @repo.status[file]
+      assert_not_nil status, "wasn't able to get status for #{file}"
+      assert ! status.untracked, "#{file} was untracked"
+      assert_nil status.type, "#{file} had a type. it should have been nil"
+    end
+  end
+
+  context "given a nil github repo name" do
+    setup do
+      @block = lambda { Jeweler::Generator.new(nil, nil) }
+    end
+
+    should "raise an error" do
+      assert_raise Jeweler::NoGitHubRepoNameGiven do
+        @block.call
+      end
+    end
+  end
+
+  context "without git user's name set" do
+    setup do
+      Jeweler::Generator.any_instance.stubs(:read_git_config).returns({'user.email' => 'bar@example.com'})
+    end
+
+    context "instantiating new generator" do
+      setup do
+        @block = lambda { Jeweler::Generator.new('the-perfect-gem')}
+      end
+
+      should "raise no git user name exception" do
+        assert_raise Jeweler::NoGitUserName do
+          @block.call
+        end
+      end
+    end
+  end
+
+  context "without git user's email set" do
+    setup do
+      Jeweler::Generator.any_instance.stubs(:read_git_config).returns({'user.name' => 'foo'})
+    end
+
+    context "instantiating new generator" do
+      setup do
+        @block = lambda { Jeweler::Generator.new('the-perfect-gem')}
+      end
+
+      should "raise no git user name exception" do
+        assert_raise Jeweler::NoGitUserEmail do
+          @block.call
+        end
+      end
+    end
+  end
+
+  context "without github username set" do
+    setup do
+      Jeweler::Generator.any_instance.stubs(:read_git_config).
+        returns({'user.email' => 'bar@example.com', 'user.name' => 'foo'})
+    end
+
+    context "instantiating new generator" do
+      setup do
+        @block = lambda { Jeweler::Generator.new('the-perfect-gem')}
+      end
+
+      should "raise no github user exception" do
+        assert_raise Jeweler::NoGitHubUser do
+          @block.call
+        end
+      end
+    end
+  end
+
+  context "with valid git user configuration" do
+    setup do
+      Jeweler::Generator.any_instance.stubs(:read_git_config).
+        returns({'user.name' => 'foo', 'user.email' => 'bar@example.com', 'github.user' => 'technicalpickles'})
+    end
+
+    context "for technicalpickle's the-perfect-gem repository" do
+      setup do
+        @generator = Jeweler::Generator.new('the-perfect-gem')
+      end
+
+      should "assign 'foo' to user's name" do
+        assert_equal 'foo', @generator.user_name
+      end
+
+      should "assign 'bar@example.com to user's email" do
+        assert_equal 'bar@example.com', @generator.user_email
+      end
+
+      should "assign github remote" do
+        assert_equal 'git@github.com:technicalpickles/the-perfect-gem.git', @generator.github_remote
+      end
+
+      should "determine github username as technicalpickles" do
+        assert_equal 'technicalpickles', @generator.github_username
+      end
+
+      should "determine github repository name as the-perfect-gem" do
+        assert_equal 'the-perfect-gem', @generator.github_repo_name
+      end
+
+      should "determine github url as http://github.com/technicalpickles/the-perfect-gem" do
+        assert_equal 'http://github.com/technicalpickles/the-perfect-gem', @generator.github_url
+      end
+
+      should "determine target directory as the same as the github repository name" do
+        assert_equal @generator.github_repo_name, @generator.target_dir
+      end
+
+      should "determine lib directory as being inside the target directory" do
+        assert_equal File.join(@generator.target_dir, 'lib'), @generator.lib_dir
+      end
+
+      should "determine test directory as being inside the target directory" do
+        assert_equal File.join(@generator.target_dir, 'test'), @generator.test_dir
+      end
+
+      should "determine constant name as ThePerfectGem" do
+        assert_equal 'ThePerfectGem', @generator.constant_name
+      end
+
+      should "determine file name prefix as the_perfect_gem" do
+        assert_equal 'the_perfect_gem', @generator.file_name_prefix
+      end
+    end
+
+
+    context "and cleaned out tmp directory" do
+      setup do
+        @tmp_dir = File.join(File.dirname(__FILE__), 'tmp')
+        FileUtils.rm_rf(@tmp_dir)
+
+        assert ! File.exists?(@tmp_dir)
+      end
+
+      teardown do
+        FileUtils.rm_rf(@tmp_dir)
+      end
+
+      context "for technicalpickles's the-perfect-gem repo and working directory 'tmp'" do
+        setup do
+          @generator = Jeweler::Generator.new('the-perfect-gem', @tmp_dir)
+        end
+
+        should "use tmp for target directory" do
+          assert_equal @tmp_dir, @generator.target_dir
+        end
+
+        context "running for spec = false" do
+          setup do
+            @generator.run
+          end
+
+          should 'create target directory' do
+            assert File.exists?(@tmp_dir)
+          end
+
+          should_create_directory 'lib'
+          should_create_directory 'test'
+
+          should_create_file 'LICENSE'
+          should_create_file 'README'
+          should_create_file 'lib/the_perfect_gem.rb'
+          should_create_file 'test/test_helper.rb'
+          should_create_file 'test/the_perfect_gem_test.rb'
+          should_create_file '.gitignore'
+
+          context "LICENSE" do
+            setup do
+              @content = File.read((File.join(@tmp_dir, 'LICENSE')))
+            end
+
+            should "include copyright for this year with user's name" do
+              assert_match 'Copyright (c) 2008 foo', @content
+            end
+          end
+
+          context "Rakefile" do
+            setup do
+              @content = File.read((File.join(@tmp_dir, 'Rakefile')))
+            end
+
+            should "include repo's name as the gem's name" do
+              assert_match 's.name = "the-perfect-gem"', @content
+            end
+
+            should "include the user's email as the gem's email" do
+              assert_match 's.email = "bar@example.com"', @content
+            end
+
+            should "include the github repo's url as the gem's url" do
+              assert_match 's.homepage = "http://github.com/technicalpickles/the-perfect-gem"', @content
+            end
+
+            should "include a glob to match test files in the TestTask" do
+              assert_match "t.pattern = 'test/**/*_test.rb'", @content
+            end
+
+            should "include a glob to match test files in the RcovTask" do
+              assert_match "t.test_files = FileList['test/**/*_test.rb']", @content
+            end
+
+            should "push test dir into RcovTask libs" do
+              assert_match 't.libs << "test"', @content
+            end
+          end
+
+          context ".gitignore" do
+            setup do
+              @content = File.read((File.join(@tmp_dir, '.gitignore')))
+            end
+
+            should "include vim swap files" do
+              assert_match '*.sw?', @content
+            end
+
+            should "include coverage" do
+              assert_match 'coverage', @content
+            end
+
+            should "include .DS_Store" do
+              assert_match '.DS_Store', @content
+            end
+          end
+
+
+          context "test/the_perfect_gem_test.rb" do
+            setup do
+              @content = File.read((File.join(@tmp_dir, 'test', 'the_perfect_gem_test.rb')))
+            end
+
+            should "have class of ThePerfectGemTest" do
+              assert_match 'class ThePerfectGemTest < Test::Unit::TestCase', @content
+            end
+          end
+
+
+          context "created git repo" do
+            setup do
+              @repo = Git.open(@tmp_dir)
+            end
+
+            should 'have one commit log' do
+              assert_equal 1, @repo.log.size
+            end
+
+            should "have one commit log an initial commit message" do
+              # TODO message seems to include leading whitespace, could probably fix that in ruby-git
+              assert_match 'Initial commit to the-perfect-gem.', @repo.log.first.message
+            end
+
+            should_be_checked_in 'README'
+            should_be_checked_in 'Rakefile'
+            should_be_checked_in 'LICENSE'
+            should_be_checked_in 'lib/the_perfect_gem.rb'
+            should_be_checked_in 'test/test_helper.rb'
+            should_be_checked_in 'test/the_perfect_gem_test.rb'
+            should_be_checked_in '.gitignore'
+
+            should "have no untracked files" do
+              assert_equal 0, @repo.status.untracked.size
+            end
+
+            should "have no changed files" do
+              assert_equal 0, @repo.status.changed.size
+            end
+
+            should "have no added files" do
+              assert_equal 0, @repo.status.added.size
+            end
+
+            should "have no deleted files" do
+              assert_equal 0, @repo.status.deleted.size
+            end
+
+
+            should "have git@github.com:technicalpickles/the-perfect-gem.git as origin remote" do
+              assert_equal 1, @repo.remotes.size
+              remote = @repo.remotes.first
+              assert_equal 'origin', remote.name
+              assert_equal 'git@github.com:technicalpickles/the-perfect-gem.git', remote.url
+            end
+          end
+        end
+
+        context "running for spec = true" do
+          setup do
+            @generator.spec = true
+            @generator.run
+          end
+
+          should 'create target directory' do
+            assert File.exists?(@tmp_dir)
+          end
+
+          should_create_directory 'lib'
+          should_create_directory 'spec'
+
+          should_create_file 'LICENSE'
+          should_create_file 'README'
+          should_create_file 'lib/the_perfect_gem.rb'
+          should_create_file 'spec/spec_helper.rb'
+          should_create_file 'spec/the_perfect_gem_spec.rb'
+          should_create_file '.gitignore'
+
+          context "LICENSE" do
+            setup do
+              @content = File.read((File.join(@tmp_dir, 'LICENSE')))
+            end
+
+            should "include copyright for this year with user's name" do
+              assert_match 'Copyright (c) 2008 foo', @content
+            end
+          end
+
+          context "Rakefile" do
+            setup do
+              @content = File.read((File.join(@tmp_dir, 'Rakefile')))
+            end
+
+            should "include repo's name as the gem's name" do
+              assert_match 's.name = "the-perfect-gem"', @content
+            end
+
+            should "include the user's email as the gem's email" do
+              assert_match 's.email = "bar@example.com"', @content
+            end
+
+            should "include the github repo's url as the gem's url" do
+              assert_match 's.homepage = "http://github.com/technicalpickles/the-perfect-gem"', @content
+            end
+
+            should "include a glob to match spec files in the TestTask" do
+              assert_match "t.pattern = 'spec/**/*_spec.rb'", @content
+            end
+
+            should "include a glob to match spec files in the RcovTask" do
+              assert_match "t.test_files = FileList['spec/**/*_spec.rb']", @content
+            end
+
+            should "push spec dir into RcovTask libs" do
+              assert_match 't.libs << "spec"', @content
+            end
+          end
+
+          context ".gitignore" do
+            setup do
+              @content = File.read((File.join(@tmp_dir, '.gitignore')))
+            end
+
+            should "include vim swap files" do
+              assert_match '*.sw?', @content
+            end
+
+            should "include coverage" do
+              assert_match 'coverage', @content
+            end
+
+            should "include .DS_Store" do
+              assert_match '.DS_Store', @content
+            end
+          end
+
+
+          context "spec/the_perfect_gem_spec.rb" do
+            setup do
+              @content = File.read((File.join(@tmp_dir, 'spec', 'the_perfect_gem_spec.rb')))
+            end
+
+            should "describe ThePerfectGem" do
+              assert_match 'describe "ThePerfectGem" do', @content
+            end
+          end
+
+
+          context "created git repo" do
+            setup do
+              @repo = Git.open(@tmp_dir)
+            end
+
+            should 'have one commit log' do
+              assert_equal 1, @repo.log.size
+            end
+
+            should "have one commit log an initial commit message" do
+              # TODO message seems to include leading whitespace, could probably fix that in ruby-git
+              assert_match 'Initial commit to the-perfect-gem.', @repo.log.first.message
+            end
+
+            should_be_checked_in 'README'
+            should_be_checked_in 'Rakefile'
+            should_be_checked_in 'LICENSE'
+            should_be_checked_in 'lib/the_perfect_gem.rb'
+            should_be_checked_in 'spec/spec_helper.rb'
+            should_be_checked_in 'spec/the_perfect_gem_spec.rb'
+            should_be_checked_in '.gitignore'
+
+            should "have no untracked files" do
+              assert_equal 0, @repo.status.untracked.size
+            end
+
+            should "have no changed files" do
+              assert_equal 0, @repo.status.changed.size
+            end
+
+            should "have no added files" do
+              assert_equal 0, @repo.status.added.size
+            end
+
+            should "have no deleted files" do
+              assert_equal 0, @repo.status.deleted.size
+            end
+
+
+            should "have git@github.com:technicalpickles/the-perfect-gem.git as origin remote" do
+              assert_equal 1, @repo.remotes.size
+              remote = @repo.remotes.first
+              assert_equal 'origin', remote.name
+              assert_equal 'git@github.com:technicalpickles/the-perfect-gem.git', remote.url
+            end
+          end
+        end
+      end
+    end
+  end
+
+end