rake-release 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5d71af4dc22e9d24faa21d2c014075e491f9b704
-  data.tar.gz: b74cab41e7cba25aea3ef6a1a04d2a42dd79d66e
+SHA256:
+  metadata.gz: 4f57c7ab816f8b5967fada02b402586a25a1a73ffb6fd0cd864133b56ad8afe6
+  data.tar.gz: 1e8d380cdb33c8bb029f5be948aef86d41798638919641ec7f3272b005dbf4a9
 SHA512:
-  metadata.gz: dc2b0a6c8f89dbb0a04d61da0f261e8d0e2b4745b127c6536e38b46ced6534edf5c0782c2933e7eb1a6f7191406b44b4382e1ac9ce91437936e01e87ad958a90
-  data.tar.gz: 5f423e6a51c53cf189550aeaa7918f68dfdddba4a172d3db201b4e84428c171099aec131f31782db84d76ed29ea0b16af512ec0517f4f87983768082c1226c61
+  metadata.gz: 9c04699feb9d665b3e8449b35be5ae126f70dc88cbfa8a87fba593fcef8adc33b19b24eda1f2b66faa68cd7a698f2916b5aa5ebabbae7b6f89454afe7bb76552
+  data.tar.gz: 2803b6c8d933d1c366ff0c66aa3b635841066a66b1cd3717bc0d37d6790ecfb80d9d57fc097625b980c99d1585871a957c919b556ded46d5e2696c2f689ac417

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rake-release.gemspec
 gemspec
+
+gem 'rake'

data/README.md

