technicalpickles-jeweler 0.8.1 → 0.9.0

data/lib/jeweler.rb

@@ -1,237 +1,155 @@
 require 'date'
 require 'rubygems/builder'
 
-require 'jeweler/version'
-require 'jeweler/gemspec'
+require 'jeweler/version_helper'
+require 'jeweler/gemspec_helper'
 require 'jeweler/errors'
 require 'jeweler/generator'
+require 'jeweler/generator/options'
+require 'jeweler/generator/application'
+
+require 'jeweler/commands'
 
 require 'jeweler/tasks'
 
 # A Jeweler helps you craft the perfect Rubygem. Give him a gemspec, and he takes care of the rest.
 class Jeweler
 
-  attr_reader :gemspec
-  attr_accessor :base_dir
+  attr_reader :gemspec, :gemspec_helper
+  attr_accessor :base_dir, :output
 
   def initialize(gemspec, base_dir = '.')
     raise(GemspecError, "Can't create a Jeweler with a nil gemspec") if gemspec.nil?
-    @gemspec = gemspec
-    @base_dir = base_dir
-    
-    if @gemspec.files.nil? || @gemspec.files.empty?
-      @gemspec.files = FileList["[A-Z]*.*", "{bin,generators,lib,test,spec}/**/*"]
-    end
-
-    if @gemspec.executables.nil? || @gemspec.executables.empty?
-      @gemspec.executables = Dir["#{@base_dir}/bin/*"].map do |f|
-        File.basename(f)
-      end
-    end
-
-    @gemspec.has_rdoc = true
-    @gemspec.rdoc_options << '--inline-source' << '--charset=UTF-8'
-    @gemspec.extra_rdoc_files ||=  FileList["[A-Z]*.*"]
 
-    if File.exists?(File.join(base_dir, '.git'))
-      @repo = Git.open(base_dir)
-    end
-
-    @version = Jeweler::Version.new(@base_dir)
+    @base_dir       = base_dir
+    @gemspec        = fill_in_gemspec_defaults(gemspec)
+    @repo           = Git.open(base_dir) if in_git_repo?
+    @version_helper        = Jeweler::VersionHelper.new(@base_dir)
+    @output         = $stdout
+    @gemspec_helper = GemSpecHelper.new(@gemspec,base_dir)
   end
 
   # Major version, as defined by the gemspec's Version module.
   # For 1.5.3, this would return 1.
   def major_version
-    @version.major
+    @version_helper.major
   end
 
   # Minor version, as defined by the gemspec's Version module.
   # For 1.5.3, this would return 5.
   def minor_version
-    @version.minor
+    @version_helper.minor
   end
 
   # Patch version, as defined by the gemspec's Version module.
   # For 1.5.3, this would return 5.
   def patch_version
-    @version.patch
+    @version_helper.patch
   end
 
   # Human readable version, which is used in the gemspec.
   def version
-    @version.to_s
+    @version_helper.to_s
   end
 
   # Writes out the gemspec
   def write_gemspec
-    self.refresh_version
-
-    helper = gemspec_helper do |s|
-      s.version = self.version
-      s.date = Time.now
-    end
-
-    helper.write
-
-    puts "Generated: #{helper.path}"
+    build_command(Jeweler::Commands::WriteGemspec).run
   end
 
   # Validates the project's gemspec from disk in an environment similar to how 
   # GitHub would build from it. See http://gist.github.com/16215
   def validate_gemspec
-    begin
-      gemspec_helper.parse
-      puts "#{gemspec_path} is valid."
-    rescue Exception => e
-      puts "#{gemspec_path} is invalid. See the backtrace for more details."
-      raise
-    end
+    build_command(Jeweler::Commands::ValidateGemspec).run
   end
 
-
   # is the project's gemspec from disk valid?
   def valid_gemspec?
     gemspec_helper.valid?
   end
 
