technicalpickles-jeweler 1.0.2 → 1.1.0

data/lib/jeweler/specification.rb

@@ -31,12 +31,12 @@ class Jeweler
           self.files = repo.ls_files.keys - repo.lib.ignored_files
         end
 
-        if blank?(test_files)
+        if blank?(test_files) && File.directory?(File.join(base_dir, '.git'))
           repo = Git.open(base_dir)
           self.test_files = FileList['{spec,test,examples}/**/*.rb'] - repo.lib.ignored_files
         end
 
-        if blank?(executable)
+        if blank?(executables)
           self.executables = Dir["bin/*"].map { |f| File.basename(f) }
         end
 

data/lib/jeweler/tasks.rb

@@ -6,6 +6,28 @@ class Rake::Application
 end
 
 class Jeweler
+  # Rake tasks for managing your gem.
+  #
+  # Here's a basic example of using it:
+  #
+  #   Jeweler::Tasks.new do |gem|
+  #     gem.name = "jeweler"
+  #     gem.summary = "Simple and opinionated helper for creating Rubygem projects on GitHub"
+  #     gem.email = "josh@technicalpickles.com"
+  #     gem.homepage = "http://github.com/technicalpickles/jeweler"
+  #     gem.description = "Simple and opinionated helper for creating Rubygem projects on GitHub"
+  #     gem.authors = ["Josh Nichols"]
+  #   end
+  #
+  # The block variable gem is actually a Gem::Specification, so you can do anything you would normally do with a Gem::Specification. For more details, see the official gemspec reference: http://docs.rubygems.org/read/chapter/20
+  #
+  # Jeweler fills in a few reasonable defaults for you:
+  #
+  # [gem.files] a Rake::FileList of anything that is in git and not gitignored. You can include/exclude this default set, or override it entirely
+  # [gem.test_files] Similar to gem.files, except it's only things under the spec, test, or examples directory.
+  # [gem.extra_rdoc_files] a Rake::FileList including files like README*, ChangeLog*, and LICENSE*
+  # [gem.executables] uses anything found in the bin/ directory. You can override this.
+  #
   class Tasks < ::Rake::TaskLib
     attr_accessor :gemspec, :jeweler
 
@@ -90,34 +112,6 @@ class Jeweler
         jeweler.release
       end
       
-      namespace :rubyforge do
-        namespace :release do
-          desc "Release the current gem version to RubyForge."
-          task :gem => [:gemspec, :build] do
-            begin
-              jeweler.release_gem_to_rubyforge
-            rescue NoRubyForgeProjectInGemspecError => e
-              abort "Setting up RubyForge requires that you specify a 'rubyforge_project' in your Jeweler::Tasks declaration"
-            rescue MissingRubyForgePackageError => e
-              abort "Rubyforge reported that the #{e.message} package isn't setup. Run rake rubyforge:setup to do so."
-            rescue RubyForgeProjectNotConfiguredError => e
-              abort "RubyForge reported that #{e.message} wasn't configured. This means you need to run 'rubyforge setup', 'rubyforge login', and 'rubyforge configure', or maybe the project doesn't exist on RubyForge"
-            end
-          end
-        end
-
-        desc "Setup a rubyforge project for this gem"
-        task :setup do
-          begin 
-            jeweler.setup_rubyforge
-          rescue NoRubyForgeProjectInGemspecError => e
-            abort "Setting up RubyForge requires that you specify a 'rubyforge_project' in your Jeweler::Tasks declaration"
-          rescue RubyForgeProjectNotConfiguredError => e
-            abort "The RubyForge reported that #{e.message} wasn't configured. This means you need to run 'rubyforge setup', 'rubyforge login', and 'rubyforge configure', or maybe the project doesn't exist on RubyForge"
-          end
-        end
-
-      end
     end
   end
 end

data/lib/jeweler/templates/Rakefile

@@ -17,7 +17,9 @@ begin
   end
 
 <% if should_setup_rubyforge %>
-  Jeweler::RubyforgeTasks.new
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "<%= doc_task %>"
+  end
 <% end %>
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
@@ -115,11 +117,12 @@ end
 
 task :default => :<%= default_task %>
 
+<% case documentation_framework %>
+<% when :rdoc %>
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION.yml')
-    config = YAML.load(File.read('VERSION.yml'))
-    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
   else
     version = ""
   end
