rubygems-tasks 0.2.4 → 0.2.6

data/lib/rubygems/tasks.rb

@@ -2,8 +2,146 @@ require 'rubygems/tasks/console'
 require 'rubygems/tasks/build'
 require 'rubygems/tasks/install'
 require 'rubygems/tasks/scm'
-require 'rubygems/tasks/scm'
 require 'rubygems/tasks/push'
 require 'rubygems/tasks/release'
 require 'rubygems/tasks/sign'
-require 'rubygems/tasks/tasks'
+
+require 'rake/tasklib'
+require 'ostruct'
+
+module Gem
+  #
+  # Defines basic Rake tasks for managing and releasing projects:
+  #
+  # * {Build::Gem build:gem}
+  # * {Build::Tar build:tar}
+  # * {Build::Zip build:zip}
+  # * {SCM::Status scm:status}
+  # * {SCM::Push scm:push}
+  # * {SCM::Tag scm:tag}
+  # * {Console console}
+  # * {Install install}
+  # * {Push push}
+  # * {Release release}
+  # * {Sign::Checksum sign:checksum}
+  # * {Sign::PGP sign:pgp}
+  #
+  class Tasks
+
+    #
+    # The `build` tasks.
+    #
+    # @return [OpenStruct]
+    #   The collection of `build` tasks.
+    #
+    attr_reader :build
+
+    #
+    # The `scm` tasks.
+    #
+    # @return [OpenStruct]
+    #   The collection of `scm` tasks.
+    #
+    attr_reader :scm
+
+    #
+    # The `sign` tasks.
+    #
+    # @return [OpenStruct]
+    #   The collection of `sign` tasks.
+    #
+    attr_reader :sign
+
+    # The {Console console} task.
+    attr_reader :console
+
+    # The {Install install} task.
+    attr_reader :install
+
+    # The {Push push} task.
+    attr_reader :push
+
+    # The {Release release} task.
+    attr_reader :release
+
+    #
+    # Initializes the project tasks.
+    #
+    # @param [Hash{Symbol => Hash}] options
+    #   Enables or disables individual tasks.
+    #
+    # @option options [Hash{Symbol => Boolean}] :build
+    #   Enables or disables the `build` tasks.
+    #
+    # @option options [Hash{Symbol => Boolean}] :scm
+    #   Enables or disables the `scm` tasks.
+    #
+    # @option options [Boolean] :console (true)
+    #   Enables or disables the {Console console} task.
+    #
+    # @option options [Boolean] :install (true)
+    #   Enables or disables the {Install install} task.
+    #
+    # @option options [Boolean] :push (true)
+    #   Enables or disables the {Push push} task.
+    #
+    # @option options [Boolean] :release (true)
+    #   Enables or disables the {Release release} task.
+    #
+    # @option options [Hash{Symbol => Boolean}] :sign
+    #   Enables or disables the `sign` tasks.
+    #
+    # @yield [tasks]
+    #   If a block is given, it will be passed the newly created tasks,
+    #   before they are fully defined.
+    #
+    # @yieldparam [Tasks] tasks
+    #   The newly created tasks.
+    #
+    # @example Enables building of `.gem` and `.tar.gz` packages:
+    #   Gem::Tasks.new(build: {gem: true, tar: true})
+    #
+    # @example Disables pushing `.gem` packages to [rubygems.org](rubygems.org):
+    #   Gem::Tasks.new(push: false)
+    #
+    # @example Configures the version tag format:
+    #   Gem::Tasks.new do |tasks|
+    #     tasks.scm.tag.format = "release-%s"
+    #   end
+    #
+    def initialize(options={})
+      build_options = options.fetch(:build,{})
+      scm_options   = options.fetch(:scm,{})
+      sign_options  = options.fetch(:sign,{})
+
+      @scm   = OpenStruct.new
+      @build = OpenStruct.new
+      @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])
+      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))
+      end
+
+      if sign_options
+        @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))
+
+      yield self if block_given?
+    end
+
+  end
+end

data/rubygems-tasks.gemspec

@@ -2,108 +2,60 @@
 
 require 'yaml'
 
-Gem::Specification.new do |gemspec|
-  files = if File.directory?('.git')
-            `git ls-files`.split($/)
-          elsif File.directory?('.hg')
-            `hg manifest`.split($/)
-          elsif File.directory?('.svn')
-            `svn ls -R`.split($/).select { |path| File.file?(path) }
-          else
-            Dir['{**/}{.*,*}'].select { |path| File.file?(path) }
-          end
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
 
