rubygems-tasks 0.1.0.pre1 → 0.1.0.pre2

data/README.md

@@ -19,12 +19,12 @@ to the project generator which you used to create the project.
 Project generators have _nothing_ to do with the Rake tasks used to build,
 install and release a Ruby project.
 
-Each project generator (Hoe, Jeweler, Bundler, etc) having their
-own set of Rake tasks introduces differing functionality between projects,
-and creates factions between developers. Ruby Developers should not be
-factionalized by their project generator or Rake tasks. Ruby Developers should
-have a common set of Rake tasks that they can use in any project.
-This is what rubygems-tasks seeks to accomplish.
+Recently, many Ruby Developers began creating Ruby projects by hand,
+building/releasing RubyGems using `gem build` / `gem push`. Sometimes this
+resulted in RubyGems being released with uncommitted changes, or the developer
+forgetting to tag the release. Ruby Developers should have access to
+Project generator _agnostic_ and _unobtrusive_ Rake tasks, to _automate_
+the release process. This is what rubygems-tasks seeks to provide.
 
 ## Features
 

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: rubygems-tasks
-version: 0.1.0.pre1
+version: 0.1.0.pre2
 summary: Rake tasks for managing and releasing Ruby projects.
 description:
   Simple Rake tasks for managing and releasing Ruby projects.

data/lib/rubygems/tasks/console.rb

@@ -45,27 +45,48 @@ module Gem
       # Defines the `console` task.
       #
       def define
-        @project.gemspecs.each do |name,gemspec|
+        @project.gemspecs.each_key do |name|
           namespace :console do
-            task name do |t,args|
-              arguments  = [@command, *@options]
-              arguments += gemspec.require_paths.map { |dir| "-I#{dir}" }
-
-              if @project.bundler?
-                if @command == DEFAULT_CONSOLE
-                  run 'bundle', 'console'
-                else
-                  run 'bundle', 'exec', *arguments
-                end
-              else
-                run *arguments
-              end
-            end
+            task(name) { console(name) }
           end
         end
 
         desc "Spawns an Interactive Ruby Console"
-        task :console => "console:#{@project.gemspecs.keys.first}"
+        task :console => "console:#{@project.primary_gemspec_name}"
+      end
+
+      #
+      # Builds the complete arguments for the console command.
+      #
+      # @param [Symbol, String] name
+      #   The name of the gemspec to load.
+      #
+      # @return [Array<String>]
+      #   The arguments for the console command.
+      #
+      def console(name=@project.primary_gemspec_name)
+        unless (gemspec = @project.gemspecs[name.to_s])
+          raise(ArgumentError,"unknown gemspec name: #{name}")
+        end
+
+        arguments = [@command]
+
+        # add -I options for lib/ or ext/ directories
+        arguments.push(*gemspec.require_paths.map { |dir| "-I#{dir}" })
+
+        # 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
+        end
+
+        return run(*arguments)
       end
 
     end

data/lib/rubygems/tasks/install.rb

@@ -31,7 +31,7 @@ module Gem
             task build => path do
               status "Installing #{File.basename(path)} ..."
 
-              run 'gem', 'install', '-q', path
+              install(path)
             end
           end
         end
@@ -42,6 +42,19 @@ module Gem
         task :install_gem => :install # backwards compatibility with Hoe
       end
 
+      #
+      # Pushes the gem by running `gem install`.
+      #
+      # @param [String] path
+      #   The path to the `.gem` file.
+      #
+      # @return [Boolean]
+      #   Specifies whether `gem install` was successfull or not.
+      #
+      def install(path)
+        run 'gem', 'install', '-q', path
+      end
+
     end
   end
 end

data/lib/rubygems/tasks/project.rb

@@ -54,6 +54,22 @@ module Gem
       #
       attr_reader :builds
 
+      #
+      # The name of the primary gemspec.
+      #
+      # @return [String]
+      #   The gemspec name.
+      #
+      attr_reader :primary_gemspec_name
+
+      #
+      # The primary gemspec for the project.
+      #
+      # @return [Gem::Specification]
+      #   The primary gemspec.
+      #
+      attr_reader :primary_gemspec
+
       #
       # Initializes the project.
       #