@@ -129,4 +132,13 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
-
+<% when :yard %>
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+<% end %>

data/test/jeweler/commands/test_install_gem.rb

@@ -3,6 +3,59 @@ require 'test_helper'
 class Jeweler
   module Commands
     class TestInstallGem < Test::Unit::TestCase
+      rubyforge_command_context "running" do
+        setup do
+          stub(@gemspec_helper).gem_path { 'pkg/zomg-1.1.1.gem' } 
+          stub(@command).sudo_wrapper { 'sudo gem install pkg/zomg-1.1.1.gem' }
+          stub(@command).sh
+
+          @command.run
+        end
+
+        should "call sudo wrapper with gem install" do
+          assert_received(@command) {|command| command.sudo_wrapper('gem install pkg/zomg-1.1.1.gem') }
+        end
+
+        should "call sh with output of sudo wrapper" do
+          assert_received(@command) {|command| command.sh 'sudo gem install pkg/zomg-1.1.1.gem' }
+        end
+      end
+
+      rubyforge_command_context "use_sudo?" do
+        should "be false on mswin" do
+          stub(@command).host_os { "i386-mswin32" }
+          assert ! @command.use_sudo?
+        end
+
+        should "be false on windows" do
+          stub(@command).host_os { "windows" }
+          assert ! @command.use_sudo?
+        end
+
+        should "be false on cygwin" do
+          stub(@command).host_os { "cygwin" }
+          assert ! @command.use_sudo?
+        end
+
+        should "be true on basically anything else" do
+          stub(@command).host_os { "darwin9" }
+          assert @command.use_sudo?
+        end
+      end
+
+      rubyforge_command_context "sudo_wrapper" do
+        should "prefix sudo if needed" do
+          stub(@command).use_sudo? { true }
+          assert_equal "sudo blarg", @command.sudo_wrapper("blarg")
+        end
+
+        should "not prefix with sudo if unneeded" do
+          stub(@command).use_sudo? { false }
+          assert_equal "blarg", @command.sudo_wrapper("blarg")
+        end
+      end
+      
+
       build_command_context "build for jeweler" do
         setup do
           @command = Jeweler::Commands::InstallGem.build_for(@jeweler)

data/test/jeweler/commands/test_release.rb

@@ -4,175 +4,137 @@ class Jeweler
   module Commands
     class TestRelease < Test::Unit::TestCase
 
-      context "with pending changes" do
-        setup do
-          @repo = Object.new
-          stub(@repo).checkout(anything)
-          stub(@repo).status { status }
+      rubyforge_command_context "running" do
+        context "happily" do
+          setup do
+            stub(@command).clean_staging_area? { true }
 
-          @command                = Jeweler::Commands::Release.new
-          @command.output         = @output
-          @command.repo           = @repo
-          @command.gemspec_helper = @gemspec_helper
-          @command.version        = '1.2.3'
+            stub(@repo).checkout(anything)
 
-          stub(@command).any_pending_changes? { true }
-        end
+            stub(@command).regenerate_gemspec!
+
+            stub(@command).gemspec_changed? { true }
+            stub(@command).commit_gemspec! { true }
+
+            stub(@repo).push
+
+            stub(@command).release_not_tagged? { true }
+            stub(@command).tag_release!
 
-        should 'raise error' do
-          assert_raises RuntimeError, /try commiting/i do
             @command.run
           end
-        end
-      end
 
-      context "run without pending changes, and gemspec changed, and tagged not created already" do
-        setup do
-          @repo = Object.new
-          stub(@repo) do
-            checkout(anything)
-            add(anything)
-            commit(anything)
-            push
+          should "checkout master" do
+            assert_received(@repo) {|repo| repo.checkout('master') }
           end
 
-          @gemspec_helper = Object.new
-          stub(@gemspec_helper) do
-            write
-            path {'zomg.gemspec'}
-            update_version('1.2.3')
+          should "regenerate gemspec" do
+            assert_received(@command) {|command| command.regenerate_gemspec! }
           end
 
-          @output = StringIO.new
+          should "commit gemspec" do
+            assert_received(@command) {|command| command.commit_gemspec! }
+          end
 
-          @command                = Jeweler::Commands::Release.new :output => @output,
-                                                                   :repo => @repo,
-                                                                   :gemspec_helper => @gemspec_helper,
-                                                                   :version => '1.2.3'
+          should "push" do
+            assert_received(@repo) {|repo| repo.push }
+          end
 
