rubygems-tasks 0.2.0 → 0.2.1

data/ChangeLog.md

@@ -1,3 +1,37 @@
+### 0.2.1 / 2012-04-29
+
+* Overrode the `FileUtils.fu_output_message` to call
+  {Gem::Tasks::Printing#debug}.
+* Added `@api semipublic` tags to mark the semi-public API.
+* Fixed a spelling error.
+
+#### console
+
+* Infer the primary file to require from the gemspec name.
+* No longer run `bundle console`, since it is not the same as running
+  `bundle exec irb -Ilib -rfoo/bar`.
+
+#### scm:status
+
+* Will display the human-readable status, if the repository is dirty.
+* Hooks into the `validate` task.
+
+#### scm:push
+
+* Depends on the `validate` task.
+
+#### scm:tag
+
+* Depends on the `validate` task.
+
+#### build:*
+
+* All `build:*` tasks now depend on the `validate` task.
+
+#### push
+
+* Depends on the `validate` task.
+
 ### 0.2.0 / 2012-04-27
 
 * Removed `Gem::Tasks::Task.task_name`.

data/README.md

@@ -68,7 +68,7 @@ Specifying an alternate Ruby Console to run:
 Enable pushing gems to an in-house [RubyGems][2] server:
 
     Gem::Tasks.new do |tasks|
-      tasks.push.host = 'gems.company.come'
+      tasks.push.host = 'gems.company.com'
     end
 
 Disable the `push` task:
@@ -85,9 +85,9 @@ Enable Checksums and PGP signatures for built packages:
 
 Selectively defining tasks:
 
+    Gem::Build::Tar.new
     Gem::SCM::Status.new
     Gem::SCM::Tag.new(:format => 'REL-%s')
-    Gem::Build::Tar.new
     Gem::Sign::Checksum.new
     Gem::Console.new
 

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: rubygems-tasks
-version: 0.2.0
+version: 0.2.1
 summary: Rake tasks for managing and releasing Ruby Gems.
 description:
   Agnostic and unobtrusive Rake tasks for managing and releasing Ruby Gems.

data/lib/rubygems/tasks/build/gem.rb

@@ -46,10 +46,12 @@ module Gem
         # @param [Gem::Specification] gemspec
         #   The gemspec to build the `.gem` package from.
         #
+        # @api semipublic
+        #
         def build(path,gemspec)
           builder = ::Gem::Builder.new(gemspec)
 
-          FileUtils.mv builder.build, Project::PKG_DIR
+          mv builder.build, Project::PKG_DIR
         end
 
       end

data/lib/rubygems/tasks/build/tar.rb

@@ -39,6 +39,8 @@ module Gem
         # @param [Gem::Specification] gemspec
         #   The gemspec to generate the archive from.
         #
+        # @api semipublic
+        #
         def build(path,gemspec)
           run 'tar', 'czf', path, *gemspec.files
         end

data/lib/rubygems/tasks/build/task.rb

@@ -33,6 +33,8 @@ module Gem
         def build_task(name,extname=name)
           directory Project::PKG_DIR
 
+          task :validate
+
           @project.builds.each do |build,packages|
             namespace :build do
               namespace name do
@@ -40,7 +42,7 @@ module Gem
                 path    = packages[extname]
 
                 # define file tasks, so the packages are not needless re-built
-                file(path => [Project::PKG_DIR, *gemspec.files]) do
+                file(path => [:validate, Project::PKG_DIR, *gemspec.files]) do
                   status "Building #{File.basename(path)} ..."
 
                   build(path,gemspec)

data/lib/rubygems/tasks/build/zip.rb

@@ -37,6 +37,8 @@ module Gem
         # @param [Gem::Specification] gemspec
         #   The gemspec to build the archive from.
         #
+        # @api semipublic
+        #
         def build(path,gemspec)
           run 'zip', '-q', path, *gemspec.files
         end

data/lib/rubygems/tasks/console.rb

@@ -64,11 +64,13 @@ module Gem
       # @return [Array<String>]
       #   The arguments for the console command.
       #
+      # @api semipublic
+      #
       def console(name=nil)
         gemspec = @project.gemspec(name)
 
         require_paths = gemspec.require_paths
-        require_file  = gemspec.files.find { |path| path.start_with?('lib/') }
+        require_file  = gemspec.name.gsub('-',File::SEPARATOR)
 
         arguments = [@command]
 
@@ -79,18 +81,14 @@ module Gem
         arguments.push('-rrubygems') if RUBY_VERSION < '1.9'
 
         # add an -r option to require the library
-        arguments.push('-r' + require_file.sub('lib/','')) if require_file
+        arguments.push('-r' + require_file)
 
         # push on additional options
         arguments.push(*@options)
 
         if @project.bundler?
-          # use `bundle console` unless were were using custom command/options
-          if (@command == DEFAULT_CONSOLE && @options.empty?)
-            arguments = ['bundle', 'console']
-          else
-            arguments.unshift('bundle', 'exec')
-          end
+          # run under `bundle exec`
+          arguments.unshift('bundle', 'exec')
         end
 
         return run(*arguments)

data/lib/rubygems/tasks/install.rb

@@ -49,7 +49,9 @@ module Gem
       #   The path to the `.gem` file.
       #
       # @return [Boolean]
-      #   Specifies whether `gem install` was successfull or not.
+      #   Specifies whether `gem install` was successful or not.
+      #
+      # @api semipublic
       #
       def install(path)
         run 'gem', 'install', '-q', path

data/lib/rubygems/tasks/printing.rb

@@ -77,6 +77,20 @@ module Gem
         $stderr.puts "#{ERROR_PREFIX} #{message}"
       end
 
+      private
+
+      #
+      # The FileUtils output method.
+      #
+      # @param [String] message
+      #   The FileUtils message to print.
+      #
+      # @since 0.2.1
+      #
+      def fu_output_message(message)
+        debug(message)
+      end
+
     end
   end
 end

data/lib/rubygems/tasks/push.rb

@@ -32,11 +32,13 @@ module Gem
       # Defines the `push` task.
       #
       def define
+        task :validate
+
         namespace :push do
           @project.builds.each do |build,packages|
             path = packages[:gem]
 
-            task build => path do
+            task build => [:validate, path] do
               if @host
                 status "Pushing #{File.basename(path)} to #{@host} ..."
               else
@@ -61,7 +63,9 @@ module Gem
       #   The path to the `.gem` file.
       #
       # @return [Boolean]
-      #   Specifies whether `gem push` was successfull or not.
+      #   Specifies whether `gem push` was successful or not.
+      #
+      # @api semipublic
       #
       def push(path)
         arguments = ['gem', 'push', path]

data/lib/rubygems/tasks/scm/push.rb

@@ -25,8 +25,10 @@ module Gem
         # Defines the `scm:push` task.
         #
         def define
+          task :validate
+
           namespace :scm do
-            task :push do
+            task :push => :validate do
               status "Pushing commits ..."
 
               unless push!
@@ -42,6 +44,8 @@ module Gem
         # @return [Boolean]
         #   Specifies whether the commits were successfully pushed.
         #
+        # @api semipublic
+        #
         def push!
           case @project.scm
           when :git

data/lib/rubygems/tasks/scm/status.rb

@@ -27,41 +27,50 @@ module Gem
         def define
           namespace :scm do
             task :status do
-              status = self.status
-
-              unless status.strip.empty?
+              if dirty?
                 error "Project has uncommitted changes!"
-                puts status
+
+                status
                 abort
               end
             end
           end
 
-          # do not allow tagging releases when the repository is dirty
-          task 'scm:tag' => 'scm:status'
-
-          # do not allow pushing commits when the repository is dirty
-          task 'scm:push' => 'scm:status'
+          # alias the `validate` task to scm:status
+          task :validate => 'scm:status'
+        end
 
-          # do not allow building packages when the repository is dirty
-          task :build => 'scm:status'
+        #
+        # Checks the status of the project repository.
+        #
+        # @return [Boolean]
+        #   Specifies whether the repository is dirty.
+        #
+        # @api semipublic
+        #
+        # @since 0.2.1
+        #
+        def dirty?
+          status = case @project.scm
+                   when :git then `git status --porcelain --untracked-files=no`
+                   when :hg  then `hg status --quiet`
+                   when :svn then `svn status --quiet`
+                   else            ''
+                   end
 
-          # do not allow pushing gems when the repository is dirty
-          task :push => 'scm:status'
+          return !status.chomp.empty?
         end
 
         #
-        # Checks the status of the project repository.
+        # Displays the status of the project repository.
         #
-        # @return [String]
-        #   The status of the project repository.
+        # @api semipublic
         #
         def status
           case @project.scm
-          when :git then `git status --short --untracked-files=no`
-          when :hg  then `hg status --quiet`
-          when :svn then `svn status --quiet`
-          else            ''
+          when :git then run 'git', 'status', '--untracked-files=no'
+          when :hg  then run 'hg', 'status', '--quiet'
+          when :svn then run 'svn', 'status', '--quiet'
           end
         end
 

data/lib/rubygems/tasks/scm/tag.rb

@@ -53,8 +53,10 @@ module Gem
         # Defines the `scm:tag` task.
         #
         def define
+          task :validate
+
           namespace :scm do
-            task :tag, [:name] do |t,args|
+            task :tag, [:name] => :validate do |t,args|
               tag = if args.name
                       args.name
                     else
@@ -82,6 +84,8 @@ module Gem
         # @raise [TypeError]
         #   {#format} was not a String or a Proc.
         #
+        # @api semipublic
+        #
         def version_tag(version)
           case @format
           when String
@@ -106,6 +110,8 @@ module Gem
         #   * Git: `git config user.signingkey`
         #   * Mercurial: `hg showconfig extensions hgext gpg`
         #
+        # @api semipublic
+        #
         # @since 0.2.0
         #
         def sign?
@@ -132,6 +138,8 @@ module Gem
         # @return [Boolean]
         #   Specifies whether the tag was successfully created.
         #
+        # @api semipublic
+        #
         def tag!(name)
           message = "Tagging #{name}"
 

data/lib/rubygems/tasks/sign/checksum.rb

@@ -94,6 +94,8 @@ module Gem
         # @param [String] path
         #   The path to the package.
         #
+        # @api semipublic
+        #
         def sign(path)
           status "Checksums for #{File.basename(path)}:"
 

data/lib/rubygems/tasks/sign/pgp.rb

@@ -36,6 +36,8 @@ module Gem
         # @param [String] path
         #   The path to the package.
         #
+        # @api semipublic
+        #
         def sign(path)
           status "Signing #{File.basename(path)} ..."
 

data/spec/console_spec.rb

@@ -8,9 +8,9 @@ describe Gem::Tasks::Console do
     include_context "rake"
 
     if RUBY_VERSION < '1.9'
-      let(:default_options) { %w[-Ilib -rrubygems -rrubygems/tasks.rb] }
+      let(:default_options) { %w[-Ilib -rrubygems -rrubygems/tasks] }
     else
-      let(:default_options) { %w[-Ilib -rrubygems/tasks.rb]            }
+      let(:default_options) { %w[-Ilib -rrubygems/tasks]            }
     end
 
     let(:custom_command)  { 'ripl'             }
@@ -24,9 +24,11 @@ describe Gem::Tasks::Console do
       end
 
       context "when project.bundler? == true" do
-        it "should use `bundle console`" do
+        it "should use `bundle exec`" do
           subject.project.stub!(:bundler?).and_return(true)
-          subject.should_receive(:run).with('bundle', 'console')
+          subject.should_receive(:run).with(
+            'bundle', 'exec', 'irb', *default_options
+          )
 
           subject.console
         end

data/spec/project_spec.rb

@@ -110,7 +110,7 @@ describe Gem::Tasks::Project do
     subject { rubygems_multi_project }
 
     it "should group builds by gemspec name" do
-      subject.builds.keys.should == subject.gemspecs.keys
+      subject.builds.keys.should =~ subject.gemspecs.keys
     end
 
     it "should map a package format to a pkg/ path" do

data/spec/scm/status_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'rake_context'
+
+require 'rubygems/tasks/scm/status'
+
+describe Gem::Tasks::SCM::Status do
+  describe "#status" do
+    context "git" do
+      include_context "rake"
+
+      it "should run `git status --untracked-files=no`" do
+        subject.project.stub!(:scm).and_return(:git)
+
+        subject.should_receive(:run).with(
+          'git', 'status', '--untracked-files=no'
+        )
+
+        subject.status
+      end
+    end
+
+    context "hg" do
+      include_context "rake"
+
+      it "should run `hg status --quiet`" do
+        subject.project.stub!(:scm).and_return(:hg)
+
+        subject.should_receive(:run).with(
+          'hg', 'status', '--quiet'
+        )
+
+        subject.status
+      end
+    end
+
+    context "svn" do
+      include_context "rake"
+
+      it "should run `svn status --quiet`" do
+        subject.project.stub!(:scm).and_return(:svn)
+
+        subject.should_receive(:run).with(
+          'svn', 'status', '--quiet'
+        )
+
+        subject.status
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubygems-tasks
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-28 00:00:00.000000000 Z
+date: 2012-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -90,6 +90,7 @@ files:
 - spec/push_spec.rb
 - spec/rake_context.rb
 - spec/scm/push_spec.rb
+- spec/scm/status_spec.rb
 - spec/scm/tag_spec.rb
 - spec/spec_helper.rb
 - spec/tasks_spec.rb
@@ -123,5 +124,6 @@ test_files:
 - spec/project_spec.rb
 - spec/push_spec.rb
 - spec/scm/push_spec.rb
+- spec/scm/status_spec.rb
 - spec/scm/tag_spec.rb
 - spec/tasks_spec.rb