@@ -36,6 +36,72 @@ rake release[remote]
     Create and push tag v0.2.1, build gem and publish to rubygems.org.
 ```
 
+### With multiple gemspecs
+
+```
+> rake -T
+rake lib-alpha:build            # Build lib-alpha-0.6.0.gem.gem into the pkg directory
+rake lib-alpha:install          # Build and install lib-alpha-0.6.0.gem into system gems
+rake lib-alpha:install:local    # Build and install lib-alpha-0.6.0.gem into system gems without network access
+rake lib-alpha:release[remote]  # Create and push tag v0.6.0, build gem and publish to rubygems.org
+rake lib-beta:build             # Build lib-beta-0.8.0.gem.gem into the pkg directory
+rake lib-beta:install           # Build and install lib-beta-0.8.0.gem into system gems
+rake lib-beta:install:local     # Build and install lib-beta-0.8.0.gem into system gems without network access
+rake lib-beta:release[remote]   # Create and push tag v0.6.0, build gem and publish to rubygems.org
+```
+
+### With tag signing
+
+Enable tag signing by manually loading the task:
+
+```ruby
+require 'rake/release/task'
+
+Rake::Release::Task.new do |spec|
+  spec.sign_tag = true
+end
+```
+
+Or with multiple gems:
+
+```ruby
+require 'rake/release/task'
+
+Rake::Release::Task.load_all do |spec|
+  spec.sign_tag = true
+end
+```
+
+### Manually set namespace
+
+```ruby
+require 'rake/release/task'
+
+Rake::Release::Task.new do |spec|
+  spec.namespace = 'client'
+end
+```
+
+```
+> rake -T
+rake client:build            # Build rake-release-0.6.0.gem.gem into the pkg directory
+rake client:install          # Build and install rake-release-0.6.0.gem into system gems
+rake client:install:local    # Build and install rake-release-0.6.0.gem into system gems without network access
+rake client:release[remote]  # Create and push tag v0.6.0, build gem and publish to rubygems.org
+```
+
+### Set gem host and version tag
+
+You can customize the task e.g. with a custom git tag or gem push host:
+
+```ruby
+Rake::Release::Task.load_all do |spec|
+  spec.version_tag = "gem-v#{spec.version}"
+  spec.host = 'https://user:pass@gemhost/'
+end
+
+```
+
 # License
 
 MIT

data/Rakefile

@@ -1 +1,8 @@
-require 'rake/release'
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'rake/release/task'
+
+Rake::Release::Task.new do |spec|
+  spec.sign_tag = true
+end

data/lib/rake/release/spec.rb

@@ -15,10 +15,11 @@ module Rake
       attr_reader :gemspec
       attr_reader :gemspec_path
 
+      attr_accessor :push_host
+      attr_accessor :sign_tag
       attr_accessor :namespace
-      attr_accessor :version_tag
 
-      def initialize(path, namespace: nil)
+      def initialize(path = nil, namespace: nil, sign_tag: false)
         path = Task.pwd.join(path.to_s).expand_path
 
         if path.directory?
@@ -36,21 +37,18 @@ module Rake
 
         @gemspec = Bundler.load_gemspec @gemspec_path
 
-        raise RuntimeError.new 'Cannot load gemspec' unless @gemspec
+        raise 'Cannot load gemspec' unless @gemspec
 
-        if @gemspec.metadata.fetch('allowed_push_host', nil)
-          @allowed_push_host = URI @gemspec.metadata['allowed_push_host']
+        @push_host = URI 'https://rubygems.org'
+
+        unless @gemspec.metadata['allowed_push_host'].to_s.empty?
+          @push_host = URI @gemspec.metadata['allowed_push_host']
         end
 
-        @version_tag = true
-      end
+        @sign_tag = sign_tag
+        @namespace = namespace
 
-      def push_host
-        if @allowed_push_host
-          @allowed_push_host
-        else
-          @push_host ||= URI 'https://rubygems.org'
-        end
+        yield self if block_given?
       end
 
       def push_host=(value)
@@ -76,18 +74,8 @@ module Rake
         @pkg_file_path ||= pkg_path.join pkg_file_name
       end
 
-      def version_tag?
-        @version_tag ? true : false
-      end
-
       def version_tag
-        if @version_tag.respond_to? :call
-          @version_tag.call(self).to_s
-        elsif @version_tag.respond_to? :to_str
-          @version_tag.to_str
-        else
-          "v#{version}"
-        end
+        "v#{version}"
       end
 
       class << self
@@ -100,7 +88,7 @@ module Rake
         def scan(path = Task.pwd.join('*.gemspec'))
           Pathname
             .glob(path)
-            .map { |path| Rake::Release::Spec.load path }
+            .map { |m| Rake::Release::Spec.load(m) }
             .reject(&:nil?)
         end
       end

data/lib/rake/release/task.rb

@@ -13,12 +13,10 @@ module Rake
       include Rake::DSL
 
       def initialize(spec = nil, **kwargs, &block)
-        @spec = spec || Rake::Release::Spec.new(**kwargs, &block)
+        @spec = spec || Rake::Release::Spec.new(spec, **kwargs, &block)
 
-        namespace = kwargs[:namespace] || @spec.namespace
-
-        if namespace
-          send(:namespace, namespace) { setup }
+        if @spec.namespace
+          send(:namespace, @spec.namespace) { setup }
         else
           setup
         end
@@ -27,47 +25,38 @@ module Rake
       protected
 
       def setup
-        desc <<-EOF.strip
-          Build #{@spec.pkg_file_name}.gem into the pkg directory.
-        EOF
+        desc "Build #{@spec.pkg_file_name}.gem into the pkg directory."
         task(:build) { build }
 
-        desc <<-EOF.strip
-          Build and install #{@spec.pkg_file_name} into system gems.
-        EOF
+        desc "Build and install #{@spec.pkg_file_name} into system gems."
         task(install: [:build]) { install }
 
-        desc <<-EOF.strip
-          Build and install #{@spec.pkg_file_name} into system gems without network access.
-        EOF
+        desc "Build and install #{@spec.pkg_file_name} into " \
+             'system gems without network access.'
         task('install:local' => [:build]) { install local: true }
 
-        desc ''.tap { |str|
-          str << if @spec.version_tag?
-                   "Create and push tag #{@spec.version_tag}, build"
-                 else
-                   'Build'
-                 end
-
-          str << "and publish to #{@spec.push_host_name}."
-        }
-        task :release, [:remote] => %w(build release:push release:publish)
+        if @spec.sign_tag
+          desc "Create, sign and push tag #{@spec.version_tag}, " \
+               "build gem and publish to #{@spec.push_host_name}."
+        else
+          desc "Create and push tag #{@spec.version_tag}, " \
+               "build gem and publish to #{@spec.push_host_name}."
+        end
+        task :release, [:remote] => %w[build release:push release:publish]
 
         task 'release:guard:clean' do
           guard_clean
         end
 
         task 'release:guard:tag' do
-          guard_tag if @spec.version_tag?
+          guard_tag
         end
 
-        task 'release:push', [:remote] => %w(release:guard:clean) do |_, args|
-          if @spec.version_tag? && !already_tagged?
-            tag_version { git_push(args[:remote]) }
-          end
+        task 'release:push', [:remote] => %w[release:guard:clean] do |_, args|
+          tag_version { git_push(args[:remote]) } unless already_tagged?
         end
 
-        task 'release:publish' => %w(release:guard:tag) do
+        task 'release:publish' => %w[release:guard:tag] do
           publish if publish?
         end
       end
@@ -78,11 +67,12 @@ module Rake
       end
 
       def guard_tag
-        out, ret = sh! 'git', 'tag', '--points-at', 'HEAD'
+        out, = sh! 'git', 'tag', '--points-at', 'HEAD'
 
-        unless out.split("\n").include? @spec.version_tag
-          raise "Tag #{@spec.version_tag} does not point to current HEAD. Cannot release wrong code."
-        end
+        return if out.split("\n").include? @spec.version_tag
+
+        raise "Tag #{@spec.version_tag} does not point to current HEAD. " \
+              'Cannot release wrong code.'
       end
 
       def build
@@ -91,54 +81,60 @@ module Rake
         sh! 'gem', 'build', '-V', @spec.gemspec_path
 
         @spec.pkg_path.mkpath
-        FileUtils.mv @spec.pkg_file_name, @spec.pkg_path.join(@spec.pkg_file_name)
+        FileUtils.mv @spec.pkg_file_name,
+                     @spec.pkg_path.join(@spec.pkg_file_name)
 
-        Task.ui.confirm "#{@spec.name} #{@spec.version} built to #{@spec.pkg_path}."
+        Task.ui.confirm \
+          "#{@spec.name} #{@spec.version} built to #{@spec.pkg_path}."
       end
 
       def install(local: false)
-        cmd = %w(gem install) + [@spec.pkg_file_path]
+        cmd = %w[gem install] + [@spec.pkg_file_path]
         cmd << '--local' if local
 
-        sh! *cmd
+        sh!(*cmd)
 
         Task.ui.confirm "#{@spec.name} (#{@spec.version}) installed."
       end
 
       def publish
-        cmd = %w(gem push)
-        cmd << @spec.pkg_file_path
-        cmd << '--host'
-        cmd << @spec.push_host
+        cmd = %w[gem push]
+        cmd << @spec.pkg_file_path << '--host' << @spec.push_host
 
-        sh! *cmd
+        sh!(*cmd)
 
         Task.ui.confirm "Pushed #{@spec.pkg_file_name} to #{@spec.push_host}"
       end
 
       def git_clean
-        clean? && committed? || raise('There are files that need to be committed first.')
+        clean? && committed? ||
+          raise('There are files that need to be committed first.')
       end
 
       def clean?
-        out, ret = sh 'git', 'diff', '--exit-code'
+        _, ret = sh 'git', 'diff', '--exit-code'
 
-        ret == 0
+        ret.zero?
       end
 
       def committed?
-        out, ret = sh 'git', 'diff-index', '--quiet', '--cached', 'HEAD'
+        _, ret = sh 'git', 'diff-index', '--quiet', '--cached', 'HEAD'
 
-        ret == 0
+        ret.zero?
       end
 
       def tag_version
-        sh! 'git', 'tag', '-a', '-m', "Version #{@spec.version}", @spec.version_tag
+        cmd = %w[git tag --annotate]
+        cmd << '--sign' if @spec.sign_tag
+        cmd << '--message' << "Version #{@spec.version}"
+        cmd << @spec.version_tag
+
+        sh!(*cmd)
 
         Task.ui.confirm "Tagged #{@spec.version_tag}."
 
         yield if block_given?
-      rescue
+      rescue StandardError
         Task.ui.error "Untagging #{@spec.version_tag} due to error."
 
         sh! 'git', 'tag', '-d', @spec.version_tag
@@ -147,7 +143,7 @@ module Rake
       end
 
       def already_tagged?
-        out, ret = sh 'git', 'tag'
+        out, = sh 'git', 'tag'
 
         return false unless out.split(/\n/).include? @spec.version_tag
 
@@ -157,18 +153,18 @@ module Rake
       end
 
       def git_push(remote)
-        cmd = %w(git push --quiet)
+        cmd = %w[git push --quiet]
 
         cmd << remote unless remote.to_s.empty?
 
-        sh! *cmd
-        sh! *cmd, '--tags'
+        sh!(*cmd)
+        sh!(*cmd, '--tags')
 
         Task.ui.confirm 'Pushed git commits and tags.'
       end
 
       def publish?
-        ! %w(n no nil false off 0).include?(ENV['gem_push'].to_s.downcase)
+        !%w[n no nil false off 0].include?(ENV['gem_push'].to_s.downcase)
       end
 
       def sh!(*cmd, **kwargs, &block)
@@ -177,7 +173,7 @@ module Rake
         out, ret = sh(*cmd, **kwargs, &block)
 
         if ret != 0
-          raise RuntimeError.new <<-EOS.gsub /^\s*\.?/, ''
+          raise <<-EOS.gsub(/^\s*\.?/, '')
             Running `#{cmd}` failed, exit code: #{ret}
             .#{out.gsub(/\n/, "\n  ")}
           EOS
