rubygems-tasks 0.2.6 → 0.3.0

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

@@ -1,8 +1,10 @@
-require 'rubygems/tasks/task'
+# frozen_string_literal: true
+
+require_relative '../task'
 
 module Gem
   class Tasks
-    module SCM
+    class SCM
       #
       # The `scm:status` task.
       #
@@ -11,10 +13,7 @@ module Gem
         #
         # Initializes the `status` task.
         #
-        # @param [Hash] options
-        #   Additional options.
-        #
-        def initialize(options={})
+        def initialize
           super()
 
           yield self if block_given?

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

@@ -1,8 +1,10 @@
-require 'rubygems/tasks/task'
+# frozen_string_literal: true
+
+require_relative '../task'
 
 module Gem
   class Tasks
-    module SCM
+    class SCM
       #
       # The `scm:tag` task.
       #
@@ -15,7 +17,6 @@ module Gem
         #
         # @return [String, Proc]
         #   The format String or Proc.
-        #
         attr_accessor :format
 
         # Enables or disables PGP signing of tags.
@@ -24,26 +25,22 @@ module Gem
         #   The new value.
         #
         # @since 0.2.0
-        #
         attr_writer :sign
 
         #
         # Initializes the `scm:tag` task.
         #
-        # @param [Hash] options
-        #   Additional options.
-        #
-        # @option options [String, Proc] :format (DEFAULT_FORMAT)
+        # @param [String, Proc] format
         #   The format String or Proc for version tags.
         #
-        # @option options [Boolean] :sign
+        # @param [Boolean] sign
         #   Enables PGP signing of tags.
         #
-        def initialize(options={})
+        def initialize(format: DEFAULT_FORMAT, sign: nil)
           super()
 
-          @format = options.fetch(:format,DEFAULT_FORMAT)
-          @sign   = options[:sign]
+          @format = format
+          @sign   = sign
 
           yield self if block_given?
           define

data/lib/rubygems/tasks/scm.rb

@@ -1,3 +1,52 @@
-require 'rubygems/tasks/scm/status'
-require 'rubygems/tasks/scm/tag'
-require 'rubygems/tasks/scm/push'
+# frozen_string_literal: true
+
+require_relative 'scm/status'
+require_relative 'scm/tag'
+require_relative 'scm/push'
+
+module Gem
+  class Tasks
+    class SCM
+
+      # The {Status scm:status} task.
+      #
+      # @return [Status, nil]
+      #
+      # @since 0.3.0
+      attr_reader :status
+
+      # The {Tag scm:tag} task.
+      #
+      # @return [Tag, nil]
+      #
+      # @since 0.3.0
+      attr_reader :tag
+
+      # The {Push scm:push} task.
+      #
+      # @return [Push, nil]
+      #
+      # @since 0.3.0
+      attr_reader :push
+
+      #
+      # Initializes the `scm:*` tasks.
+      #
+      # @param [Boolean] status
+      #   Enables or disables the {SCM::Status scm:status} task.
+      #
+      # @param [Boolean] tag
+      #   Enables or disables the {SCM::Tag scm:tag} task.
+      #
+      # @param [Boolean] push
+      #   Enables or disables the {SCM::Push scm:push} task.
+      #
+      def initialize(status: true, tag: true, push: true)
+        @status = (Status.new if status)
+        @tag    = (Tag.new    if tag)
+        @push   = (Push.new   if push)
+      end
+
+    end
+  end
+end

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

@@ -1,52 +1,59 @@
-require 'rubygems/tasks/sign/task'
+# frozen_string_literal: true
+
+require_relative 'task'
 
 require 'digest'
 
 module Gem
   class Tasks
-    module Sign
+    class Sign
       #
       # The `sign:checksum` task.
       #
       class Checksum < Task
 
         # Enables or disables MD5 checksums.
+        #
+        # @return [Boolean]
         attr_writer :md5
 
         # Enables or disables SHA1 checksums.
+        #
+        # @return [Boolean]
         attr_writer :sha1
 
         # Enables or disables SHA2 checksums.
+        #
+        # @return [Boolean]
         attr_writer :sha2
 
         # Enables or disables SHA512 checksums.
+        #
+        # @return [Boolean]
         attr_writer :sha512
 
         #
         # Initializes the `sign:checksum` task.
         #