-          stub(@command).tag_release!
-          stub(@command).gemspec_changed? { true }
-          stub(@command).any_pending_changes? { false }
-          stub(@command).regenerate_gemspec!
-          stub(@command).commit_gemspec!
-          stub(@command).release_tagged? { false }
+          should "tag release" do
+            assert_received(@command) {|command| command.tag_release! }
+          end
 
-          @command.run
         end
 
-        should "checkout master" do
-          assert_received(@repo) {|repo| repo.checkout('master') }
-        end
+        context "with an unclean staging area" do
+          setup do
+            stub(@command).clean_staging_area? { false }
+          end
 
-        should "regenerate gemspec" do
-          assert_received(@command) {|command| command.regenerate_gemspec! }
+          should 'raise error' do
+            assert_raises RuntimeError, /try commiting/i do
+              @command.run
+            end
+          end
         end
 
-        should "commit gemspec" do
-          assert_received(@command) {|command| command.commit_gemspec! }
-        end
+        context "with an unchanged gemspec" do
+          setup do
+            stub(@command).clean_staging_area? { true }
 
-        should "tag release" do
-          assert_received(@command) {|command| command.tag_release! }
-        end
-      end
+            stub(@repo).checkout(anything)
 
-      context "run without pending changes, and gemspec didn't change, and tagged not created already" do
-        setup do
-          @repo = Object.new
-          stub(@repo) do
-            checkout(anything)
-            add(anything)
-            commit(anything)
-            push
+            stub(@command).regenerate_gemspec!
+
+            stub(@command).gemspec_changed? { false }
+            dont_allow(@command).commit_gemspec! { true }
+
+            stub(@repo).push
+
+            stub(@command).release_not_tagged? { true }
+            stub(@command).tag_release!
+
+            @command.run
           end
 
-          @gemspec_helper = Object.new
-          stub(@gemspec_helper) do
-            write
-            path {'zomg.gemspec'}
-            update_version('1.2.3')
+          should "checkout master" do
+            assert_received(@repo) {|repo| repo.checkout('master') }
           end
 
-          @output = StringIO.new
+          should "regenerate gemspec" do
+            assert_received(@command) {|command| command.regenerate_gemspec! }
+          end
 
-          @command                = Jeweler::Commands::Release.new :output => @output,
-                                                                   :repo => @repo,
-                                                                   :gemspec_helper => @gemspec_helper,
-                                                                   :version => '1.2.3'
+          should "push" do
+            assert_received(@repo) {|repo| repo.push }
+          end
 
-          stub(@command).tag_release!
-          stub(@command).any_pending_changes? { false }
-          stub(@command).gemspec_changed? { false } 
-          stub(@command).regenerate_gemspec!
-          stub(@command).release_tagged? { false }
+          should "tag release" do
+            assert_received(@command) {|command| command.tag_release! }
+          end
 
-          @command.run
         end
 
-        should "checkout master" do
-          assert_received(@repo) {|repo| repo.checkout('master') }
-        end
+        context "with a release already tagged" do
+          setup do
+            stub(@command).clean_staging_area? { true }
 
-        should "regenerate gemspec" do
-          assert_received(@command) {|command| command.regenerate_gemspec! }
-        end
+            stub(@repo).checkout(anything)
 
-        should_eventually "not commit gemspec" do
-          # need a way to assert it wasn't received short of not stubbing it
-          #assert_received(@command) {|command| command.commit_gemspec! }
-        end
+            stub(@command).regenerate_gemspec!
 
-        should "tag release" do
-          assert_received(@command) {|command| command.tag_release! }
-        end
-      end
+            stub(@command).gemspec_changed? { true }
+            stub(@command).commit_gemspec! { true }
 
-      context "run without pending changes and tagged already" do
-        setup do
-          @repo = Object.new
-          stub(@repo) do
-            checkout(anything)
-            add(anything)
-            commit(anything)
-            push
-          end
+            stub(@repo).push
 
-          @gemspec_helper = Object.new
-          stub(@gemspec_helper) do
-            write
-            path {'zomg.gemspec'}
-            update_version('1.2.3')
-          end
+            stub(@command).release_not_tagged? { false }
+            dont_allow(@command).tag_release!
 
-          @output = StringIO.new
+            @command.run
+          end
 