@@ -82,9 +98,43 @@ module Gem
           end
         end
 
+        @primary_gemspec_name, @primary_gemspec = if @gemspecs.has_key?(@name)
+                                                    [@name, @gemspecs[@name]]
+                                                  else
+                                                    @gemspecs.first
+                                                  end
+
         @bundler = File.file?(File.join(@root,'Gemfile'))
       end
 
+      #
+      # The primary build name for the project.
+      #
+      # @return [String]
+      #   The primary build name.
+      #
+      # @api semipublic
+      #
+      def primary_build
+        if @builds.has_key?(@name)
+          @name
+        else
+          @builds.keys.first
+        end
+      end
+
+      #
+      # The primary gemspec for the project.
+      #
+      # @return [Gem::Specification]
+      #   The primary gemspec.
+      #
+      # @api semipublic
+      #
+      def primary_gemspec
+        @gemspecs[primary_build]
+      end
+
       #
       # Maps project directories to projects.
       #

data/lib/rubygems/tasks/push.rb

@@ -37,17 +37,13 @@ module Gem
             path = packages[:gem]
 
             task build => path do
-              arguments = []
-
               if @host
-                arguments << '--host' << @host
-
                 status "Pushing #{File.basename(path)} to #{@host} ..."
               else
                 status "Pushing #{File.basename(path)} ..."
               end
 
-              run 'gem', 'push', path, *arguments
+              push(path)
             end
           end
         end
@@ -58,6 +54,22 @@ module Gem
         task :publish => :push
       end
 
+      #
+      # Pushes the gem by running `gem push`.
+      #
+      # @param [String] path
+      #   The path to the `.gem` file.
+      #
+      # @return [Boolean]
+      #   Specifies whether `gem push` was successfull or not.
+      #
+      def push(path)
+        arguments = ['gem', 'push', path]
+        arguments.push('--host', @host) if @host
+
+        return run(*arguments)
+      end
+
     end
   end
 end

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

@@ -54,7 +54,7 @@ module Gem
         #
         def status
           case @project.scm
-          when :git then `git status --porcelain`
+          when :git then `git status --short`
           when :hg  then `hg status`
           when :svn then `svn status`
           else            ''

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

@@ -45,7 +45,7 @@ module Gem
               tag = if args.name
                       args.name
                     else
-                      version_tag(@project.gemspecs.values.first.version)
+                      version_tag(@project.primary_gemspec.version)
                     end
 
               status "Tagging #{tag} ..."
@@ -105,8 +105,8 @@ module Gem
 
             tag_dir = File.join(tag_dirs,name)
 
-            mkdir_p tags_dir
-            cp_r    '.', tag_dir
+            FileUtils.mkdir_p tags_dir
+            FileUtils.cp_r '.', tag_dir
 
             return run('svn', 'add', tag_dir)
           else

data/lib/rubygems/tasks/task.rb

@@ -9,6 +9,16 @@ module Gem
 
       include Printing
 
+      #
+      # Project metadata.
+      #
+      # @return [Project]
+      #
+      attr_reader :project
+
+      #
+      # Initializes the task.
+      #
       def initialize
         @project = Project.directories[Dir.pwd]
       end

data/lib/rubygems/tasks/tasks.rb

@@ -121,26 +121,26 @@ module Gem
       @sign  = OpenStruct.new
 
       if build_options
-        @build.gem = Build::Gem.new if build_options.fetch(:gem,true)
-        @build.tar = Build::Tar.new if build_options[:tar]
-        @build.zip = Build::Zip.new if build_options[:zip]
+        @build.gem = (Build::Gem.new if build_options.fetch(:gem,true))
+        @build.tar = (Build::Tar.new if build_options[:tar])
+        @build.zip = (Build::Zip.new if build_options[:zip])
       end
 
       if scm_options
