gem-release 2.0.0.dev.5 → 2.0.0.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6eec8f1a113b0850b5700b9226b6350cad8167f3
-  data.tar.gz: bda046a3fa483a9d09f7f493146266e17241dbd8
+  metadata.gz: 195c4cc3e957a72b5fd32d7b8988d4fb58afc373
+  data.tar.gz: 88be1c1f3b825670de7da30c65f19244494e625a
 SHA512:
-  metadata.gz: 458818e6e27ae01927d51a6813f08d07d9359cfe6e6a682c33494127bde073d2b4b1b692868e8e2451eef497fe7b74811459c099413b51f7b2fafdb8254e8b33
-  data.tar.gz: a68e3c396bdcb8295ac1c05ff50a36f78b494c418d341619635431c3cfde56789005549d8c41c218277e82ff30b6f7adeb4b271976cce9bf9f16f7142266b400
+  metadata.gz: 871a21b9858931a0b7b2c374eb553a5a70f61e3d6b26055b7975ade21e20ea36d597a28083073bab27128297b1b39dd9cae79cf080f0eeb2877be831d6f03694
+  data.tar.gz: 24d5cbd92af1a4726328750b880d9871379891935667184b6638de34b6ef0e1aad020be8d87bbdf2c3cf13a2c3badc79bfdfa4f2d52d90eff07957b4dfcfd54b

data/CHANGELOG.md

@@ -6,22 +6,21 @@ This is a major rewrite, 7 years after the initial implementation.
 
 ### Major changes
 
-* Consistent config format, using config files, environment variables, and
-  command line options
+* Consistent config format, using config files, environment variables, and command line options
 * Custom template groups for `gem bootstrap`
 * Complete help output in `gem [command] --help`
