mattknox-jeweler 0.7.0

data/lib/jeweler/templates/shoulda/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/shoulda/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require '<%= file_name_prefix %>'
+
+class Test::Unit::TestCase
+end

data/lib/jeweler/version.rb

@@ -0,0 +1,81 @@
+class Jeweler
+  class Version
+    attr_accessor :base_dir
+    attr_reader :major, :minor, :patch
+
+    def initialize(base_dir)
+      self.base_dir = base_dir
+
+      if File.exists?(yaml_path)
+        parse_yaml
+      end
+    end
+
+    def bump_major
+      @major += 1
+      @minor = 0
+      @patch = 0
+    end
+
+    def bump_minor
+      @minor += 1
+      @patch = 0
+    end
+
+    def bump_patch
+      @patch += 1
+    end
+
+    def update_to(major, minor, patch)
+      @major = major
+      @minor = minor
+      @patch = patch
+    end
+
+    def write
+      File.open(yaml_path, 'w+') do |f|
+        YAML.dump(self.to_hash, f)
+      end
+    end
+
+    def to_s
+      "#{major}.#{minor}.#{patch}"
+    end
+
+    def to_hash
+      {
+        :major => major,
+        :minor => minor,
+        :patch => patch
+      }
+    end
+
+    def refresh
+      parse_yaml
+    end
+
+    def 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
+
+    protected
+
+    def parse_yaml
+      yaml = read_yaml
+      @major = (yaml['major'] || yaml[:major]).to_i
+      @minor = (yaml['minor'] || yaml[:minor]).to_i
+      @patch = (yaml['patch'] || yaml[:patch]).to_i
+    end
+
+    def read_yaml
+      if File.exists?(yaml_path)
+        YAML.load_file(yaml_path)
+      else
+        raise VersionYmlError, "#{yaml_path} does not exist!"
+      end
+    end
+
+  end
+end

data/test/fixtures/bar/VERSION.yml

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

data/test/generators/initialization_test.rb