-          @command                = Jeweler::Commands::Release.new :output => @output,
-                                                                   :repo => @repo,
-                                                                   :gemspec_helper => @gemspec_helper,
-                                                                   :version => '1.2.3'
+          should "checkout master" do
+            assert_received(@repo) {|repo| repo.checkout('master') }
+          end
 
-          #stub(@command).tag_release!
-          stub(@command).any_pending_changes? { false }
-          stub(@command).regenerate_gemspec!
-          stub(@command).release_tagged? { true }
+          should "regenerate gemspec" do
+            assert_received(@command) {|command| command.regenerate_gemspec! }
+          end
 
-          @command.run
-        end
+          should "commit gemspec" do
+            assert_received(@command) {|command| command.commit_gemspec! }
+          end
 
-        should "checkout master" do
-          assert_received(@repo) {|repo| repo.checkout('master') }
-        end
+          should "push" do
+            assert_received(@repo) {|repo| repo.push }
+          end
 
-        should "regenerate gemspec" do
-          assert_received(@command) {|command| command.regenerate_gemspec! }
         end
 
-        should_eventually "not tag release" do
-          # need to have a way to verify tag_release! not being called, short of not stubbing it
-        end
       end
 
+
       build_command_context "building from jeweler" do
         setup do
           @command = Jeweler::Commands::Release.build_for(@jeweler)
@@ -203,41 +165,41 @@ class Jeweler
         end
       end
 
-      context "any_pending_changes?" do
+      context "clean_staging_area?" do
 
-        should "be true if there added files" do
+        should "be false if there added files" do
           repo = build_repo :added => %w(README)
 
           command = Jeweler::Commands::Release.new :repo => repo
 
-          assert command.any_pending_changes?
+          assert ! command.clean_staging_area?
         end
 
-        should "be true if there are changed files" do
+        should "be false if there are changed files" do
           repo = build_repo :changed => %w(README)
 
           command = Jeweler::Commands::Release.new
           command.repo = repo
 
-          assert command.any_pending_changes?
+          assert ! command.clean_staging_area?
         end
 
-        should "be true if there are deleted files" do
+        should "be false if there are deleted files" do
           repo = build_repo :deleted => %w(README)
 
           command = Jeweler::Commands::Release.new
           command.repo = repo
 
-          assert command.any_pending_changes?
+          assert ! command.clean_staging_area?
         end
 
-        should "be false if nothing added, changed, or deleted" do
+        should "be true if nothing added, changed, or deleted" do
           repo = build_repo
 
           command = Jeweler::Commands::Release.new
           command.repo = repo
 
-          assert ! command.any_pending_changes?
+          assert command.clean_staging_area?
         end
       end
 
@@ -340,12 +302,7 @@ class Jeweler
       context "release_tagged? when no tag exists" do
         setup do
           @repo = Object.new
-          stub(@repo).tag('v1.2.3') {raise Git::GitTagNameDoesNotExist, tag}
-          #stub(@repo) do
-            #tag('v1.2.3') do |tag|
-              #raise Git::GitTagNameDoesNotExist, tag
-            #end
-          #end
+          stub(@repo).tag('v1.2.3') { raise Git::GitTagNameDoesNotExist, tag }
 
           @output = StringIO.new
 
@@ -355,8 +312,8 @@ class Jeweler
           @command.version        = '1.2.3'
         end
 
-        should_eventually "be false" do
-          assert ! @command.release_tagged?
+        should_eventually "be true" do
+          assert @command.release_not_tagged?
         end
 
       end
@@ -376,8 +333,8 @@ class Jeweler
           @command.version        = '1.2.3'
         end
 
-        should_eventually "be true" do
-          assert @command.release_tagged?
+        should_eventually "be false" do
+          assert @command.release_not_tagged?
         end
 
       end

data/test/jeweler/commands/test_setup_rubyforge.rb

@@ -7,15 +7,82 @@ class Jeweler
         Jeweler::Commands::SetupRubyforge.new
       end
 