-  filter_files = lambda { |paths|
-    case paths
-    when Array
-      (files & paths)
-    when String
-      (files & Dir[paths])
-    end
-  }
-
-  version = {
-    :file     => 'lib/rubygems/tasks/version.rb',
-    :constant => 'Gem::Tasks::VERSION'
-  }
-
-  defaults = {
-    'name'            => File.basename(File.dirname(__FILE__)),
-    'files'           => files,
-    'require_paths'   => ['ext', 'lib'].select { |dir| File.directory?(dir) },
-    'executables'     => filter_files['bin/*'].map { |path| File.basename(path) },
-    'test_files'      => filter_files['{test/{**/}*_test.rb,spec/{**/}*_spec.rb}'],
-    'extra_doc_files' => filter_files['*.{txt,rdoc,md,markdown,tt,textile}']
-  }
-
-  metadata = defaults.merge(YAML.load_file('gemspec.yml'))
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
 
-  gemspec.name    = metadata['name']
-  gemspec.version = if metadata['version']
-                      metadata['version']
-                    else
-                      $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+                  require 'rubygems/tasks/version'
+                  Gem::Tasks::VERSION
+                end
 
-                      require version[:file]
-                      eval(version[:constant])
-                    end
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
+  gem.metadata    = gemspec['metadata'] if gemspec['metadata']
 
-  gemspec.summary     = metadata.fetch('summary',metadata['description'])
-  gemspec.description = metadata.fetch('description',metadata['summary'])
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
 
-  gemspec.licenses = Array(metadata['license'])
-  gemspec.authors  = Array(metadata['authors'])
+  gem.files = `git ls-files`.split($/)
+  gem.files = glob[gemspec['files']] if gemspec['files']
 
-  gemspec.email    = metadata['email']
-  gemspec.homepage = metadata['homepage']
-
-  gemspec.require_paths = Array(metadata['require_paths'])
-  gemspec.files         = filter_files[metadata['files']]
-  gemspec.executables   = metadata['executables']
-  gemspec.extensions    = metadata['extensions']
-
-  if Gem::VERSION < '1.7.'
-    gemspec.default_executable = gemspec.executables.first
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
   end
+  gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
 
-  gemspec.test_files       = filter_files[metadata['test_files']]
-  gemspec.extra_rdoc_files = Array(metadata['extra_doc_files'])
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+  gem.test_files       = glob[gemspec['test_files'] || '{test/{**/}*_test.rb']
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
 
-  gemspec.post_install_message = metadata['post_install_message']
-  gemspec.requirements         = metadata['requirements']
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
 
-  if gemspec.respond_to?(:required_ruby_version=)
-    gemspec.required_ruby_version = metadata['required_ruby_version']
-  end
+  gem.requirements              = gemspec['requirements']
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
 
-  if gemspec.respond_to?(:required_rubygems_version=)
-    gemspec.required_rubygems_version = metadata['required_ruby_version']
-  end
-
-  parse_versions = lambda { |versions|
-    case versions
-    when Array
-      versions.map { |v| v.to_s }
-    when String
-      versions.split(/,\s*/)
-    end
-  }
-
-  if metadata['dependencies']
-    metadata['dependencies'].each do |name,versions|
-      gemspec.add_dependency(name,parse_versions[versions])  
-    end
-  end
+  split = lambda { |string| string.split(/,\s*/) }
 
-  if metadata['runtime_dependencies']
-    metadata['runtime_dependencies'].each do |name,versions|
-      gemspec.add_runtime_dependency(name,parse_versions[versions])  
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
     end
   end
 
-  if metadata['development_dependencies']
-    metadata['development_dependencies'].each do |name,versions|
-      gemspec.add_development_dependency(name,parse_versions[versions])  
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
     end
   end
 end

data/spec/console_spec.rb

@@ -7,26 +7,31 @@ describe Gem::Tasks::Console do
   describe "#console" do
     include_context "rake"
 
-    if RUBY_VERSION < '1.9'
-      let(:default_options) { %w[-Ilib -rrubygems -rrubygems/tasks] }
-    else
-      let(:default_options) { %w[-Ilib -rrubygems/tasks]            }
-    end
+    let(:default_options) { %w[-Ilib -rrubygems/tasks] }
 
     let(:custom_command)  { 'ripl'             }
     let(:custom_options)  { %w[-Ivendor -rfoo] }
 
     context "defaults" do
-      it "should run `irb`" do
-        subject.should_receive(:run).with('irb',*default_options)
+      context "when project.bundler? == false" do
+        before do
+          allow(subject.project).to receive(:bundler?).and_return(false)
+        end
+
+        it "should run `irb`" do
+          expect(subject).to receive(:run).with('irb',*default_options)
 