-        # @param [Hash] options
-        #   Digest options.
-        #
-        # @option options [Boolean] :md5 (true)
+        # @param [Boolean] md5
         #   Specifies whether MD5 checksums are enabled.
         #
-        # @option options [Boolean] :sha1 (true)
+        # @param [Boolean] sha1
         #   Specifies whether SHA1 checksums are enabled.
         #
-        # @option options [Boolean] :sha2 (false)
+        # @param [Boolean] sha2
         #   Specifies whether SHA2 checksums are enabled.
         #
-        # @option options [Boolean] :sha512 (false)
+        # @param [Boolean] sha512
         #   Specifies whether SHA512 checksums are enabled.
         #
-        def initialize(options={})
+        def initialize(md5: true, sha1: true, sha2: false, sha512: false)
           super()
 
-          @md5    = options.fetch(:md5,   true)
-          @sha1   = options.fetch(:sha1,  true)
-          @sha2   = options.fetch(:sha2,  false)
-          @sha512 = options.fetch(:sha512,false)
+          @md5    = md5
+          @sha1   = sha1
+          @sha2   = sha2
+          @sha512 = sha512
 
           yield self if block_given?
           define

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

@@ -1,8 +1,10 @@
-require 'rubygems/tasks/sign/task'
+# frozen_string_literal: true
+
+require_relative 'task'
 
 module Gem
   class Tasks
-    module Sign
+    class Sign
       #
       # The `sign:pgp` task.
       #
@@ -11,10 +13,7 @@ module Gem
         #
         # Initializes the `sign` task.
         #
-        # @param [Hash] options
-        #   Digest options.
-        #
-        def initialize(options={})
+        def initialize
           super()
 
           yield self if block_given?

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

@@ -1,10 +1,12 @@
-require 'rubygems/tasks/task'
+# frozen_string_literal: true
+
+require_relative '../task'
 
 require 'digest'
 
 module Gem
   class Tasks
-    module Sign
+    class Sign
       class Task < Tasks::Task
 
         #

data/lib/rubygems/tasks/sign.rb

@@ -1,2 +1,42 @@
-require 'rubygems/tasks/sign/checksum'
-require 'rubygems/tasks/sign/pgp'
+# frozen_string_literal: true
+
+require_relative 'sign/checksum'
+require_relative 'sign/pgp'
+
+module Gem
+  class Tasks
+    class Sign
+
+      # The {Checksum sign:checksum} task.
+      #
+      # @return [Checksum, nil]
+      #
+      # @since 0.3.0
+      attr_reader :checksum
+
+      # The {PGP sign:pgp} task.
+      #
+      # @return [PGP, nil]
+      #
+      # @since 0.3.0
+      attr_reader :pgp
+
+      #
+      # Initializes the `scm:*` tasks.
+      #
+      # @param [Boolean] checksum
+      #   Enables or disables the {Checksum sign:checksum} task.
+      #
+      # @param [Boolean] pgp
+      #   Enables or disables the {PGP sign:pgp} task.
+      #
+      # @since 0.3.0
+      #
+      def initialize(checksum: nil, pgp: nil)
+        @checksum = (Checksum.new if checksum)
+        @pgp      = (PGP.new      if pgp)
+      end
+
+    end
+  end
+end

data/lib/rubygems/tasks/task.rb

@@ -1,5 +1,7 @@
-require 'rubygems/tasks/project'
-require 'rubygems/tasks/printing'
+# frozen_string_literal: true
+
+require_relative 'project'
+require_relative 'printing'
 
 require 'rake/tasklib'
 

data/lib/rubygems/tasks.rb

@@ -1,13 +1,14 @@
-require 'rubygems/tasks/console'
-require 'rubygems/tasks/build'
-require 'rubygems/tasks/install'
-require 'rubygems/tasks/scm'
-require 'rubygems/tasks/push'
-require 'rubygems/tasks/release'
-require 'rubygems/tasks/sign'
+# frozen_string_literal: true
+
+require_relative 'tasks/console'
+require_relative 'tasks/build'
+require_relative 'tasks/install'
+require_relative 'tasks/scm'
+require_relative 'tasks/push'
+require_relative 'tasks/release'
+require_relative 'tasks/sign'
 
 require 'rake/tasklib'
-require 'ostruct'
 
 module Gem
   #
@@ -28,28 +29,19 @@ module Gem
   #
   class Tasks
 
+    # The {Build build:\*} tasks.
     #