-  # parses the project's gemspec from disk without extra sanity checks
-  def unsafe_parse_gemspec(data = nil)
-    data ||= File.read(gemspec_path)
-    eval(data, binding, gemspec_path)
-  end
-
   def build_gem
-    parsed_gemspec = unsafe_parse_gemspec()
-    Gem::Builder.new(parsed_gemspec).build
-
-    pkg_dir = File.join(@base_dir, 'pkg')
-    FileUtils.mkdir_p pkg_dir
-
-    gem_filename = File.join(@base_dir, parsed_gemspec.file_name)
-    FileUtils.mv gem_filename, pkg_dir
+    build_command(Jeweler::Commands::BuildGem).run
   end
 
   def install_gem
-    command = "sudo gem install #{gem_path}"
-    $stdout.puts "Executing #{command.inspect}:"
-    sh command
+    build_command(Jeweler::Commands::InstallGem).run
   end
 
   # Bumps the patch version.
   #
   # 1.5.1 -> 1.5.2
   def bump_patch_version(options = {})
-    options = version_writing_options(options)
-
-    @version.bump_patch
-    @version.write
-
-    commit_version if options[:commit]
+    build_command(Jeweler::Commands::Version::BumpPatch).run
   end
 
   # Bumps the minor version.
   #
   # 1.5.1 -> 1.6.0
   def bump_minor_version(options = {})
-    options = version_writing_options(options)
-
-    @version.bump_minor
-    @version.write
-
-    commit_version if options[:commit]
+    build_command(Jeweler::Commands::Version::BumpMinor).run
   end
 
   # Bumps the major version.
   #
   # 1.5.1 -> 2.0.0
   def bump_major_version(options = {})
-    options = version_writing_options(options)
-
-    @version.bump_major
-    @version.write
-
-    commit_version if options[:commit]
+    build_command(Jeweler::Commands::Version::BumpMajor).run
   end
 
   # Bumps the version, to the specific major/minor/patch version, writing out the appropriate version.rb, and then reloads it.
   def write_version(major, minor, patch, options = {})
-    options = version_writing_options(options)
+    command = build_command(Jeweler::Commands::Version::Write)
+    command.major = major
+    command.minor = minor
+    command.patch = patch
 
-    @version.update_to major, minor, patch
-    @version.write
-
-    @gemspec.version = @version.to_s
-
-    commit_version if options[:commit]
+    command.run
   end
 
-
   def release
-    @repo.checkout('master')
-
-    raise "Hey buddy, try committing them files first" if any_pending_changes?
-
-    write_gemspec()
-
-    @repo.add(gemspec_path)
-    $stdout.puts "Committing #{gemspec_path}"
-    @repo.commit("Regenerated gemspec for version #{version}")
-
-    $stdout.puts "Pushing master to origin"
-    @repo.push
-
-    $stdout.puts "Tagging #{release_tag}"
-    @repo.add_tag(release_tag)
-
-    $stdout.puts "Pushing #{release_tag} to origin"
-    @repo.push('origin', release_tag)
-  end
-
-  def release_tag
-    @release_tag ||= "v#{version}"
+    build_command(Jeweler::Commands::Release).run
   end
 
   protected
 
-  def version_writing_options(options)
-    {:commit => true}.merge(options)
-  end
+  def build_command(command_class)
+    command = command_class.new
+    command.repo = @repo if command.respond_to?(:repo=)
+    command.version_helper = @version_helper if command.respond_to?(:version_helper=)
+    command.gemspec = @gemspec if command.respond_to?(:gemspec=)
+    command.commit = true if command.respond_to?(:commit=)
+    command.version = self.version if command.respond_to?(:version=)
+    command.output = output if command.respond_to?(:output=)
+    command.base_dir = @base_dir if command.respond_to?(:base_dir=)
+    command.gemspec_helper = GemSpecHelper.new(@gemspec, @base_dir) if command.respond_to?(:gemspec_helper)
 