@@ -0,0 +1,146 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class JewelerGeneratorInitializerTest < Test::Unit::TestCase
+  context "given a nil github repo name" do
+    setup do
+      @block = lambda { Jeweler::Generator.new(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 "without github token set" do
+    setup do
+      Jeweler::Generator.any_instance.stubs(:read_git_config).
+        returns({'user.email' => 'bar@example.com', 'user.name' => 'foo', 'github.user' => 'technicalpickles'})
+    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::NoGitHubToken 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', 'github.token' => 'zomgtoken'})
+    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
+  end
+end

data/test/shoulda_macros/jeweler_macros.rb

@@ -0,0 +1,35 @@
+class Test::Unit::TestCase
+  class << self
+    def should_have_major_version(version)
+      should "have major version of #{version}" do 
+        assert_equal version, @jeweler.major_version
+      end
+    end
+    
+    def should_have_minor_version(version)
+      should "have minor version of #{version}" do
+        assert_equal version, @jeweler.minor_version
+      end
+    end
+    
+    def should_have_patch_version(version)
+      should "have patch version of #{version}" do
+        assert_equal version, @jeweler.patch_version
+      end
+    end
+    
+    def should_be_version(version)
+      should "be version #{version}" do
+        assert_equal version, @jeweler.version
+      end
+    end
+    
+    def should_bump_version(major, minor, patch)
+      version = "#{major}.#{minor}.#{patch}"
+      should_have_major_version major
+      should_have_minor_version minor
+      should_have_patch_version patch
+      should_be_version version
+    end
+  end
+end

data/test/test_gemspec.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class TestGemspec < Test::Unit::TestCase
+  context "A Jeweler::GemSpec, given a gemspec" do
+    setup do
+      @spec = build_spec
+      @helper = Jeweler::GemSpecHelper.new(@spec, File.dirname(__FILE__))
+    end
+
+    should 'have sane gemspec path' do
+      assert_equal "test/#{@spec.name}.gemspec", @helper.path
+    end
+  end
+
+  context "Jeweler::GemSpec#write" do
+    setup do
+      @spec = build_spec
+      @helper = Jeweler::GemSpecHelper.new(@spec)
+      FileUtils.rm_f(@helper.path)
+
+      @helper.write
+    end
+
+    should "create gemspec file" do
+      assert File.exists?(@helper.path)
+    end
+
+    should "make valid spec" do
+      assert @helper.valid?
+    end
+  end
+end

data/test/test_generator.rb

@@ -0,0 +1,269 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class TestGenerator < 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_files(*files)
+    should "create #{files.join ', '}" do
+      files.each do |file|
+        assert File.exists?(File.join(@tmp_dir, file))
+        assert File.file?(File.join(@tmp_dir, file))        
+      end
+    end
+  end
+
+  def self.should_be_checked_in(*files)
+    should "have #{files.join ', '} checked in" do
+      files.each do |file|        
+        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
+  end
+  
+  def self.should_have_sane_license
+    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
+  end
+  
+  def self.should_have_sane_gitignore
+    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
+  end
+  
+  def self.should_have_sane_rakefile(options)
+    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 summary in the gem" do
+        assert_match %Q{s.summary = %Q{zomg, so good}}, @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 #{options[:pattern]} in the TestTask" do
+        assert_match "t.pattern = '#{options[:pattern]}'", @content
+      end
+
+      should "include #{options[:pattern]} in the RcovTask" do
+        assert_match "t.test_files = FileList['#{options[:pattern]}']", @content
+      end
+
+      should "push #{options[:libs]} dir into RcovTask libs" do
+        assert_match "t.libs << '#{options[:libs]}'", @content
+      end
+    end
+  end
+  
+  def self.should_have_sane_origin_remote
+    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
+
+  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', 'github.token' => 'zomgtoken'})
+    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 generating technicalpickles's the-perfect-gem repo in 'tmp'" do
+        setup do
+          @generator = Jeweler::Generator.new('the-perfect-gem', :directory => @tmp_dir, :summary => 'zomg, so good')
+        end
+
+        should "use tmp for target directory" do
+          assert_equal @tmp_dir, @generator.target_dir
+        end
+
+        context "running with default test style" do
+          setup do
+            @output = catch_out { @generator.run }
+          end
+
+          should 'create target directory' do
+            assert File.exists?(@tmp_dir)
+          end
+
+          should_create_directory 'lib'
+          should_create_directory 'test'
+
+          should_create_files 'LICENSE', 'README', 'lib/the_perfect_gem.rb', 'test/test_helper.rb', 'test/the_perfect_gem_test.rb', '.gitignore'
+
+          should_have_sane_rakefile :libs => 'test', :pattern => 'test/**/*_test.rb'
+          should_have_sane_license
+          should_have_sane_gitignore
+
+
+          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 an initial commit message" do
+              assert_equal 1, @repo.log.size
+              # 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', 'Rakefile', 'LICENSE', 'lib/the_perfect_gem.rb', 'test/test_helper.rb', 'test/the_perfect_gem_test.rb', '.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_sane_origin_remote
+          end
+        end
+
+        context "running with bacon test style" do
+          setup do
+            @generator.test_style = :bacon
+            @output = catch_out {
+              @generator.run
+            }
+          end
+
+          should 'create target directory' do
+            assert File.exists?(@tmp_dir)
+          end
+
+          should_create_directory 'lib'
+          should_create_directory 'spec'
+
+          should_create_files 'LICENSE', 'README', 'lib/the_perfect_gem.rb', 'spec/spec_helper.rb', 'spec/the_perfect_gem_spec.rb', '.gitignore'
+
+          should_have_sane_rakefile :libs => 'spec', :pattern => 'spec/**/*_spec.rb'
+          should_have_sane_license
+          should_have_sane_gitignore
+
+
+          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', 'Rakefile', 'LICENSE', 'lib/the_perfect_gem.rb', 'spec/spec_helper.rb', 'spec/the_perfect_gem_spec.rb', '.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_sane_origin_remote
+          end
+        end
+      end
+    end
+  end
+end