rubygems-tasks 0.1.2 → 0.2.0

data/ChangeLog.md

@@ -1,13 +1,36 @@
+### 0.2.0 / 2012-04-27
+
+* Removed `Gem::Tasks::Task.task_name`.
+
+#### scm:status
+
+* Now ignores untracked files.
+* Will prevent any packages from being built, if the repository is dirty.
+
+#### scm:tag
+
+* Now create `v` prefixed version tags by default.
+* Now supports creating PGP signed Git/Mercurial tags.
+* {Gem::Tasks::SCM::Tag#initialize} now accepts the `:sign` option,
+  for enabling/disabling tag signing on a per-project basis.
+* Added {Gem::Tasks::SCM::Tag#sign?} and {Gem::Tasks::SCM::Tag#sign=}.
+
 ### 0.1.2 / 2012-04-26
 
-* {Gem::Tasks::SCM::Push} now runs `git push` then `git push --tags`.
+#### scm:push
+
+* Now runs `git push` then `git push --tags`.
 
 ### 0.1.1 / 2012-04-26
 
-* {Gem::Tasks::Sign::PGP} now creates ASCII armored signatures.
-* {Gem::Tasks::Console}
-  * require `rubygems` on Ruby 1.8.
-  * require the first `lib/` file to load the project.
+#### console
+
+* require `rubygems` on Ruby 1.8.
+* require the first `lib/` file to load the project.
+
+#### sign:pgp
+
+* Now creates ASCII armored signatures.
 
 ### 0.1.0 / 2012-04-24
 

data/README.md

@@ -37,6 +37,7 @@ This is what rubygems-tasks seeks to provide.
   * `build:zip`
 * Supports [Git][3], [Mercurial][4] and [SubVersion][5] Source-Code-Managers
   (SCMs).
+  * Supports creating PGP signed Git/Mercurial tags.
 * Provides optional `sign` tasks for package integrity:
   * `sign:checksum`
   * `sign:pgp`

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: rubygems-tasks
-version: 0.1.2
+version: 0.2.0
 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/task.rb

@@ -7,8 +7,29 @@ module Gem
     module Build
       class Task < Tasks::Task
 
+        #
+        # @param [String] path
+        #
+        # @param [Gem::Specification] gemspec
+        #
+        # @abstract
+        #
+        def build(path,gemspec)
+        end
+
         protected
 
+        #
+        # Defines build task(s) for file type.
+        #
+        # @param [Symbol] name
+        #   The name for the task(s).
+        #
+        # @param [String, Symbol] extname
+        #   The file extension for the resulting files.
+        #
+        # @api semipublic
+        #
         def build_task(name,extname=name)
           directory Project::PKG_DIR
 
@@ -38,16 +59,6 @@ module Gem
           task :build => "build:#{name}"
         end
 
-        #
-        # @param [String] path
-        #
-        # @param [Gem::Specification] gemspec
-        #
-        # @abstract
-        #
-        def build(path,gemspec)
-        end
-
       end
     end
   end

data/lib/rubygems/tasks/console.rb

@@ -25,7 +25,7 @@ module Gem
       # @param [Hash] options
       #   Additional options.
       #
-      # @option options [String, Array] :command (DEFAULT_COMMAND)
+      # @option options [String] :command (DEFAULT_COMMAND)
       #   The Ruby Console command to run.
       #
       # @option options [Array] :options

data/lib/rubygems/tasks/printing.rb

@@ -3,6 +3,8 @@ module Gem
     #
     # Provides helper methods for printing messages.
     #
+    # @api semipublic
+    #
     module Printing
 
       # ANSI 'bright' color code

data/lib/rubygems/tasks/project.rb

@@ -2,6 +2,9 @@ require 'set'
 
 module Gem
   class Tasks
+    #
+    # @api semipublic
+    #
     class Project
 
       # Supported SCMs and their control directories.
@@ -106,8 +109,6 @@ module Gem
       # @return [Gem::Specification]
       #   The requested gemspec.
       #
-      # @api semipublic
-      #
       def gemspec(name=nil)
         name ||= @primary_gemspec
 
@@ -124,8 +125,6 @@ module Gem
       # @return [Hash{String => Project}]
       #   Project directories and project objects.
       #
-      # @api semipublic
-      #
       def self.directories
         @@directories ||= Hash.new do |hash,key|
           hash[key] = new(key)

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

@@ -45,7 +45,8 @@ module Gem
         def push!
           case @project.scm
           when :git
-            run('git', 'push') && run('git', 'push', '--tags')
+            run 'git', 'push'
+            run 'git', 'push', '--tags'
           when :hg 
             run 'hg', 'push'
           else

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

@@ -43,6 +43,9 @@ module Gem
           # do not allow pushing commits when the repository is dirty
           task 'scm:push' => 'scm:status'
 
+          # do not allow building packages when the repository is dirty
+          task :build => 'scm:status'
+
           # do not allow pushing gems when the repository is dirty
           task :push => 'scm:status'
         end
@@ -55,9 +58,9 @@ module Gem
         #
         def status
           case @project.scm
-          when :git then `git status --short`
-          when :hg  then `hg status`
-          when :svn then `svn status`
+          when :git then `git status --short --untracked-files=no`
+          when :hg  then `hg status --quiet`
+          when :svn then `svn status --quiet`
           else            ''
           end
         end

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

@@ -9,7 +9,7 @@ module Gem
       class Tag < Task
 
         # Default format for versions
-        DEFAULT_FORMAT = '%s'
+        DEFAULT_FORMAT = 'v%s'
 
         # The format for version tags.
         #
@@ -18,6 +18,15 @@ module Gem
         #
         attr_accessor :format
 
+        # Enables or disables PGP signing of tags.
+        # 
+        # @param [Boolean] value
+        #   The new value.
+        #
+        # @since 0.2.0
+        #
+        attr_writer :sign
+
         #
         # Initializes the `scm:tag` task.
         #
@@ -27,10 +36,14 @@ module Gem
         # @option options [String, Proc] :format (DEFAULT_FORMAT)
         #   The format String or Proc for version tags.
         #
+        # @option options [Boolean] :sign
+        #   Enables PGP signing of tags.
+        #
         def initialize(options={})
           super()
 
           @format = options.fetch(:format,DEFAULT_FORMAT)
+          @sign   = options[:sign]
 
           yield self if block_given?
           define
@@ -80,6 +93,36 @@ module Gem
           end
         end
 
+        #
+        # Indicates whether new tags will be signed.
+        #
+        # @return [Boolean]
+        #   Specifies whether new tags will be signed.
+        #
+        # @note
+        #   If {#sign=} has not been set, {#sign?} will determine if tag signing
+        #   has been enabled globally by calling the following commands:
+        #
+        #   * Git: `git config user.signingkey`
+        #   * Mercurial: `hg showconfig extensions hgext gpg`
+        #
+        # @since 0.2.0
+        #
+        def sign?
+          if @sign.nil?
+            @sign = case @project.scm
+                    when :git
+                      !`git config user.signingkey`.chomp.empty?
+                    when :hg
+                      !`hg showconfig extensions hgext gpg`.chomp.empty?
+                    else
+                      false
+                    end
+          end
+
+          return @sign
+        end
+
         #
         # Creates a tag.
         #
@@ -90,9 +133,22 @@ module Gem
         #   Specifies whether the tag was successfully created.
         #
         def tag!(name)
+          message = "Tagging #{name}"
+
           case @project.scm
-          when :git then run 'git', 'tag', name
-          when :hg  then run 'hg', 'tag', name
+          when :git then
+            arguments = ['-m', message]
+            arguments << '-s' if sign?
+            arguments << name
+
+            run 'git', 'tag', *arguments
+          when :hg  then
+            if sign?
+              # sign the change-set, then tag the release
+              run 'hg', 'sign', '-m', "Signing #{name}"
+            end
+
+            run 'hg', 'tag', '-m', message, name
           when :svn
             branch   = File.basename(@project.root)
             tags_dir = if branch == 'trunk'
@@ -105,10 +161,9 @@ module Gem
 
             tag_dir = File.join(tag_dirs,name)
 
-            FileUtils.mkdir_p tags_dir
-            FileUtils.cp_r '.', tag_dir
-
-            return run('svn', 'add', tag_dir)
+            run 'svn', 'mkdir', '--parents', tag_dir
+            run 'svn', 'cp', '*', tag_dir
+            run 'svn', 'commit', '-m', message, tag_dir
           else
             true
           end

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

@@ -26,6 +26,8 @@ module Gem
         # @param [Symbol] name
         #   The name for the `sign:` task.
         #
+        # @api semipublic
+        #
         def sign_task(name)
           @project.builds.each do |build,packages|
             packages.each do |format,path|

data/lib/rubygems/tasks/task.rb

@@ -23,18 +23,6 @@ module Gem
         @project = Project.directories[Dir.pwd]
       end
 
-      #
-      # The task name for the class.
-      #
-      # @return [String]
-      #   The task name for the class.
-      #
-      # @api public
-      #
-      def self.task_name
-        @task_name ||= name.split('::').last.downcase
-      end
-
       protected
 
       #

data/spec/scm/push_spec.rb

@@ -8,6 +8,7 @@ describe Gem::Tasks::SCM::Push do
     context "git" do
       it "should run `git push --tags`" do
         subject.project.stub!(:scm).and_return(:git)
+        subject.should_receive(:run).with('git', 'push')
         subject.should_receive(:run).with('git', 'push', '--tags')
 
         subject.push!

data/spec/scm/tag_spec.rb

@@ -10,20 +10,20 @@ describe Gem::Tasks::SCM::Tag do
     context "defaults" do
       include_context "rake"
 
-      it "should not have a prefix or suffix" do
-        subject.version_tag(version).should == version
+      it "should have a 'v' prefix" do
+        subject.version_tag(version).should == "v#{version}"
       end
     end
 
     context "with format String" do
       include_context "rake"
 
-      let(:format) { 'v%s' }
+      let(:format) { 'release-%s' }
 
       subject { described_class.new(:format => format) }
 
       it "should apply the format String to the version" do
-        subject.version_tag(version).should == "v#{version}"
+        subject.version_tag(version).should == "release-#{version}"
       end
     end
 
@@ -39,27 +39,77 @@ describe Gem::Tasks::SCM::Tag do
   end
 
   describe "#tag!" do
-    let(:name) { 'v1.2.3' }
+    let(:name)    { "v#{version}"        }
+    let(:message) { "Tagging #{name}"    }
 
     context "git" do
-      include_context "rake"
+      context "without signing" do
+        include_context "rake"
+
+        subject { described_class.new(:sign => false) }
+
+        it "should run `git tag`" do
+          subject.project.stub!(:scm).and_return(:git)
+
+          subject.should_receive(:run).with(
+            'git', 'tag', '-m', message, name
+          )
+
+          subject.tag!(name)
+        end
+      end
+
+      context "signing" do
+        include_context "rake"
+
+        subject { described_class.new(:sign => true) }
 
-      it "should run `git tag`" do
-        subject.project.stub!(:scm).and_return(:git)
-        subject.should_receive(:run).with('git', 'tag', name)
+        it "should run `git tag -s`" do
+          subject.project.stub!(:scm).and_return(:git)
 
-        subject.tag!(name)
+          subject.should_receive(:run).with(
+            'git', 'tag', '-m', message, '-s', name
+          )
+
+          subject.tag!(name)
+        end
       end
     end
 
     context "hg" do
-      include_context "rake"
+      context "without signing" do
+        include_context "rake"
+
+        subject { described_class.new(:sign => false) }
+
+        it "should run `hg tag`" do
+          subject.project.stub!(:scm).and_return(:hg)
+
+          subject.should_receive(:run).with(
+            'hg', 'tag', '-m', message, name
+          )
+
+          subject.tag!(name)
+        end
+      end
+
+      context "with signing" do
+        include_context "rake"
+
+        subject { described_class.new(:sign => true) }
+
+        it "should run `hg sign` then `hg tag`" do
+          subject.project.stub!(:scm).and_return(:hg)
 
-      it "should run `hg tag`" do
-        subject.project.stub!(:scm).and_return(:hg)
-        subject.should_receive(:run).with('hg', 'tag', name)
+          subject.should_receive(:run).with(
+            'hg', 'sign', '-m', "Signing #{name}"
+          )
+          subject.should_receive(:run).with(
+            'hg', 'tag', '-m', message, name
+          )
 
-        subject.tag!(name)
+          subject.tag!(name)
+        end
       end
     end
   end

data/spec/spec_helper.rb

@@ -8,9 +8,5 @@ unless File.directory?(PROJECTS_DIR)
   abort "Please run `rake data:projects` before running the specs!"
 end
 
-RSpec.configure do |spec|
-  spec.before(:suite) do
-    # clear the $RUBYCONSOLE env variable
-    ENV['RUBYCONSOLE'] = nil
-  end
-end
+# clear the $RUBYCONSOLE env variable
+ENV['RUBYCONSOLE'] = nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubygems-tasks
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-26 00:00:00.000000000 Z
+date: 2012-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec