gem-release 2.0.0.dev.4 → 2.0.0.dev.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c266a1ed9b7d5a3b2f1594b0aa4a14e98faafd87
-  data.tar.gz: ed1b9717bc85dbf71f9adf5d17b389e2a1b26a78
+  metadata.gz: 6eec8f1a113b0850b5700b9226b6350cad8167f3
+  data.tar.gz: bda046a3fa483a9d09f7f493146266e17241dbd8
 SHA512:
-  metadata.gz: cc5fe621e481c9aeae16e3bca40ca475a1c6d3f708c5c4ee4bf225d783e581f7a10b6f235dcf490b6d853174f2a605c1d2da9b9ef65505c0dbf0c807babb2926
-  data.tar.gz: 2db3a96f254bd5bda9ebfd4f6900643de49e9a921e87be4cb4410c96184a20f35d7ac907441dfb2960bf73eb0093594e5345f884f9be249e38b8cd9b29a282b7
+  metadata.gz: 458818e6e27ae01927d51a6813f08d07d9359cfe6e6a682c33494127bde073d2b4b1b692868e8e2451eef497fe7b74811459c099413b51f7b2fafdb8254e8b33
+  data.tar.gz: a68e3c396bdcb8295ac1c05ff50a36f78b494c418d341619635431c3cfde56789005549d8c41c218277e82ff30b6f7adeb4b271976cce9bf9f16f7142266b400

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+## v2.0.0
+
+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
+* 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 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
+
+### 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
+* 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.3)
+    gem-release (2.0.0.dev.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -28,7 +28,7 @@ It adds the commands `bootstrap`, `gemspec`, `bump`, `tag` and a `release` to th
 
 This gif demos some of the things you can do with this plugin:
 
-![gem-relase-demo](https://cloud.githubusercontent.com/assets/2208/25568627/12a3b468-2e07-11e7-8d7b-055b5d7c71b9.gif)
+![gem-release-demo](https://cloud.githubusercontent.com/assets/2208/25634571/68b78080-2f7b-11e7-9eb2-c7d1df13c727.gif)
 
 ## Installation
 

data/README.md.erb

@@ -28,7 +28,7 @@ It adds the commands `bootstrap`, `gemspec`, `bump`, `tag` and a `release` to th
 
 This gif demos some of the things you can do with this plugin:
 
-![gem-relase-demo](https://cloud.githubusercontent.com/assets/2208/25568627/12a3b468-2e07-11e7-8d7b-055b5d7c71b9.gif)
+![gem-release-demo](https://cloud.githubusercontent.com/assets/2208/25634571/68b78080-2f7b-11e7-9eb2-c7d1df13c727.gif)
 
 ## Installation
 

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

@@ -32,6 +32,12 @@ module Gem
             @opts ||= superclass != self.class && superclass.respond_to?(:opts) ? superclass.opts.dup : []
           end
 
+          def descr(opt)
+            descr = self::DESCR[opt]
+            descr = "#{descr} (default: #{self::DEFAULTS[opt]})" if self::DEFAULTS.key?(opt)
+            descr
+          end
+
           def usage(usage = nil)
             usage ? @usage = usage : @usage || '[usage]'
           end

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

@@ -8,8 +8,6 @@ module Gem
       class Bootstrap < Base
         summary 'Scaffolds a new gem from template files.'
 
-        # TODO document license
-
         description <<~str
           #{summary} Optionally initialize a git repository, set a git remote, and push
           to the remote repository.
@@ -53,7 +51,8 @@ module Gem
           The license added by default is the MIT License. If `--license [name]` is given
           then this license will be added. The only other license file shipped is the
           Mozilla Public License v2.0. Other licenses must be present in the local or
-          global directory `.gem-release/licenses`.
+          global directory `.gem-release/licenses`. If `--no-license` is given then no
+          license will be added.
         str
 
         arg :gem_name, 'name of the gem (optional, will default to the current directory name if not specified)'
@@ -71,7 +70,7 @@ module Gem
         DESCR = {
           scaffold: 'Scaffold gem files',
           dir:      'Directory to place the gem in (defaults to the given name, or the current working dir)',
-          licenses: 'License(s) to add',
+          license:  'License(s) to add',
           template: 'Template groups to use for scaffolding',
           rspec:    'Use the rspec group (by default adds .rspec and spec/spec_helper.rb)',
           travis:   'Use the rspec group (by default adds .travis.yml)',
@@ -82,47 +81,47 @@ module Gem
           push:     'Push the git repo to github'
         }
 
-        opt '--[no]-scaffold', DESCR[:scaffold] do |value|
+        opt '--[no-]scaffold', descr(:scaffold) do |value|
           opts[:scaffold] = value
         end
 
-        opt '--dir DIR', DESCR[:dir] do |value|
+        opt '--dir DIR', descr(:dir) do |value|
           opts[:dir] = value
         end
 
-        opt '-t', '--template NAME', DESCR[:template] do |value|
+        opt '-t', '--template NAME', descr(:template) do |value|
           (opts[:templates] ||= []) << value
         end
 
-        opt '--rspec', DESCR[:rspec] do |value|
+        opt '--rspec', descr(:rspec) do |value|
           (opts[:templates] ||= []) << :rspec
         end
 
-        opt '--travis', DESCR[:travis] do |value|
+        opt '--travis', descr(:travis) do |value|
           (opts[:templates] ||= []) << :travis
         end
 
-        opt '-l', '--no-license NAME', DESCR[:license] do |value|
-          value ? (opts[:license] ||= []) << value : opts[:license] = []
+        opt '-l', '--[no-]license NAME', descr(:license) do |value|
+          opts[:license] = value
         end
 
-        opt '-s', '--strategy NAME', DESCR[:strategy] do |value|
+        opt '-s', '--strategy NAME', descr(:strategy) do |value|
           opts[:strategy] = value
         end
 
-        opt '--git', DESCR[:git] do |value|
+        opt '--[no-]git', descr(:git) do |value|
           opts[:git] = value
         end
 
-        opt '--github', DESCR[:github] do |value|
+        opt '--github', descr(:github) do |value|
           opts[:github] = value
         end
 
-        opt '--remote', DESCR[:remote] do |value|
+        opt '--remote', descr(:remote) do |value|
           opts[:remote] = value
         end
 
-        opt '--push', DESCR[:push] do |value|
+        opt '--push', descr(:push) do |value|
           opts[:push] = value
         end
 

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

@@ -57,52 +57,55 @@ module Gem
 
         DEFAULTS = {
           commit:  true,
-          message: 'Bump to %{to} %{skip_ci}',
+          message: 'Bump %{name} to %{version} %{skip_ci}',
           push:    false,
-          remote:  'origin'
+          remote:  'origin',
+          skip_ci: false,
+          sign:    false,
+          recurse: false
         }
 
-        opt '-v', '--version VERSION', DESCR[:version] do |value|
+        opt '-v', '--version VERSION', descr(:version) do |value|
           opts[:version] = value
         end
 
-        opt '-c', '--[no-]commit', DESCR[:commit] do |value|
+        opt '-c', '--[no-]commit', descr(:commit) do |value|
           opts[:commit] = value
         end
 
-        opt '-m', '--message', DESCR[:message] do |value|
+        opt '-m', '--message', descr(:message) do |value|
           opts[:message] = value
         end
 
-        opt '--skip-ci', DESCR[:skip_ci] do |value|
+        opt '--skip-ci', descr(:skip_ci) do |value|
           opts[:skip_ci] = value
         end
 
-        opt '-p', '--[no-]push', DESCR[:push] do |value|
+        opt '-p', '--push', descr(:push) do |value|
           opts[:push] = value
         end
 
-        opt '--remote REMOTE', DESCR[:remote] do |value|
+        opt '--remote REMOTE', descr(:remote) do |value|
           opts[:remote] = value
         end
 
-        opt '-s', '--sign', DESCR[:sign] do |value|
+        opt '-s', '--sign', descr(:sign) do |value|
           opts[:sign] = value
         end
 
-        opt '-t', '--tag', DESCR[:tag] do |value|
+        opt '-t', '--tag', descr(:tag) do |value|
           opts[:tag] = value
         end
 
-        opt '-r', '--release', DESCR[:release] do |value|
+        opt '-r', '--release', descr(:release) do |value|
           opts[:release] = value
         end
 
-        opt '--recurse', DESCR[:recurse] do |value|
+        opt '--recurse', descr(:recurse) do |value|
           opts[:recurse] = value
         end
 
-        opt '--file', DESCR[:file] do |value|
+        opt '--file', descr(:file) do |value|
           opts[:file] = value
         end
 
@@ -127,8 +130,8 @@ module Gem
           in_gem_dirs do
             validate
             bump
-            commit  if opts[:commit]
-            push    if opts[:commit] && opts[:push]
+            commit if opts[:commit]
+            push   if opts[:commit] && opts[:push]
             reset
           end
           tag     if opts[:tag]
@@ -139,8 +142,8 @@ module Gem
 
           def validate
             abort :git_dirty unless git_clean?
-            abort :not_found, gem.name, version.path || '?' unless version.exists?
             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 bump
@@ -167,13 +170,9 @@ module Gem
             Release.new(context, args, except(opts, :tag)).run
           end
 
-          def reset
-            @version = nil
-          end
-
           def message
-            args = version.to_h
-            args = args.merge(skip_ci: opts[:skip_ci] ? '[skip ci]' : '')
+            args = { name: gem.name, skip_ci: opts[:skip_ci] ? '[skip ci]' : '' }
+            args = args.merge(version.to_h)
             opts[:message] % args
           end
 
@@ -181,6 +180,10 @@ module Gem
             @version ||= Files::Version.new(gem.name, opts[:version], only(opts, :file))
           end
 
+          def reset
+            @version = nil
+          end
+
           def push?
             opts[:push]
           end

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

@@ -34,15 +34,15 @@ module Gem
           strategy: 'Strategy for collecting files [glob|git] in gemspec'
         }
 
-        opt '--dir DIR', DESCR[:dir] do |value|
+        opt '--dir DIR', descr(:dir) do |value|
           opts[:dir] = value
         end
 
-        opt '-l', '--[no]-license[s] NAMES', DESCR[:license] do |value|
+        opt '-l', '--[no-]license NAMES', descr(:license) do |value|
           value ? (opts[:license] ||= []) << value : opts[:license] = []
         end
 
-        opt '-s', '--strategy', DESCR[:strategy] do |value|
+        opt '-s', '--strategy', descr(:strategy) do |value|
           opts[:strategy] = value
         end
 

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

@@ -22,26 +22,37 @@ module Gem
 
         arg :gem_name, 'name of the gem (optional, will use the first gemspec, or all gemspecs if --recurse is given)'
 
+        DEFAULTS = {
+          tag:     false,
+          push:    false,
+          recurse: false
+        }
+
         DESCR = {
           host:    'Push to a compatible host other than rubygems.org',
           key:     'Use the API key from ~/.gem/credentials',
           tag:     'Shortcut for running the `gem tag` command',
+          push:   'Push tag to the remote git repository',
           recurse: 'Recurse into directories that contain gemspec files'
         }
 
-        opt '-h', '--host HOST', DESCR[:host] do |value|
+        opt '-h', '--host HOST', descr(:host) do |value|
           opts[:host] = value
         end
 
-        opt '-k', '--key KEY', DESCR[:key] do |value|
+        opt '-k', '--key KEY', descr(:key) do |value|
           opts[:key] = value
         end
 
-        opt '-t', '--tag', DESCR[:tag] do |value|
+        opt '-t', '--tag', descr(:tag) do |value|
           opts[:tag] = value
         end
 
-        opt '--recurse', DESCR[:recurse] do |value|
+        opt '-p', '--push', descr(:push) do |value|
+          opts[:push] = value
+        end
+
+        opt '--recurse', descr(:recurse) do |value|
           opts[:recurse] = value
         end
 

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

@@ -24,26 +24,32 @@ module Gem
         str
 
         DEFAULTS = {
-          push: true,
-          remote: 'origin'
+          push:   false,
+          remote: 'origin',
+          sign:   false
         }
 
         DESCR = {
-          push:    'Push tag to the remote git repository',
-          remote:  'Git remote to push to (defaults to origin)',
-          sign:    'GPG sign the tag',
+          push:   'Push tag to the remote git repository',
+          remote: 'Git remote to push to',
+          sign:   'GPG sign the tag',
         }
 
-        opt '-p', '--[no]-push', DESCR[:push] do
-          opts[:push] = true
+        opt '-p', '--push', descr(:push) do |value|
+          opts[:push] = value
         end
 
-        opt '--remote REMOTE', DESCR[:remote] do |value|
+        opt '--remote REMOTE', descr(:remote) do |value|
           opts[:remote] = value
         end
 
+        opt '-s', '--sign', descr(:sign) do |value|
+          opts[:sign] = value
+        end
+
         MSGS = {
           tag:       'Tagging %s as version %s',
+          exists:    'Skipping %s, tag already exists.',
           git_tag:   'Creating git tag %s',
           git_push:  'Pushing tags to the %s git repository',
           no_remote: 'Cannot push to missing git remote %s',
@@ -59,8 +65,7 @@ module Gem
           in_gem_dirs do
             announce :tag, gem.name, gem.version
             validate
-            tag
-            push if opts[:push]
+            tag_and_push
           end
         end
 
@@ -71,6 +76,16 @@ module Gem
             abort :no_remote, remote if push? && !git_remotes.include?(remote)
           end
 
+          def tag_and_push
+            return info :exists, tag_name if exists?
+            tag
+            push if opts[:push]
+          end
+
+          def exists?
+            git_tags.include?(tag_name)
+          end
+
           def tag
             cmd :git_tag, tag_name, tag_name, opts[:sign] ? '--sign' : ''
           end

data/lib/gem/release/context.rb

@@ -71,7 +71,6 @@ module Gem
         end
 
         def with_spacing(str, space)
-          # space = false if self.class.last.nil?
           str = "\n#{str}" if space && !self.class.last
           self.class.last = space
           str

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

@@ -20,6 +20,10 @@ module Gem
           `git remote`.split("\n")
         end
 
+        def git_tags
+          `git tag`.split("\n")
+        end
+
         def git_user_name
           str = `git config --get user.name`.strip
           str unless str.empty?

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

@@ -31,7 +31,7 @@ module Gem
         end
 
         def to_h
-          { from: from, to: to }
+          { from: from, version: to }
         end
 
         private

data/lib/gem/release/helper.rb

@@ -5,8 +5,8 @@ module Gem
     module Helper
       extend Forwardable
       def_delegators :context, :gem, :system
-      def_delegators :system, :git_clean?, :git_remotes, :git_user_name,
-        :git_user_email, :github_user_name
+      def_delegators :system, :git_clean?, :git_remotes, :git_tags,
+        :git_user_name, :git_user_email, :github_user_name
 
       def run(cmd)
         return true if send(cmd)

data/lib/gem/release/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem-release
 version: !ruby/object:Gem::Version
-  version: 2.0.0.dev.4
+  version: 2.0.0.dev.5
 platform: ruby
 authors:
 - Sven Fuchs
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-02 00:00:00.000000000 Z
+date: 2017-05-06 00:00:00.000000000 Z
 dependencies: []
 description: Release your ruby gems with ease. (What a bold statement for such a tiny
   plugin ...)
@@ -19,12 +19,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE.md
 - README.md
 - README.md.erb
-- TODO.txt
 - lib/gem/release.rb
 - lib/gem/release/cmds.rb
 - lib/gem/release/cmds/base.rb

data/TODO.txt

@@ -1,67 +0,0 @@
-# Todo
-
-- Add defaults to options help output [5]
-- Add specs for all error conditions [6]
-- Add a changelog [7]
-- Check for TODO tags [17]
-
-- Make sure we don't double tag the same repo when several args are given [9]
-
-- Port "Adding ability to GPG sign commits and tags" [10]
-  https://github.com/svenfuchs/gem-release/pull/44
-
-# Done
-
-x Port "Support version files of gems with *rb suffix" done:2017-05-02 [13]
-  https://github.com/svenfuchs/gem-release/pull/53
-  Ported
-
-x Port "Add --message for BumpCommand", allow to use a config var for this done:2017-05-02 [11]
-  https://github.com/svenfuchs/gem-release/pull/61
-  Ported
-
-x Port "Maintenance tasks" done:2017-05-02 [12]
-  https://github.com/svenfuchs/gem-release/pull/57
-  Ported
-
-x Check "bump any version file" done:2017-05-02 [14]
-  https://github.com/svenfuchs/gem-release/pull/45
-  Ported
-
-x Consider "gem bootstrap --private for private gems" done:2017-05-01 [15]
-  https://github.com/svenfuchs/gem-release/issues/51
-  Already covered via custom templates
-
-x See if we can remove unused common options from `help` done:2017-05-01 [16]
-  https://github.com/svenfuchs/gem-release/issues/55
-  Can't figure out how, without removing options globally for everyone/all other commands
-
-x Release and tag should fail if there are uncommitted changes done:2017-05-01 [8]
-  https://github.com/svenfuchs/gem-release/issues/34
-
-x Misleading success message done:2017-05-01 [4]
-  https://github.com/svenfuchs/gem-release/issues/60
-    Pushing foo-0.0.5.gem
-    Pushing gem to http://localhost:9292...
-    ...
-    ERROR:  While executing gem ... (Errno::ECONNREFUSED)
-        Failed to open TCP connection to localhost:9292 (Connection refused - connect(2) for "localhost" port 9292)
-
-x Issues with in-repo gems done:2017-05-01 [1]
-  https://github.com/svenfuchs/gem-release/issues/58
-
-x bump fails when there is a space in the path to project done:2017-05-01 [2]
-  https://github.com/svenfuchs/gem-release/issues/33
-  looks like this is fixed. this did not result in any errors:
-    cd /tmp
-    mkdir -p '/tmp/seanmackesey/Google Drive/code/lib/ruby'
-    cd /tmp/seanmackesey/Google\ Drive/code/lib/ruby
-    gem bootstrap foo
-    gem bump --no-push
-
-x gem bump --tag --release pushes the wrong version done:2017-05-01 [3]
-  https://github.com/svenfuchs/gem-release/issues/36
-    $ gem bump --tag --release
-      Bumping foo from version 0.0.3 to 0.0.4
-      ...
-      Pushing foo-0.0.4.gem