-* Consistent behaviour in multi-gem scenarios (see the
-  [README](https://github.com/svenfuchs/gem-release/blob/master/README.md#scenarios))
+* Consistent behaviour in multi-gem scenarios (see the [README](https://github.com/svenfuchs/gem-release/blob/master/README.md#scenarios))
 * Consistent command line option defaults across commands when invoked with a
   shortcut, e.g. `gem bump --release --tag` vs `gem release --tag`
 * Colorized, more consistently formatted output
+* Parse friendly output on all commands when not on a tty (e.g. `gem bump --pretend --no-commit | awk '{ print $4 }')
 
 ### Other changes
 
 * Fix misleading success message when `gem push` fails
 * Release and tag now fail if there are uncommitted changes
-* Add `--message` and `--skip-ci` to `gem bump` in order to customize the
-  commit message
-* Add `--sign` to `gem bump` and `gem tag` in order to GPG sign commits and
-  tags
+* Add `--message` and `--skip-ci` to `gem bump` in order to customize the commit message
+* Add `--branch` to `gem bump` in order to switch to a new branch
+* Add `--sign` to `gem bump` and `gem tag` in order to GPG sign commits and tags
+* Add `--no-color` to all commands
 * Support version files of gems with an `*_rb` suffix

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gem-release (2.0.0.dev.4)
+    gem-release (2.0.0.dev.5)
 
 GEM
   remote: https://rubygems.org/
@@ -69,4 +69,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   1.14.6
+   1.16.0.pre.2

data/lib/gem/release/cmds/base.rb

@@ -34,10 +34,14 @@ module Gem
 
           def descr(opt)
             descr = self::DESCR[opt]
-            descr = "#{descr} (default: #{self::DEFAULTS[opt]})" if self::DEFAULTS.key?(opt)
+            descr = "#{descr} (default: #{default(opt)})" if default(opt)
             descr
           end
 
+          def default(opt)
+            Base::DEFAULTS[opt] || self::DEFAULTS[opt]
+          end
+
           def usage(usage = nil)
             usage ? @usage = usage : @usage || '[usage]'
           end
@@ -53,6 +57,16 @@ module Gem
           end
         end
 
+        DEFAULTS = {
+          color:   true,
+          pretend: false,
+          quiet:   false
+        }
+
+        opt '--[no-]color' do |value|
+          opts[:color] = value
+        end
+
         opt '--pretend' do
           opts[:pretend] = true
         end

data/lib/gem/release/cmds/bootstrap.rb

@@ -194,12 +194,12 @@ module Gem
           end
 
           def create_repo
-            cmd :git_remote, remote, "#{github_user_name}/#{gem.name}"
+            cmd :git_remote, remote, "#{git.user_login}/#{gem.name}"
             cmd :git_push, remote if opts[:push]
           end
 
           def data
-            Data.new(system, gem, opts).data
+            Data.new(git, gem, opts).data
           end
 
           def remote

data/lib/gem/release/cmds/bump.rb

@@ -43,6 +43,7 @@ module Gem
 
         DESCR = {
           version: 'Target version: next [major|minor|patch|pre|release] or a given version number [x.x.x]',
+          branch:  'Check out a new branch for the target version (e.g. `v1.0.0`)',
           commit:  'Create a commit after incrementing gem version',
           message: 'Commit message template',
           skip_ci: 'Add the [skip ci] tag to the commit message',
@@ -59,10 +60,12 @@ module Gem
           commit:  true,
           message: 'Bump %{name} to %{version} %{skip_ci}',
           push:    false,
+          branch:  false,
           remote:  'origin',
           skip_ci: false,
           sign:    false,
-          recurse: false
+          recurse: false,
+          pretend: false
         }
 
         opt '-v', '--version VERSION', descr(:version) do |value|
@@ -93,6 +96,10 @@ module Gem
           opts[:sign] = value
         end
 
+        opt '--branch [BRANCH]', descr(:branch) do |value|
+          opts[:branch] = value.nil? ? true : value
+        end
+
         opt '-t', '--tag', descr(:tag) do |value|
           opts[:tag] = value
         end
@@ -113,6 +120,7 @@ module Gem
           bump:          'Bumping %s from version %s to %s',
           version:       'Changing version in %s from %s to %s',
           git_add:       'Staging %s',
+          git_checkout:  'Checking out branch %s',
           git_commit:    'Creating commit',
           git_push:      'Pushing to the %s git repository',
           git_dirty:     'Uncommitted changes found. Please commit or stash.',
@@ -121,14 +129,16 @@ module Gem
         }
 
         CMDS = {
-          git_add:    'git add %s',
-          git_commit: 'git commit -m %p %s',
-          git_push:   'git push %s'
+          git_checkout: 'git checkout -b %s',
+          git_add:      'git add %s',
+          git_commit:   'git commit -m %p %s',
+          git_push:     'git push %s'
         }
 
         def run
           in_gem_dirs do
             validate
+            checkout if opts[:branch]
             bump
             commit if opts[:commit]
             push   if opts[:commit] && opts[:push]
@@ -141,11 +151,15 @@ module Gem
         private
 
           def validate
-            abort :git_dirty unless git_clean?
-            abort :no_git_remote, remote if push? && !git_remotes.include?(remote.to_s)
+            abort :git_dirty unless git.clean?
+            abort :no_git_remote, remote if push? && !git.remotes.include?(remote.to_s)
             abort :not_found, gem.name, version.path || '?' unless version.exists?
           end
 
+          def checkout
+            cmd :git_checkout, branch
+          end
+
           def bump
             announce :bump, gem.name, version.from, version.to
             return true if pretend?
@@ -170,6 +184,15 @@ module Gem
             Release.new(context, args, except(opts, :tag)).run
           end
 
+          def branch
+            case opts[:branch]
+            when ::String
+              opts[:branch]
+            when true
+              "v#{version.to}"
+            end
+          end
+
           def message
             args = { name: gem.name, skip_ci: opts[:skip_ci] ? '[skip ci]' : '' }
             args = args.merge(version.to_h)

data/lib/gem/release/cmds/gemspec.rb

@@ -77,7 +77,7 @@ module Gem
           end
 
           def data
-            Data.new(system, gem, opts).data
+            Data.new(git, gem, opts).data
           end
       end
     end

data/lib/gem/release/cmds/release.rb

@@ -79,7 +79,7 @@ module Gem
         private
 
           def validate
-            abort :git_dirty unless git_clean?
+            abort :git_dirty unless git.clean?
           end
 
           def release

data/lib/gem/release/cmds/runner.rb

@@ -3,7 +3,7 @@ require 'gem/release/context'
 module Gem
   module Release
     module Cmds
-      class Runner < Struct.new(:context, :name, :args, :opts)
+      class Runner < Struct.new(:name, :args, :opts, :context)
         def run
           run_cmd
           success
@@ -11,6 +11,10 @@ module Gem
 
         private
 
+          def success
+            context.ui.success "All is good, thanks my friend."
+          end
+
           def run_cmd
             const.new(context, args, opts).run
           end
@@ -19,28 +23,20 @@ module Gem
             Base[name]
           end
 
-          def opts
-            except(super, :args, :build_args)
-          end
-
           def args
             super.select { |arg| arg.is_a?(String) && arg[0] != '-' }
           end
 
-          def success
-            context.success "All is good, thanks my friend." unless quiet?
-          end
-
-          def quiet?
-            opts[:quiet] || opts[:silent]
-          end
-
           def opts
-            @opts ||= config.merge(super)
+            @opts ||= except(Base::DEFAULTS.merge(config.merge(super)), :args, :build_args)
           end
 
           def config
-            context.config.for(name.to_sym)
+            Context.new.config.for(name.to_sym)
+          end
+
+          def context
+            @context ||= super || Context.new(opts)
           end
 
           def except(hash, *keys)

data/lib/gem/release/cmds/tag.rb

@@ -35,7 +35,7 @@ module Gem
           sign:   'GPG sign the tag',
         }
 
-        opt '-p', '--push', descr(:push) do |value|
+        opt '-p', '--[no-]push', descr(:push) do |value|
           opts[:push] = value
         end
 
@@ -72,8 +72,8 @@ module Gem
         private
 
           def validate
-            abort :git_dirty unless git_clean?
-            abort :no_remote, remote if push? && !git_remotes.include?(remote)
+            abort :git_dirty unless git.clean?
+            abort :no_remote, remote if push? && !git.remotes.include?(remote)
           end
 
           def tag_and_push
@@ -83,7 +83,7 @@ module Gem
           end
 
           def exists?
-            git_tags.include?(tag_name)
+            git.tags.include?(tag_name)
           end
 
           def tag

data/lib/gem/release/context.rb

@@ -1,59 +1,30 @@
 require 'gem/release/context/gem'
+require 'gem/release/context/git'
 require 'gem/release/context/paths'
-require 'gem/release/context/system'
+require 'gem/release/context/ui'
 
 module Gem
   module Release
     class Context
-      class << self
-        attr_accessor :last
-      end
-
-      attr_accessor :config, :gem, :system
-
-      COLORS = {
-        red:    "\e[31m",
-        green:  "\e[32m",
-        yellow: "\e[33m",
-        blue:   "\e[34m",
-        gray:   "\e[37m",
-        reset:  "\e[0m"
-      }
+      attr_accessor :config, :gem, :git, :ui
 
-      def initialize(name = nil)
+      def initialize(*args)
+        opts = args.last.is_a?(Hash) ? args.pop : {}
+        name = args.shift
         @config = Config.new
         @gem    = Gem.new(name || File.basename(Dir.pwd))
-        @system = System.new
-      end
-
-      def announce(str)
-        puts colored(:green, with_spacing(str, true))
-      end
-
-      def info(str)
-        puts colored(:blue, with_spacing(str, true))
-      end
-
-      def notice(str)
-        puts colored(:gray, with_spacing(str, false))
-      end
-
-      def warn(str)
-        puts colored(:yellow, with_spacing(str, false))
-      end
-
-      def error(str)
-        puts colored(:red, with_spacing(str, true))
+        @git    = Git.new
+        @ui     = Ui.new(opts)
       end
 
-      def success(str)
-        announce(str)
-        puts
+      def run(cmd)
+        system(cmd)
       end
 
-      def abort(str)
-        error(str)
-        exit 1
+      def gem_cmd(cmd, *args)
+        ::Gem::Commands.const_get("#{cmd.to_s.capitalize}Command").new.invoke(*args.flatten)
+        # TODO what's with the return value? maybe add our own abstraction that can check the result?
+        true
       end
 
       def in_dirs(args, opts, &block)
@@ -64,17 +35,10 @@ module Gem
         Paths::ByGemspecs.new(args, opts).in_dirs(&block)
       end
 
-      private
-
-        def colored(color, str)
-          [COLORS[color], str, COLORS[:reset]].join
-        end
-
-        def with_spacing(str, space)
-          str = "\n#{str}" if space && !self.class.last
-          self.class.last = space
-          str
-        end
+      def abort(str)
+        ui.error(str)
+        exit 1
+      end
     end
   end
 end

data/lib/gem/release/context/{system.rb → git.rb}

@@ -1,40 +1,30 @@
 module Gem
   module Release
     class Context
-      class System
-        def run(cmd)
-          system(cmd)
-        end
-
-        def gem_cmd(cmd, *args)
-          ::Gem::Commands.const_get("#{cmd.to_s.capitalize}Command").new.invoke(*args.flatten)
-          # TODO what's with the return value? maybe add our own abstraction that can check the result?
-          true
-        end
-
-        def git_clean?
+      class Git
+        def clean?
           system 'git diff-index --quiet HEAD'
         end
 
-        def git_remotes
+        def remotes
           `git remote`.split("\n")
         end
 
-        def git_tags
+        def tags
           `git tag`.split("\n")
         end
 
-        def git_user_name
+        def user_name
           str = `git config --get user.name`.strip
           str unless str.empty?
         end
 
-        def git_user_email
+        def user_email
           str = `git config --get user.email`.strip
           str unless str.empty?
         end
 
-        def github_user_name
+        def user_login
           str = `git config --get github.user`.strip
           str.empty? ? git_user_name : str
         end

data/lib/gem/release/context/ui.rb

@@ -0,0 +1,128 @@
+module Gem
+  module Release
+    class Context
+      module Ui
+        class << self
+          def new(opts)
+            const = Quiet if opts[:quiet]
+            const ||= Tty if $stdout.tty?
+            const ||= Pipe
+            const.new(opts)
+          end
+        end
+
+        class Base < Struct.new(:opts)
+          attr_writer :stdout
+
+          def stdout
+            @stdout || $stdout
+          end
+
+          def puts(*str)
+            stdout.puts(*str)
+          end
+        end
+
+        class Pipe < Base
+          %i(announce info notice warn error).each do |name|
+            define_method (name) do |msg, args = nil, _ = nil|
+              puts format_msg(msg, args)
+            end
+          end
+
+          %i(success cmd).each do |name|
+            define_method (name) { |*| }
+          end
+
+          private
+
+            def format_msg(msg, args)
+              msg = [msg, args].flatten.map(&:to_s)
+              msg = msg.map { |str| quote_spaced(str) }
+              msg.join(' ').strip
+            end
+
+            def quote_spaced(str)
+              str.include?(' ') ? %("#{str}") : str
+            end
+        end
+
+        class Quiet < Base
+          %i(announce info notice warn error success cmd).each do |name|
+            define_method (name) { |*| }
+          end
+        end
+
+        module Colors
+          COLORS = {
+            red:    "\e[31m",
+            green:  "\e[32m",
+            yellow: "\e[33m",
+            blue:   "\e[34m",
+            gray:   "\e[37m",
+            reset:  "\e[0m"
+          }
+
+          def colored(color, str)
+            [COLORS[color], str, COLORS[:reset]].join
+          end
+        end
+
+        class Tty < Base
+          include Colors
+
+          def announce(msg, args = [], msgs = [])
+            msg = format_msg(msg, args, msgs)
+            puts colored(:green, with_spacing(msg, true))
+          end
+
+          def info(msg, args = [], msgs = [])
+            msg = format_msg(msg, args, msgs)
+            puts colored(:blue, with_spacing(msg, true))
+          end
+
+          def notice(msg, args = [], msgs = [])
+            msg = format_msg(msg, args, msgs)
+            puts colored(:gray, with_spacing(msg, false))
+          end
+
+          def warn(msg, args = [], msgs = [])
+            msg = format_msg(msg, args, msgs)
+            puts colored(:yellow, with_spacing(msg, false))
+          end
+
+          def error(msg, args = [], msgs = [])
+            msg = format_msg(msg, args, msgs)
+            puts colored(:red, with_spacing(msg, true))
+          end
+
+          def success(msg)
+            announce(msg)
+            puts
+          end
+
+          def cmd(msg)
+            notice("$ #{msg}")
+          end
+
+          private
+
+            def colored(color, str)
+              opts[:color] ? super : str
+            end
+
+            def format_msg(msg, args, msgs)
+              msg = msgs[msg] % args if msg.is_a?(Symbol)
+              msg.strip
+            end
+
+            def with_spacing(str, space)
+              str = "\n#{str}" if space && !@last
+              @last = space
+              str
+            end
+        end
+      end
+    end
+  end
+end

data/lib/gem/release/data.rb

@@ -4,7 +4,7 @@ require 'gem/release/helper/string'
 
 module Gem
   module Release
-    class Data < Struct.new(:system, :gem, :opts)
+    class Data < Struct.new(:git, :gem, :opts)
       include Helper::String
 
       def data
@@ -36,16 +36,20 @@ module Gem
           gem_name.gsub('-', '/').sub(/_rb$/, '')
         end
 
+        def user_login
+          git.user_login || '[your login]'
+        end
+
         def user_name
-          system.git_user_name || '[your name]'
+          git.user_name || '[your name]'
         end
 
         def user_email
-          system.git_user_email || '[your email]'
+          git.user_email || '[your email]'
         end
 
         def homepage
-          "https://github.com/#{user_name}/#{gem_name}"
+          "https://github.com/#{user_login}/#{gem_name}"
         end
 
         def licenses

data/lib/gem/release/helper.rb

@@ -4,9 +4,7 @@ module Gem
   module Release
     module Helper
       extend Forwardable
-      def_delegators :context, :gem, :system
-      def_delegators :system, :git_clean?, :git_remotes, :git_tags,
-        :git_user_name, :git_user_email, :github_user_name
+      def_delegators :context, :gem, :git, :ui
 
       def run(cmd)
         return true if send(cmd)
@@ -18,21 +16,20 @@ module Gem
           cmd = self.class::CMDS[cmd] % args
         end
         cmd = cmd.strip
-        notice "$ #{cmd}"
-        result = pretend? ? true : system.run(cmd)
+        ui.cmd cmd
+        result = pretend? ? true : context.run(cmd)
         abort "The command `#{cmd}` was unsuccessful." unless result
       end
 
       def gem_cmd(cmd, *args)
         info cmd, *args if cmd.is_a?(Symbol)
-        notice "$ gem #{cmd} #{args.join(' ')}"
-        pretend? ? true : system.gem_cmd(cmd, *args)
+        ui.cmd "gem #{cmd} #{args.join(' ')}"
+        pretend? ? true : context.gem_cmd(cmd, *args)
       end
 
       %w(announce notice info warn error).each do |level|
         define_method(level) do |msg, *args|
-          msg = self.class::MSGS[msg] % args if msg.is_a?(Symbol)
-          context.send(level, msg.strip) unless quiet?
+          ui.send(level, msg, args, self.class::MSGS)
         end
       end
 

data/lib/gem/release/support/gem_command.rb

@@ -51,9 +51,7 @@ module Gem
       end
 
       def execute
-        args = opts.delete(:args)
-        context = Context.new
-        Cmds::Runner.new(context, cmd, args, opts).run
+        Cmds::Runner.new(cmd, opts.delete(:args), opts).run
       rescue Abort
         abort
       end

data/lib/gem/release/version.rb

@@ -1,5 +1,5 @@
 module Gem
   module Release
-    VERSION = '2.0.0.dev.5'
+    VERSION = '2.0.0.rc.1'
   end
 end

data/lib/gem/release/version/number.rb

@@ -2,7 +2,7 @@ module Gem
   module Release
     module Version
       class Number < Struct.new(:number, :target)
-        NUMBER = /^(\d+)\.(\d+).(\d+).?(\w+)?.?(\d+)?$/
+        NUMBER = /^(\d+)\.?(\d+)?\.?(\d+)?\.?(\w+)?\.?(\d+)?$/
 
         STAGES = %i(alpha beta pre rc)
 
@@ -25,14 +25,14 @@ module Gem
           end
 
           def minor
-            part = parts[1]
+            part = parts[1].to_i
             part = 0 if to?(:major)
             part += 1 if to?(:minor) || fresh_pre_release?
             part
           end
 
           def patch
-            part = parts[2]
+            part = parts[2].to_i
             part = 0 if to?(:major, :minor) || fresh_pre_release?
             part += 1 if to?(:patch) && from_release?
             part
@@ -44,9 +44,7 @@ module Gem
 
           def num
             return if to_release?
-            part = parts[4].to_i
-            part += 1 if from_release? || same_stage?
-            part
+            same_stage? ? parts[4].to_i + 1 : 1
           end
 
           def to?(*targets)
@@ -89,12 +87,18 @@ module Gem
 
           def parts
             @parts ||= matches.compact.map(&:to_i).tap do |parts|
-              parts[3] = matches[3] && matches[3].to_sym
+              parts[3] = matches[3].to_sym if matches[3]
             end
           end
 
           def matches
-            @matches ||= number.match(NUMBER).to_a[1..-1]
+            @matches ||= parse.to_a[1..-1]
+          end
+
+          def parse
+            matches = number.match(NUMBER)
+            raise Abort, "Cannot parse version number #{number}" unless matches
+            matches
           end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem-release
 version: !ruby/object:Gem::Version
-  version: 2.0.0.dev.5
+  version: 2.0.0.rc.1
 platform: ruby
 authors:
 - Sven Fuchs
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-06 00:00:00.000000000 Z
+date: 2018-03-18 00:00:00.000000000 Z
 dependencies: []
 description: Release your ruby gems with ease. (What a bold statement for such a tiny
   plugin ...)
@@ -40,8 +40,9 @@ files:
 - lib/gem/release/context.rb
 - lib/gem/release/context/gem.rb
 - lib/gem/release/context/gemspec.rb
+- lib/gem/release/context/git.rb
 - lib/gem/release/context/paths.rb
-- lib/gem/release/context/system.rb
+- lib/gem/release/context/ui.rb
 - lib/gem/release/data.rb
 - lib/gem/release/files/template.rb
 - lib/gem/release/files/template/context.rb
@@ -91,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Release your ruby gems with ease