-        subject.console
+          subject.console
+        end
       end
 
       context "when project.bundler? == true" do
+        before do
+          allow(subject.project).to receive(:bundler?).and_return(true)
+        end
+
         it "should use `bundle exec`" do
-          subject.project.stub!(:bundler?).and_return(true)
-          subject.should_receive(:run).with(
+          expect(subject).to receive(:run).with(
             'bundle', 'exec', 'irb', *default_options
           )
 
@@ -38,16 +43,25 @@ describe Gem::Tasks::Console do
     context "with custom command" do
       subject { described_class.new(:command => custom_command) }
 
-      it "should run the custom console" do
-        subject.should_receive(:run).with(custom_command,*default_options)
+      context "when project.bundler? == false" do
+        before do
+          allow(subject.project).to receive(:bundler?).and_return(false)
+        end
 
-        subject.console
+        it "should run the custom console" do
+          expect(subject).to receive(:run).with(custom_command,*default_options)
+
+          subject.console
+        end
       end
 
       context "when project.bundler? == true" do
+        before do
+          allow(subject.project).to receive(:bundler?).and_return(true)
+        end
+
         it "should use `bundle exec`" do
-          subject.project.stub!(:bundler?).and_return(true)
-          subject.should_receive(:run).with(
+          expect(subject).to receive(:run).with(
             'bundle', 'exec', custom_command, *default_options
           )
 
@@ -59,16 +73,25 @@ describe Gem::Tasks::Console do
     context "with custom options" do
       subject { described_class.new(:options => custom_options) }
 
-      it "should pass custom options to `irb`" do
-        subject.should_receive(:run).with('irb', *(default_options + custom_options))
+      context "when project.bundler? == false" do
+        before do
+          allow(subject.project).to receive(:bundler?).and_return(false)
+        end
+
+        it "should pass custom options to `irb`" do
+          expect(subject).to receive(:run).with('irb', *(default_options + custom_options))
 
-        subject.console
+          subject.console
+        end
       end
 
       context "when project.bundler? == true" do
+        before do
+          allow(subject.project).to receive(:bundler?).and_return(true)
+        end
+
         it "should use `bundle exec ...`" do
-          subject.project.stub!(:bundler?).and_return(true)
-          subject.should_receive(:run).with('bundle', 'exec', 'irb', *(default_options + custom_options))
+          expect(subject).to receive(:run).with('bundle', 'exec', 'irb', *(default_options + custom_options))
 
           subject.console
         end

data/spec/install_spec.rb

@@ -8,7 +8,11 @@ describe Gem::Tasks::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)
+      if defined?(Bundler)
+        expect(Bundler).to receive(:with_original_env).and_yield()
+      end
+
+      expect(subject).to receive(:run).with('gem', 'install', '-q', path)
 
       subject.install(path)
     end

data/spec/project_spec.rb

@@ -2,24 +2,27 @@ require 'spec_helper'
 require 'rubygems/tasks/project'
 
 describe Gem::Tasks::Project do
-  let(:rubygems_project) do
-    described_class.new(PROJECT_DIRS['rubygems-project'])
+  let(:rubygems_project_dir) { File.join(PROJECTS_DIR,'rubygems-project') }
+  let(:rubygems_project)     { described_class.new(rubygems_project_dir)   }
+
+  let(:rubygems_multi_project_dir) do
+    File.join(PROJECTS_DIR,'rubygems-multi-project')
   end
 
   let(:rubygems_multi_project) do
-    described_class.new(PROJECT_DIRS['rubygems-multi-project'])
+    described_class.new(rubygems_multi_project_dir)
   end
 
-  let(:bundler_project) do
-    described_class.new(PROJECT_DIRS['bundler-project'])
-  end
+  let(:bundler_project_dir) { File.join(PROJECTS_DIR,'bundler-project') }
+  let(:bundler_project)     { described_class.new(bundler_project_dir)   }
 
   describe "directories" do
+    let(:directory) { rubygems_project_dir }
+
     it "should map paths to #{described_class} instances" do
-      directory = PROJECT_DIRS['rubygems-project']
-      project   = described_class.directories[directory]
+      project = described_class.directories[directory]
 
-      project.root.should == directory
+      expect(project.root).to eq(directory)
     end
   end
 
@@ -27,7 +30,7 @@ describe Gem::Tasks::Project do
     subject { rubygems_project }
 
     it "should use the name of the directory" do
-      subject.name.should == 'rubygems-project'
+      expect(subject.name).to eq('rubygems-project')
     end
   end
 
@@ -35,7 +38,7 @@ describe Gem::Tasks::Project do
     subject { bundler_project }
 
     it "should detect the SCM used" do
-      subject.scm.should == :git
+      expect(subject.scm).to eq(:git)
     end
   end
 
@@ -44,7 +47,7 @@ describe Gem::Tasks::Project do
       subject { rubygems_project }
 
       it "should load the single-gemspec" do
-        subject.gemspecs.values.map(&:name).should == %w[rubygems-project]
+        expect(subject.gemspecs.values.map(&:name)).to eq(%w[rubygems-project])
       end
     end
 
@@ -52,10 +55,10 @@ describe Gem::Tasks::Project do
       subject { rubygems_multi_project }
 
       it "should load all gemspecs" do
-        subject.gemspecs.values.map(&:name).should =~ %w[
+        expect(subject.gemspecs.values.map(&:name)).to match_array(%w[
           rubygems-project
           rubygems-project-lite
-        ]
+        ])
       end
     end
   end
@@ -65,7 +68,7 @@ describe Gem::Tasks::Project do
       subject { rubygems_project }
 
       it "should match the directory name to the gemspec" do
-        subject.primary_gemspec.should == subject.name
+        expect(subject.primary_gemspec).to eq(subject.name)
       end
     end
 
@@ -73,7 +76,7 @@ describe Gem::Tasks::Project do
       subject { rubygems_multi_project }
 
       it "should pick the first gemspec" do
-        subject.primary_gemspec.should == 'rubygems-project'
+        expect(subject.primary_gemspec).to eq('rubygems-project')
       end
     end
   end
@@ -83,11 +86,11 @@ describe Gem::Tasks::Project do
       subject { rubygems_project }
 
       it "should default the directory name to the gemspec" do
-        subject.gemspec.name.should == subject.name
+        expect(subject.gemspec.name).to eq(subject.name)
       end
 
       it "should raise an ArgumentError for unknown gemspec names" do
-        lambda { subject.gemspec('foo') }.should raise_error(ArgumentError)
+        expect { subject.gemspec('foo') }.to raise_error(ArgumentError)
       end
     end
 
@@ -95,13 +98,13 @@ describe Gem::Tasks::Project do
       subject { rubygems_multi_project }
 
       it "should default the first gemspec" do
-        subject.gemspec.name.should == 'rubygems-project'
+        expect(subject.gemspec.name).to eq('rubygems-project')
       end
 
       it "should allow accessing alternate gemspecs" do
         alternate = 'rubygems-project-lite'
 
-        subject.gemspec(alternate).name.should == alternate
+        expect(subject.gemspec(alternate).name).to eq(alternate)
       end
     end
   end
@@ -110,20 +113,20 @@ describe Gem::Tasks::Project do
     subject { rubygems_multi_project }
 
     it "should group builds by gemspec name" do
-      subject.builds.keys.should =~ subject.gemspecs.keys
+      expect(subject.builds.keys).to be == subject.gemspecs.keys
     end
 
     it "should map a package format to a pkg/ path" do
       packages = subject.builds['rubygems-project']
 
-      packages['tar.gz'].should == 'pkg/rubygems-project-1.2.3.tar.gz'
+      expect(packages['tar.gz']).to eq('pkg/rubygems-project-1.2.3.tar.gz')
     end
 
     context "with single-gemspec project" do
       subject { rubygems_project }
 
       it "should only have a key for the single-gemspec" do
-        subject.builds.keys.should == %w[rubygems-project]
+        expect(subject.builds.keys).to eq(%w[rubygems-project])
       end
     end
 
@@ -131,10 +134,10 @@ describe Gem::Tasks::Project do
       subject { rubygems_multi_project }
 
       it "should have keys for each gemspec" do
-        subject.builds.keys.should =~ %w[
+        expect(subject.builds.keys).to match_array(%w[
           rubygems-project
           rubygems-project-lite
-        ]
+        ])
       end
     end
   end
@@ -144,7 +147,7 @@ describe Gem::Tasks::Project do
       subject { bundler_project }
 
       it "should detect the 'Gemfile' file" do
-        subject.bundler?.should be_true
+        expect(subject.bundler?).to be_truthy
       end
     end
 
@@ -152,7 +155,7 @@ describe Gem::Tasks::Project do
       subject { rubygems_project }
 
       it "should be false" do
-        subject.bundler?.should be_false
+        expect(subject.bundler?).to be_falsey
       end
     end
   end

data/spec/projects/bundler-project/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/spec/projects/bundler-project/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bundler-project.gemspec
+gemspec

data/spec/projects/bundler-project/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Postmodern
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/spec/projects/bundler-project/README.md

@@ -0,0 +1,29 @@
+# Bundler::Project
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bundler-project'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bundler-project
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/spec/projects/bundler-project/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"