-    # The `build` tasks.
-    #
-    # @return [OpenStruct]
-    #   The collection of `build` tasks.
-    #
+    # @return [Build]
     attr_reader :build
 
+    # The {SCM scm:\*} tasks.
     #
-    # The `scm` tasks.
-    #
-    # @return [OpenStruct]
-    #   The collection of `scm` tasks.
-    #
+    # @return [SCM]
     attr_reader :scm
 
+    # The {Sign sign:\*} tasks.
     #
-    # The `sign` tasks.
-    #
-    # @return [OpenStruct]
-    #   The collection of `sign` tasks.
-    #
+    # @return [Sign]
     attr_reader :sign
 
     # The {Console console} task.
@@ -67,30 +59,54 @@ module Gem
     #
     # Initializes the project tasks.
     #
-    # @param [Hash{Symbol => Hash}] options
-    #   Enables or disables individual tasks.
+    # @param [Hash{Symbol => Boolean}] build
+    #   Enables or disables the `build` tasks. Additional keyword arguments
+    #   can be passed to the individual build tasks via a Hash.
+    #
+    # @option build [Boolean] :gem (true)
+    #   Enables or disables the {Build::Gem build:gem} task.
+    #
+    # @option build [Boolean] :tar
+    #   Enables or disables the {Build::Tar build:tar} task.
+    #
+    # @option build [Boolean] :zip
+    #   Enables or disables the {Build::Zip build:zip} task.
+    #
+    # @param [Hash{Symbol => Boolean}] scm
+    #   Enables or disables the `scm` tasks. Additional keyword arguments
+    #   can be passed to the individual scm tasks via a Hash.
     #
-    # @option options [Hash{Symbol => Boolean}] :build
-    #   Enables or disables the `build` tasks.
+    # @option scm [Boolean] :status (true)
+    #   Enables or disables the {SCM::Status scm:status} task.
     #
-    # @option options [Hash{Symbol => Boolean}] :scm
-    #   Enables or disables the `scm` tasks.
+    # @option scm [Boolean] :tag (true)
+    #   Enables or disables the {SCM::Tag scm:tag} task.
     #
-    # @option options [Boolean] :console (true)
+    # @option scm [Boolean] :push (true)
+    #   Enables or disables the {SCM::Push scm:push} task.
+    #
+    # @param [Hash{Symbol => Boolean}] sign
+    #   Enables or disables the `sign` tasks. Additional keyword arguments
+    #   can be passed to the individual sign tasks via a Hash.
+    #
+    # @option sign [Boolean] :checksum
+    #   Enables or disables the {Sign::Checksum sign:checksum} task.
+    #
+    # @option sign [Boolean] :pgp
+    #   Enables or disables the {Sign::PGP sign:pgp} task.
+    #
+    # @param [Boolean] console
     #   Enables or disables the {Console console} task.
     #
-    # @option options [Boolean] :install (true)
+    # @param [Boolean] install
     #   Enables or disables the {Install install} task.
     #
-    # @option options [Boolean] :push (true)
+    # @param [Boolean] push
     #   Enables or disables the {Push push} task.
     #
-    # @option options [Boolean] :release (true)
+    # @param [Boolean] release
     #   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.
@@ -109,36 +125,21 @@ module Gem
     #     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))
+    def initialize(build:   {},
+                   scm:     {},
+                   sign:    {},
+                   console: true,
+                   install: true,
+                   push:    true,
+                   release: true)
+      @scm   = SCM.new(**scm)
+      @build = Build.new(**build)
+      @sign  = Sign.new(**sign)
+
+      @console = (Console.new if console)
+      @install = (Install.new if install)
+      @push    = (Push.new    if push)
+      @release = (Release.new if release)
 
       yield self if block_given?
     end