-  def commit_version
-    if @repo
-      @repo.add('VERSION.yml')
-      @repo.commit("Version bump to #{version}", 'VERSION.yml')
-    end
+    command
   end
 
-  def refresh_version
-    @version.refresh
+  def in_git_repo?
+    File.exists?(File.join(self.base_dir, '.git'))
   end
 
-  def gemspec_helper(&block)
-    GemSpecHelper.new(@gemspec, @base_dir, &block)
-  end
+  def fill_in_gemspec_defaults(gemspec)
+    if gemspec.files.nil? || gemspec.files.empty?
+      gemspec.files = FileList["[A-Z]*.*", "{bin,generators,lib,test,spec}/**/*"]
+    end
 
-  def gemspec_path
-    gemspec_helper.path
-  end
+    if gemspec.executables.nil? || gemspec.executables.empty?
+      gemspec.executables = Dir["#{@base_dir}/bin/*"].map do |f|
+        File.basename(f)
+      end
+    end
 
-  def gem_path
-    parsed_gemspec = unsafe_parse_gemspec()
-    File.join(@base_dir, 'pkg', parsed_gemspec.file_name)
-  end
+    gemspec.has_rdoc = true
+    gemspec.rdoc_options << '--inline-source' << '--charset=UTF-8'
 
-  def any_pending_changes?
-    unless ENV['JEWELER_DEBUG'].nil? || ENV['JEWELER_DEBUG'].squeeze == ''
-      require 'ruby-debug'; breakpoint
+    if gemspec.extra_rdoc_files.nil? || gemspec.extra_rdoc_files.empty?
+      gemspec.extra_rdoc_files = FileList["README*", "ChangeLog*", "LICENSE*"]
     end
-    !(@repo.status.added.empty? && @repo.status.deleted.empty? && @repo.status.changed.empty?)
-  end
 
-  protected
-    def any_pending_changes?
-      !(@repo.status.added.empty? && @repo.status.deleted.empty? && @repo.status.changed.empty?)
-    end
+    gemspec
+  end
 end
 

data/test/jeweler/commands/test_build_gem.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+class Jeweler
+  module Commands
+    class TestBuildGem < Test::Unit::TestCase
+
+      context "after running" do
+        setup do
+          @gemspec = Object.new
+          stub(@gemspec).file_name { 'zomg-1.2.3.gem' }
+
+          @gemspec_helper = Object.new
+          stub(@gemspec_helper).parse { @gemspec }
+
+          @builder = Object.new
+          stub(Gem::Builder).new { @builder }
+          stub(@builder).build { 'zomg-1.2.3.gem' }
+
+          @file_utils = Object.new
+          stub(@file_utils).mkdir_p './pkg'
+          stub(@file_utils).mv './zomg-1.2.3.gem', './pkg'
+
+          @base_dir = '.'
+
+          @command = Jeweler::Commands::BuildGem.new
+          @command.base_dir = @base_dir
+          @command.file_utils = @file_utils
+          @command.gemspec_helper = @gemspec_helper
+
+          @command.run
+        end
+
+        should "call gemspec helper's parse" do
+          assert_received(@gemspec_helper) {|gemspec_helper| gemspec_helper.parse }
+        end
+
+        should "build from parsed gemspec" do
+          assert_received(Gem::Builder) {|builder_class| builder_class.new(@gemspec) }
+          assert_received(@builder) {|builder| builder.build }
+        end
+
+        should 'make package directory' do
+          assert_received(@file_utils) {|file_utils| file_utils.mkdir_p './pkg'}
+        end
+
+        should 'move built gem into package directory' do
+          assert_received(@file_utils) {|file_utils| file_utils.mv './zomg-1.2.3.gem', './pkg'}
+        end
+      end
+
+    end
+  end
+end

data/test/jeweler/commands/test_release.rb