@@ -186,7 +182,7 @@ module Rake
         [out, ret]
       end
 
-      def sh(*cmd, chdir: @spec.base, raise_error: true)
+      def sh(*cmd, chdir: @spec.base)
         cmd = cmd.flatten.map(&:to_s)
 
         Task.ui.debug cmd
@@ -204,11 +200,14 @@ module Rake
         def load_all(dir = pwd)
           specs = Spec.scan dir.join('**/*.gemspec')
 
-          specs.each { |spec| spec.namespace = spec.name } if specs.size > 1
+          if specs.size > 1
+            specs.each { |spec| spec.namespace = spec.name }
+          end
+
           specs.each(&Proc.new) if block_given?
 
           if specs.uniq { |s| s.namespace.to_s.strip }.size != specs.size
-            raise RuntimeError.new 'Non distinct release task namespaces'
+            raise 'Non distinct release task namespaces'
           end
 
           specs.each { |spec| Task.new spec }

data/rake-release.gemspec

@@ -1,8 +1,6 @@
-# coding: utf-8
-
 Gem::Specification.new do |spec|
   spec.name          = 'rake-release'
-  spec.version       = '0.5.0'
+  spec.version       = '1.0.0'
   spec.authors       = ['Jan Graichen']
   spec.email         = ['jgraichen@altimos.de']
   spec.licenses      = ['MIT']
@@ -13,10 +11,9 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.require_paths = %w(lib)
+  spec.require_paths = %w[lib]
 
   spec.add_dependency 'bundler', '~> 1.11'
 
   spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rake-release
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-27 00:00:00.000000000 Z
+date: 2018-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
 description: Configurable fork of bundlers release tasks.
 email:
 - jgraichen@altimos.de
@@ -90,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Configurable fork of bundlers release tasks.