-        @scm.status = SCM::Status.new if scm_options.fetch(:status,true)
-        @scm.tag    = SCM::Tag.new    if scm_options.fetch(:tag,true)
-        @scm.push   = SCM::Push.new   if scm_options.fetch(:push,true)
+        @scm.status = (SCM::Status.new if scm_options.fetch(:status,true))
+        @scm.tag    = (SCM::Tag.new    if scm_options.fetch(:tag,true))
+        @scm.push   = (SCM::Push.new   if scm_options.fetch(:push,true))
       end
 
       if sign_options
-        @sign.checksum = Sign::Checksum.new if sign_options[:checksum]
-        @sign.pgp      = Sign::PGP.new      if sign_options[:pgp]
+        @sign.checksum = (Sign::Checksum.new if sign_options[:checksum])
+        @sign.pgp      = (Sign::PGP.new      if sign_options[:pgp])
       end
 
-      @console = Console.new if options.fetch(:console,true)
-      @install = Install.new if options.fetch(:install,true)
-      @push    = Push.new    if options.fetch(:push,true)
-      @release = Release.new if options.fetch(:release,true)
+      @console = (Console.new if options.fetch(:console,true))
+      @install = (Install.new if options.fetch(:install,true))
+      @push    = (Push.new    if options.fetch(:push,true))
+      @release = (Release.new if options.fetch(:release,true))
 
       yield self if block_given?
     end

data/spec/console_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'rake_context'
+
+require 'rubygems/tasks/console'
+
+describe Gem::Tasks::Console do
+  describe "#console" do
+    include_context "rake"
+
+    let(:command) { 'ripl'             }
+    let(:options) { %w[-Ivendor -rfoo] }
+
+    context "defaults" do
+      it "should run `irb`" do
+        subject.should_receive(:run).with('irb','-Ilib')
+
+        subject.console
+      end
+
+      context "when project.bundler? == true" do
+        it "should use `bundle console`" do
+          subject.project.stub!(:bundler?).and_return(true)
+          subject.should_receive(:run).with('bundle', 'console')
+
+          subject.console
+        end
+      end
+    end
+
+    context "with custom command" do
+      subject { described_class.new(:command => command) }
+
+      it "should run the custom console" do
+        subject.should_receive(:run).with(command, '-Ilib')
+
+        subject.console
+      end
+
+      context "when project.bundler? == true" do
+        it "should use `bundle exec`" do
+          subject.project.stub!(:bundler?).and_return(true)
+          subject.should_receive(:run).with('bundle', 'exec', command, '-Ilib')
+
+          subject.console
+        end
+      end
+    end
+
+    context "with custom options" do
+      subject { described_class.new(:options => options) }
+
+      it "should pass custom options to `irb`" do
+        subject.should_receive(:run).with('irb', '-Ilib', *options)
+
+        subject.console
+      end
+
+      context "when project.bundler? == true" do
+        it "should use `bundle exec ...`" do
+          subject.project.stub!(:bundler?).and_return(true)
+          subject.should_receive(:run).with('bundle', 'exec', 'irb', '-Ilib', *options)
+
+          subject.console
+        end
+      end
+    end
+  end
+end

data/spec/install_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require 'rake_context'
+
+require 'rubygems/tasks/install'
+
+describe Gem::Tasks::Install do
+  describe "#install" do
+    let(:path) { 'pkg/foo-1.2.3.gem' }
+
+    it "should use `gem install -q`" do
+      subject.should_receive(:run).with('gem', 'install', '-q', path)
+
+      subject.install(path)
+    end
+  end
+end

data/spec/push_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'rake_context'
+
+require 'rubygems/tasks/push'
+
+describe Gem::Tasks::Push do
+  describe "#push" do
+    include_context "rake"
+
+    let(:path) { 'pkg/foo-1.2.3.gem' }
+
+    context "defaults" do
+      it "should use `gem push`" do
+        subject.should_receive(:run).with('gem', 'push', path)
+
+        subject.push(path)
+      end
+    end
+
+    context "with custom :host" do
+      let(:host) { 'internal.company.com' }
+
+      subject { described_class.new(:host => host) }
+
+      it "should include the --host option" do
+        subject.should_receive(:run).with('gem', 'push', path, '--host', host)
+
+        subject.push(path)
+      end
+    end
+  end
+end