-      rubyforge_command_context "rubyforge_project is defined in gemspec and package exists on rubyforge" do
+      rubyforge_command_context "package_exists?" do
+        setup do
+          stub(@gemspec).name { 'zomg' }
+        end
+
+        should "be true if rubyforge.lookup doesn't cause an Error" do
+          mock(@rubyforge).lookup('package', 'zomg')
+
+          assert @command.package_exists?
+        end
+
+        should "be false if rubyforge.lookup raises an error like: no <package_id> configured for <zomg>" do
+          mock(@rubyforge).lookup('package', 'zomg') do
+            raise RuntimeError, "no <package_id> configured for <zomg>"
+          end
+
+          assert ! @command.package_exists?
+        end
+
+        should "reraise any other Errors" do
+          mock(@rubyforge).lookup('package', 'zomg') do
+            raise RuntimeError, 'burnination!'
+          end
+
+          assert_raises RuntimeError, 'burnination!' do
+            @command.package_exists?
+          end
+        end
+      end
+
+      rubyforge_command_context "create_package" do
+        setup do
+          stub(@gemspec).name { 'zomg' }
+        end
+
+        context "when everything is happy" do
+          setup do
+            stub(@gemspec).rubyforge_project { 'myproject' }
+            stub(@rubyforge).create_package('myproject', 'zomg')
+
+            @command.create_package
+          end
+
+          should "create zomg package to myproject on rubyforge" do
+            assert_received(@rubyforge) {|rubyforge| rubyforge.create_package('myproject', 'zomg') }
+          end
+
+        end
+
+        context "when rubyforge project not existing or being setup in ~/.rubyforge/autoconfig.yml" do
+          setup do
+            stub(@gemspec).rubyforge_project { 'myproject' }
+            stub(@rubyforge).create_package('myproject', 'zomg')do
+              raise RuntimeError, "no <group_id> configured for <myproject>"
+            end
+          end
+
+          should "raise RubyForgeProjectNotConfiguredError" do
+            assert_raises RubyForgeProjectNotConfiguredError do
+              @command.create_package
+            end
+          end 
+        end
+      end
+
+
+      rubyforge_command_context "rubyforge_project defined in gemspec and project existing on rubyforge" do
         setup do
           stub(@rubyforge).configure
           stub(@rubyforge).login
-          stub(@rubyforge).create_package('myproject', 'zomg')
 
           stub(@gemspec).name { 'zomg' }
           stub(@gemspec).rubyforge_project { 'myproject' }
 
+          stub(@command).package_exists? { false }
+          stub(@command).create_package
           @command.run
         end
 
@@ -28,11 +95,36 @@ class Jeweler
         end
 
         should "create zomg package to myproject on rubyforge" do
-          assert_received(@rubyforge) {|rubyforge| rubyforge.create_package('myproject', 'zomg') }
+          assert_received(@command) {|command| command.create_package }
         end
       end
 
-      rubyforge_command_context "rubyforge_project not configured" do
+      rubyforge_command_context "rubyforge_project defined in gemspec, project and project already existing on rubyforge" do
+        setup do
+          stub(@rubyforge).configure
+          stub(@rubyforge).login
+
+
+          stub(@gemspec).name { 'zomg' }
+          stub(@gemspec).rubyforge_project { 'myproject' }
+
+          stub(@command).package_exists? { true }
+          dont_allow(@command).create_package
+          @command.run
+        end
+
+        should "configure rubyforge" do
+          assert_received(@rubyforge) {|rubyforge| rubyforge.configure}
+        end
+
+        should "login to rubyforge" do
+          assert_received(@rubyforge) {|rubyforge| rubyforge.login}
+        end
+
+      end
+      
+
+      rubyforge_command_context "rubyforge_project is not defined" do
         setup do
           stub(@gemspec).name { 'zomg' }
           stub(@gemspec).rubyforge_project { nil }
@@ -45,16 +137,18 @@ class Jeweler
         end
       end
 
-      rubyforge_command_context "rubyforge project doesn't exist or not setup in ~/.rubyforge/autoconfig.yml" do
+      rubyforge_command_context "rubyforge project not existing or being setup in ~/.rubyforge/autoconfig.yml" do
         setup do
           stub(@rubyforge).configure
           stub(@rubyforge).login
-          stub(@rubyforge).create_package('some_project_that_doesnt_exist', 'zomg')do
-            raise RuntimeError, "no <group_id> configured for <some_project_that_doesnt_exist>"
-          end
 
           stub(@gemspec).name { 'zomg' }
           stub(@gemspec).rubyforge_project { 'some_project_that_doesnt_exist' }
+
+          stub(@command).package_exists? { false }
+          stub(@command).create_package do
+            raise RubyForgeProjectNotConfiguredError, 'some_project_that_doesnt_exist'
+          end
         end
 
         should "raise RubyForgeProjectNotConfiguredError" do