@@ -0,0 +1,145 @@
+require 'test_helper'
+
+class Jeweler
+  module Commands
+    class TestRelease < Test::Unit::TestCase
+
+      context "with added files" do
+        setup do
+          @repo = Object.new
+          stub(@repo).checkout(anything)
+
+          status = Object.new
+          stub(status).added { ['README'] }
+          stub(status).deleted { [] }
+          stub(status).changed { [] }
+          stub(@repo).status { status }
+
+          @command                = Jeweler::Commands::Release.new
+          @command.output         = @output
+          @command.repo           = @repo
+          @command.gemspec_helper = @gemspec_helper
+          @command.version        = '1.2.3'
+        end
+
+        should 'raise error' do
+          assert_raises RuntimeError, /try commiting/i do
+            @command.run
+          end
+        end
+      end
+
+      context "with deleted files" do
+        setup do
+          @repo = Object.new
+          stub(@repo).checkout(anything)
+
+          status = Object.new
+          stub(status).added { [] }
+          stub(status).deleted { ['README'] }
+          stub(status).changed { [] }
+          stub(@repo).status { status }
+
+          @command                = Jeweler::Commands::Release.new
+          @command.output         = @output
+          @command.repo           = @repo
+          @command.gemspec_helper = @gemspec_helper
+          @command.version        = '1.2.3'
+          @command.base_dir       = '.'
+        end
+
+        should 'raise error' do
+          assert_raises RuntimeError, /try commiting/i do
+            @command.run
+          end
+        end
+      end
+
+      context "with changed files" do
+        setup do
+          @repo = Object.new
+          stub(@repo).checkout(anything)
+
+          status = Object.new
+          stub(status).added { [] }
+          stub(status).deleted { [] }
+          stub(status).changed { ['README'] }
+          stub(@repo).status { status }
+
+          @command                = Jeweler::Commands::Release.new
+          @command.output         = @output
+          @command.repo           = @repo
+          @command.gemspec_helper = @gemspec_helper
+          @command.version        = '1.2.3'
+        end
+
+        should 'raise error' do
+          assert_raises RuntimeError, /try commiting/i do
+            @command.run
+          end
+        end
+      end
+
+      context "after running without pending changes" do
+        setup do
+          @repo = Object.new
+          stub(@repo).checkout(anything)
+          stub(@repo).add(anything)
+          stub(@repo).commit(anything)
+          stub(@repo).push
+          stub(@repo).push(anything)
+          stub(@repo).add_tag(anything)
+
+          @gemspec_helper = Object.new
+          stub(@gemspec_helper).write
+          stub(@gemspec_helper).path {'zomg.gemspec'}
+
+          status = Object.new
+          stub(status).added { [] }
+          stub(status).deleted { [] }
+          stub(status).changed { [] }
+          stub(@repo).status { status }
+
+          @output = StringIO.new
+
+          @command                = Jeweler::Commands::Release.new
+          @command.output         = @output
+          @command.repo           = @repo
+          @command.gemspec_helper = @gemspec_helper
+          @command.version        = '1.2.3'
+
+          @command.run
+        end
+
+        should "checkout master" do
+          assert_received(@repo) {|repo| repo.checkout('master') }
+        end
+
+        should "write gemspec" do
+          assert_received(@gemspec_helper) {|gemspec_helper| gemspec_helper.write }
+
+        end
+
+        should "add gemspec to repository" do
+          assert_received(@repo) {|repo| repo.add('zomg.gemspec') }
+        end
+
+        should "commit with commit message including version" do
+          assert_received(@repo) {|repo| repo.commit("Regenerated gemspec for version 1.2.3") }
+        end
+
+        should "push repository" do
+          assert_received(@repo) {|repo| repo.push }
+        end
+
+        should "tag release" do
+          assert_received(@repo) {|repo| repo.add_tag("v1.2.3")}
+        end
+
+        should "push tag to repository" do
+          assert_received(@repo) {|repo| repo.push('origin', 'v1.2.3')}
+        end
+      end
+    end
+  end
+end