data/spec/rake_context.rb

@@ -0,0 +1,6 @@
+require 'rake'
+
+shared_context "rake" do
+  let(:rake)   { Rake::Application.new   }
+  before(:all) { Rake.application = rake }
+end

data/spec/scm/push_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'rake_context'
+
+require 'rubygems/tasks/scm/push'
+
+describe Gem::Tasks::SCM::Push do
+  describe "#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', '--tags')
+
+        subject.push!
+      end
+    end
+
+    context "hg" do
+      it "should run `hg push`" do
+        subject.project.stub!(:scm).and_return(:hg)
+        subject.should_receive(:run).with('hg', 'push')
+
+        subject.push!
+      end
+    end
+
+    context "otherwise" do
+      it "should return true" do
+        subject.project.stub!(:scm).and_return(:svn)
+
+        subject.push!.should == true
+      end
+    end
+  end
+end

data/spec/scm/tag_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+require 'rake_context'
+
+require 'rubygems/tasks/scm/tag'
+
+describe Gem::Tasks::SCM::Tag do
+  let(:version) { '1.2.3' }
+
+  describe "#version_tag" do
+    context "defaults" do
+      include_context "rake"
+
+      it "should not have a prefix or suffix" do
+        subject.version_tag(version).should == version
+      end
+    end
+
+    context "with format String" do
+      include_context "rake"
+
+      let(:format) { 'v%s' }
+
+      subject { described_class.new(:format => format) }
+
+      it "should apply the format String to the version" do
+        subject.version_tag(version).should == "v#{version}"
+      end
+    end
+
+    context "with format Proc" do
+      let(:format) { proc { |ver| "REL_" + ver.tr('.','_') } }
+
+      subject { described_class.new(:format => format) }
+
+      it "should call the format Proc with the version" do
+        subject.version_tag(version).should == "REL_1_2_3"
+      end
+    end
+  end
+
+  describe "#tag!" do
+    let(:name) { 'v1.2.3' }
+
+    context "git" do
+      include_context "rake"
+
+      it "should run `git tag`" do
+        subject.project.stub!(:scm).and_return(:git)
+        subject.should_receive(:run).with('git', 'tag', name)
+
+        subject.tag!(name)
+      end
+    end
+
+    context "hg" do
+      include_context "rake"
+
+      it "should run `hg tag`" do
+        subject.project.stub!(:scm).and_return(:hg)
+        subject.should_receive(:run).with('hg', 'tag', name)
+
+        subject.tag!(name)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,2 +1,9 @@
 gem 'rspec', '~> 2.4'
 require 'rspec'
+
+RSpec.configure do |spec|
+  spec.before(:suite) do
+    # clear the $RUBYCONSOLE env variable
+    ENV['RUBYCONSOLE'] = nil
+  end
+end