data/spec/build_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+require 'rake_context'
+
+require 'rubygems/tasks/build'
+
+describe Gem::Tasks::Build do
+  include_context "rake"
+
+  describe "#initialize" do
+    context "when given no keyword arguments" do
+      it "must initialize #gem by default" do
+        expect(subject.gem).to be_a(Gem::Tasks::Build::Gem)
+      end
+
+      it "must not initialize #tar by default" do
+        expect(subject.tar).to be(nil)
+      end
+
+      it "must not initialize #zip by default" do
+        expect(subject.zip).to be(nil)
+      end
+    end
+
+    context "when given `gem: true`" do
+      subject { described_class.new(gem: true) }
+
+      it "must initialize #gem" do
+        expect(subject.gem).to be_a(Gem::Tasks::Build::Gem)
+      end
+    end
+
+    context "when given `gem: false`" do
+      subject { described_class.new(gem: false) }
+
+      it "must not initialize #gem" do
+        expect(subject.gem).to be(nil)
+      end
+    end
+
+    context "when given `tar: true`" do
+      subject { described_class.new(tar: true) }
+
+      it "must initialize #tar" do
+        expect(subject.tar).to be_a(Gem::Tasks::Build::Tar)
+      end
+    end
+
+    context "when given `tar: false`" do
+      subject { described_class.new(tar: false) }
+
+      it "must not initialize #tar" do
+        expect(subject.tar).to be(nil)
+      end
+    end
+
+    context "when given `zip: true`" do
+      subject { described_class.new(zip: true) }
+
+      it "must initialize #zip" do
+        expect(subject.zip).to be_a(Gem::Tasks::Build::Zip)
+      end
+    end
+
+    context "when given `zip: false`" do
+      subject { described_class.new(zip: false) }
+
+      it "must not initialize #zip" do
+        expect(subject.zip).to be(nil)
+      end
+    end
+  end
+end

data/spec/console_spec.rb

@@ -13,24 +13,24 @@ describe Gem::Tasks::Console do
     let(:custom_options)  { %w[-Ivendor -rfoo] }
 
     context "defaults" do
-      context "when project.bundler? == false" do
+      context "when the project does not use Bundler" do
         before do
           allow(subject.project).to receive(:bundler?).and_return(false)
         end
 
-        it "should run `irb`" do
+        it "must run `irb`" do
           expect(subject).to receive(:run).with('irb',*default_options)
 
           subject.console
         end
       end
 
-      context "when project.bundler? == true" do
+      context "when the project does use Bundler" do
         before do
           allow(subject.project).to receive(:bundler?).and_return(true)
         end
 
-        it "should use `bundle exec`" do
+        it "must use `bundle exec`" do
           expect(subject).to receive(:run).with(
             'bundle', 'exec', 'irb', *default_options
           )
@@ -40,27 +40,27 @@ describe Gem::Tasks::Console do
       end
     end
 
-    context "with custom command" do
-      subject { described_class.new(:command => custom_command) }
+    context "with a custom command" do
+      subject { described_class.new(command: custom_command) }
 
-      context "when project.bundler? == false" do
+      context "when the project does not use Bundler" do
         before do
           allow(subject.project).to receive(:bundler?).and_return(false)
         end
 
-        it "should run the custom console" do
+        it "must 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
+      context "when the project does use Bundler" do
         before do
           allow(subject.project).to receive(:bundler?).and_return(true)
         end
 
-        it "should use `bundle exec`" do
+        it "must use `bundle exec`" do
           expect(subject).to receive(:run).with(
             'bundle', 'exec', custom_command, *default_options
           )
@@ -71,26 +71,26 @@ describe Gem::Tasks::Console do
     end
 
     context "with custom options" do
-      subject { described_class.new(:options => custom_options) }
+      subject { described_class.new(options: custom_options) }
 
-      context "when project.bundler? == false" do
+      context "when the project does not use Bundler" do
         before do
           allow(subject.project).to receive(:bundler?).and_return(false)
         end
 
-        it "should pass custom options to `irb`" do
+        it "must pass custom options to `irb`" do
           expect(subject).to receive(:run).with('irb', *(default_options + custom_options))
 
           subject.console
         end
       end
 
-      context "when project.bundler? == true" do
+      context "when the project does use Bundler" do
         before do
           allow(subject.project).to receive(:bundler?).and_return(true)
         end
 
-        it "should use `bundle exec ...`" do
+        it "must use `bundle exec ...`" do
           expect(subject).to receive(:run).with('bundle', 'exec', 'irb', *(default_options + custom_options))
 
           subject.console

data/spec/install_spec.rb

@@ -7,7 +7,7 @@ describe Gem::Tasks::Install do
   describe "#install" do
     let(:path) { 'pkg/foo-1.2.3.gem' }
 
-    it "should use `gem install -q`" do
+    it "must use `gem install -q`" do
       if defined?(Bundler)
         expect(Bundler).to receive(:with_original_env).and_yield()
       end