data/test/jeweler/commands/test_write_gemspec.rb

@@ -0,0 +1,58 @@
+require 'test_helper'
+
+class Jeweler
+  module Commands
+    class TestWriteGemspec < Test::Unit::TestCase
+
+      context "after run" do
+        setup do
+          @gemspec = Gem::Specification.new {|s| s.name = 'zomg' }
+          @gemspec_helper = Object.new
+          stub(@gemspec_helper).spec { @gemspec }
+          stub(@gemspec_helper).path { 'zomg.gemspec' }
+          stub(@gemspec_helper).write
+
+          @output = StringIO.new
+
+          @version_helper = Object.new
+          stub(@version_helper).to_s  { '1.2.3' }
+          stub(@version_helper).refresh
+
+          @command = Jeweler::Commands::WriteGemspec.new
+          @command.base_dir = 'tmp'
+          @command.version_helper = @version_helper
+          @command.gemspec = @gemspec
+          @command.output = @output
+          @command.gemspec_helper = @gemspec_helper
+
+          @now = Time.now
+          stub(Time.now).now { @now }
+
+          @command.run
+        end
+
+        should "refresh version" do
+          assert_received(@version_helper) {|version_helper| version_helper.refresh }
+        end
+
+        should "update gemspec version" do
+          assert_equal '1.2.3', @gemspec.version.to_s
+        end
+
+        should "update gemspec date to the beginning of today" do
+          assert_equal Time.mktime(@now.year, @now.month, @now.day, 0, 0), @gemspec.date
+        end
+
+        should "write gemspec" do
+          assert_received(@gemspec_helper) {|gemspec_helper| gemspec_helper.write }
+        end
+
+        should_eventually "output that the gemspec was written" do
+          assert_equal @output.string, "Generated: tmp/zomg.gemspec"
+        end
+
+      end
+
+    end
+  end
+end

data/test/jeweler/commands/version/test_bump_major.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+class Jeweler
+  module Commands
+    module Version
+      class TestBumpMajor < Test::Unit::TestCase
+
+        should "call bump_major on version_helper in update_version" do
+          mock(version_helper = Object.new).bump_major
+
+          command = Jeweler::Commands::Version::BumpMajor.new
+          command.version_helper = version_helper
+
+          command.update_version
+        end
+      end
+    end
+  end
+end
+
+

data/test/jeweler/commands/version/test_bump_minor.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+class Jeweler
+  module Commands
+    module Version
+      class TestBumpMinor < Test::Unit::TestCase
+
+        should "call bump_minor on version_helper in update_version" do
+          mock(version_helper = Object.new).bump_minor
+
+          command = Jeweler::Commands::Version::BumpMinor.new
+          command.version_helper = version_helper
+
+          command.update_version
+        end
+      end
+    end
+  end
+end

data/test/jeweler/commands/version/test_bump_patch.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+class Jeweler
+  module Commands
+    module Version
+      class TestBumpPatch < Test::Unit::TestCase
+
+        should "call bump_patch on version_helper in update_version" do
+          mock(version_helper = Object.new).bump_patch
+
+          command = Jeweler::Commands::Version::BumpPatch.new
+          command.version_helper = version_helper
+
+          command.update_version
+        end
+      end
+    end
+  end
+end
+

data/test/jeweler/commands/version/test_write.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+class Jeweler
+  module Commands
+    module Version
+      class TestWrite < Test::Unit::TestCase
+
+        should "call write_version on version_helper in update_version" do
+          mock(version_helper = Object.new).update_to 1, 2, 3
+
+          command = Jeweler::Commands::Version::Write.new
+          command.version_helper = version_helper
+          command.major = 1
+          command.minor = 2
+          command.patch = 3
+
+          command.update_version
+        end
+      end
+    end
+  end
+end
+