data/spec/tasks_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+require 'rake_context'
+
+require 'rubygems/tasks/tasks'
+
+describe Gem::Tasks do
+  describe "#initialize" do
+    context "default options" do
+      include_context "rake"
+
+      its(:build)      { should be_kind_of(OpenStruct)             }
+      its('build.gem') { should be_kind_of(Gem::Tasks::Build::Gem) }
+      its('build.tar') { should be_nil                             }
+      its('build.zip') { should be_nil                             }
+
+      its(:scm)         { should be_kind_of(OpenStruct)              }
+      its('scm.status') { should be_kind_of(Gem::Tasks::SCM::Status) }
+      its('scm.push')   { should be_kind_of(Gem::Tasks::SCM::Push)   }
+      its('scm.tag')    { should be_kind_of(Gem::Tasks::SCM::Tag)    }
+
+      its(:sign)           { should be_kind_of(OpenStruct) }
+      its('sign.checksum') { should be_nil                 }
+      its('sign.pgp')      { should be_nil                 }
+
+      its(:console) { should be_kind_of(Gem::Tasks::Console) }
+      its(:install) { should be_kind_of(Gem::Tasks::Install) }
+      its(:push)    { should be_kind_of(Gem::Tasks::Push)    }
+      its(:release) { should be_kind_of(Gem::Tasks::Release) }
+    end
+
+    context ":build => {:gem => false}" do
+      include_context "rake"
+
+      subject { described_class.new(:build => {:gem => false}) }
+
+      its('build.gem') { should be_nil }
+    end
+
+    context ":build => {:tar => true}" do
+      include_context "rake"
+
+      subject { described_class.new(:build => {:tar => true}) }
+
+      its('build.tar') { should be_kind_of(Gem::Tasks::Build::Tar) }
+    end
+
+    context ":build => {:zip => true}" do
+      include_context "rake"
+
+      subject { described_class.new(:build => {:zip => true}) }
+
+      its('build.zip') { should be_kind_of(Gem::Tasks::Build::Zip) }
+    end
+
+    context ":scm => {:status => false}" do
+      include_context "rake"
+
+      subject { described_class.new(:scm => {:status => false}) }
+
+      its('scm.status') { should be_nil }
+    end
+
+    context ":scm => {:push => false}" do
+      include_context "rake"
+
+      subject { described_class.new(:scm => {:push => false}) }
+
+      its('scm.push') { should be_nil }
+    end
+
+    context ":scm => {:tag => false}" do
+      include_context "rake"
+
+      subject { described_class.new(:scm => {:tag => false}) }
+
+      its('scm.tag') { should be_nil }
+    end
+
+    context ":sign => {:checksum => true}" do
+      include_context "rake"
+
+      subject { described_class.new(:sign => {:checksum => true}) }
+
+      its('sign.checksum') { should be_kind_of(Gem::Tasks::Sign::Checksum) }
+    end
+
+    context ":sign => {:pgp => true}" do
+      include_context "rake"
+
+      subject { described_class.new(:sign => {:pgp => true}) }
+
+      its('sign.pgp') { should be_kind_of(Gem::Tasks::Sign::PGP) }
+    end
+
+    context ":console => false" do
+      include_context "rake"
+
+      subject { described_class.new(:console => false) }
+
+      its(:console) { should be_nil }
+    end
+
+    context ":install => false" do
+      include_context "rake"
+
+      subject { described_class.new(:install => false) }
+
+      its(:install) { should be_nil }
+    end
+
+    context ":push => false" do
+      include_context "rake"
+
+      subject { described_class.new(:push => false) }
+
+      its(:push) { should be_nil }
+    end
+
+    context ":release => false" do
+      include_context "rake"
+
+      subject { described_class.new(:release => false) }
+
+      its(:release) { should be_nil }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubygems-tasks
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre1
+  version: 0.1.0.pre2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-19 00:00:00.000000000 Z
+date: 2012-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &18780640 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '2.4'
   type: :development
   prerelease: false
-  version_requirements: *18780640
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &18778180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +37,12 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *18778180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
 description: Simple Rake tasks for managing and releasing Ruby projects.
 email: postmodern.mod3@gmail.com
 executables: []
@@ -71,7 +81,14 @@ files:
 - lib/rubygems/tasks/task.rb
 - lib/rubygems/tasks/tasks.rb
 - rubygems-tasks.gemspec
+- spec/console_spec.rb
+- spec/install_spec.rb
+- spec/push_spec.rb
+- spec/rake_context.rb
+- spec/scm/push_spec.rb
+- spec/scm/tag_spec.rb
 - spec/spec_helper.rb
+- spec/tasks_spec.rb
 homepage: https://github.com/postmodern/rubygems-tasks
 licenses: []
 post_install_message: 
@@ -92,8 +109,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Rake tasks for managing and releasing Ruby projects.
-test_files: []
+test_files:
+- spec/console_spec.rb
+- spec/install_spec.rb
+- spec/push_spec.rb
+- spec/scm/push_spec.rb
+- spec/scm/tag_spec.rb
+- spec/tasks_spec.rb