gem-release 2.0.0.rc.2 → 2.0.0.rc.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d01b331c4b3cdce9d3464a76d0a4340e19e91e7
-  data.tar.gz: 5ff68a222cea0f340527134339fb4e2db272ab1a
+  metadata.gz: d5495b63bafb7bac2b1664e052f1c82adadefbfc
+  data.tar.gz: 3d45a18839a2a19b02487d00bb43d99415eda748
 SHA512:
-  metadata.gz: 5783af584722603f72e354a8391f5b7df243ef4a5a1e4f5bb518e90157e54138d5c393918f97ec5fc22c2fd199d074f9da8a4e69bdc1a65f2e6de8fc304d8ddb
-  data.tar.gz: 0c43e69387894f86c47e588269c95f61e7b478df799bfb7f5721bdd07bc00092a0dfc51dc5989dae79c6a4dde11aaddafb1c4eb3384c02f423564f95a4b7118d
+  metadata.gz: 33e8795828225985d25057cf05394481a806fdda7195c50a582e3d5f54a775244f2631835da77097b5f6349f74aaac70dcfb34bfca28afbbcd651b56c32f8584
+  data.tar.gz: c56e9eddebc241a1c11fd1d949f8f09286585f7d12e78a4b7b60147674b93f3736551f63aff7b91dad11564e4d4ba952311948220084b8736e0a75827038d6a7

data/Gemfile.lock

@@ -1,11 +1,13 @@
 PATH
   remote: .
   specs:
-    gem-release (2.0.0.rc.1)
+    gem-release (2.0.0.rc.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
     builder (3.2.3)
     coveralls (0.8.21)
       json (>= 1.8, < 3)
@@ -13,6 +15,8 @@ GEM
       term-ansicolor (~> 1.3)
       thor (~> 0.19.4)
       tins (~> 1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     docile (1.1.5)
     faraday (0.12.0.1)
@@ -23,10 +27,12 @@ GEM
       httpclient (>= 2.2.7)
       nesty
       sinatra (>= 1.2.7)
+    hashdiff (0.3.7)
     httpclient (2.6.0.1)
     json (2.1.0)
     multipart-post (2.0.0)
     nesty (1.0.2)
+    public_suffix (3.0.2)
     rack (1.6.5)
     rack-protection (1.5.3)
       rack
@@ -43,6 +49,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
+    safe_yaml (1.0.4)
     simplecov (0.14.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
@@ -57,6 +64,10 @@ GEM
     thor (0.19.4)
     tilt (2.0.7)
     tins (1.13.2)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   ruby
@@ -67,6 +78,7 @@ DEPENDENCIES
   geminabox
   rspec
   simplecov
+  webmock
 
 BUNDLED WITH
    1.16.0.pre.2

data/README.md

@@ -20,6 +20,7 @@ It adds the commands `bootstrap`, `gemspec`, `bump`, `tag` and a `release` to th
 * [Installation](#installation)
 * [Configuration](#configuration)
 * [Conventions](#conventions)
+* [Piping](#piping)
 * [Reference](#reference)
 * [Scenarios](#scenarios)
 * [Development](#development)
@@ -85,6 +86,29 @@ When bumping the version of an existing gem `gem-name` the following locations a
 * `lib/gem/name/version.rb`
 * `lib/gem-name/version.rb`
 
+# Piping
+
+Output depends on a `tty` being available or not. I.e. when run as an
+individual command colorized human readable output will be printed (see the
+Demo screencast above). When attached to a pipe then output is kept simple and
+parsable.
+
+E.g.:
+
+```
+$ gem bump --pretend | cat
+bump gem-release 1.0.0 1.0.1
+git_add lib/gem/release/version.rb
+git_commit "Bump gem-release to 1.0.1"
+```
+
+This is useful, for example, for grabbing the next version number:
+
+```
+$ gem bump --pretend --no-commit | awk '{ print $4 }'
+1.0.1
+```
+
 
 # Reference
 
@@ -109,17 +133,19 @@ gem_name - name of the gem (optional, will default to the current directory name
 ### Options
 
 ```
-    --[no]-scaffold              Scaffold gem files
+    --[no-]scaffold              Scaffold gem files (default: true)
     --dir DIR                    Directory to place the gem in (defaults to the given name, or the current working dir)
+    --bin                        Create an executable ./bin/[name], add executables directive to .gemspec
 -t, --template NAME              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)
--l, --no-license NAME
--s, --strategy NAME              Strategy for collecting files [glob|git] in .gemspec
-    --git                        Initialize a git repo
+    --travis                     Use the travis group (by default adds .travis.yml)
+-l, --[no-]license NAME          License(s) to add (default: mit)
+-s, --strategy NAME              Strategy for collecting files [glob|git] in .gemspec (default: glob)
+    --[no-]git                   Initialize a git repo (default: true)
     --github                     Initialize a git repo, create on github
     --remote                     Git remote repository
     --push                       Push the git repo to github
+    --[no-]color
     --pretend
 ```
 
@@ -167,7 +193,8 @@ global directory `.gem-release/templates/travis`.
 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`.
+present in the local or global directory `.gem-release/licenses`. If
+`--no-license` is given then no license will be added.
 
 ## gem bump
 
@@ -183,16 +210,18 @@ gem_name - name of the gem (optional, will use the directory name, or all gemspe
 
 ```
 -v, --version VERSION            Target version: next [major|minor|patch|pre|release] or a given version number [x.x.x]
--c, --[no-]commit                Create a commit after incrementing gem version
--m, --message                    Commit message template
+-c, --[no-]commit                Create a commit after incrementing gem version (default: true)
+-m, --message                    Commit message template (default: Bump %{name} to %{version} %{skip_ci})
     --skip-ci                    Add the [skip ci] tag to the commit message
--p, --[no-]push                  Push the new commit to the git remote repository
-    --remote REMOTE              Git remote to push to (defaults to origin)
+-p, --push                       Push the new commit to the git remote repository
+    --remote REMOTE              Git remote to push to (defaults to origin) (default: origin)
 -s, --sign                       GPG sign the commit message
+    --branch [BRANCH]            Check out a new branch for the target version (e.g. `v1.0.0`)
 -t, --tag                        Shortcut for running the `gem tag` command
 -r, --release                    Shortcut for the `gem release` command
     --recurse                    Recurse into directories that contain gemspec files
-    --file                       Full path to the version file
+    --file FILE                  Full path to the version file
+    --[no-]color
     --pretend
 ```
 
@@ -219,7 +248,7 @@ major       # Bump to the next major level (e.g. 0.0.1 to 1.0.0)
 minor       # Bump to the next minor level (e.g. 0.0.1 to 0.1.0)
 patch       # Bump to the next patch level (e.g. 0.0.1 to 0.0.2)
 pre|rc|etc  # Bump to the next pre-release level (e.g. 0.0.1 to
-            #   0.1.0-pre.1, 1.0.0-pre.1 to 1.0.0-pre.2)
+            #   0.1.0.pre.1, 1.0.0.pre.1 to 1.0.0.pre.2)
 ```
 
 When searching for the version file for a gem named `gem-name`: the
@@ -241,9 +270,11 @@ gem_name - name of the gem (optional, will default to the current directory name
 ### Options
 
 ```
+    --[no]-bin                   Add bin files directive to the gemspec (defaults to true if a ./bin directory exists)
     --dir DIR                    Directory to place the gem in (defaults to the given name, or the current working dir)
--l, --[no]-license[s] NAMES      License(s) to list in the gemspec
--s, --strategy                   Strategy for collecting files [glob|git] in gemspec
+-l, --[no-]license NAMES         License(s) to list in the gemspec
+-s, --strategy                   Strategy for collecting files [glob|git] in gemspec (default: glob)
+    --[no-]color
     --pretend
 ```
 
@@ -277,7 +308,9 @@ gem_name - name of the gem (optional, will use the first gemspec, or all gemspec
     --host HOST                  Push to a compatible host other than rubygems.org
 -k, --key KEY                    Use the API key from ~/.gem/credentials
 -t, --tag                        Shortcut for running the `gem tag` command
+-p, --push                       Push tag to the remote git repository
     --recurse                    Recurse into directories that contain gemspec files
+    --[no-]color
     --pretend
 ```
 
@@ -301,8 +334,10 @@ Tags the HEAD commit with the gem's current version.
 ### Options
 
 ```
--p, --[no]-push                  Push tag to the remote git repository
-    --remote REMOTE              Git remote to push to (defaults to origin)
+-p, --[no-]push                  Push tag to the remote git repository
+    --remote REMOTE              Git remote to push to (default: origin)
+-s, --sign                       GPG sign the tag
+    --[no-]color
     --pretend
 ```
 

data/README.md.erb

@@ -1,4 +1,4 @@
-# gem release [![Build Status](https://secure.travis-ci.org/svenfuchs/gem-release.png)](http://travis-ci.org/svenfuchs/gem-release)
+# gem release [![Build Status](https://secure.travis-ci.org/svenfuchs/gem-release.svg)](http://travis-ci.org/svenfuchs/gem-release)
 
 This gem plugin aims at making gem development easier by automating repetitive work based on conventions, configuration, and templates.
 
@@ -8,9 +8,9 @@ It adds the commands `bootstrap`, `gemspec`, `bump`, `tag` and a `release` to th
 | ---------------------- | ------------ |
 | Gem name               |  gem-release |
 | License                |  [MIT](https://github.com/svenfuchs/gem-release/blob/master/LICENSE.md) |
-| Version                |  [![Gem Version](https://badge.fury.io/rb/gem-release.png)](http://badge.fury.io/rb/gem-release) |
-| Continuous integration |  [![Build Status](https://secure.travis-ci.org/svenfuchs/gem-release.png?branch=master)](https://travis-ci.org/svenfuchs/gem-release) |
-| Test coverage          |  [![Coverage Status](https://coveralls.io/repos/svenfuchs/gem-release/badge.png)](https://coveralls.io/r/svenfuchs/gem-release) |
+| Version                |  [![Gem Version](https://badge.fury.io/rb/gem-release.svg)](http://badge.fury.io/rb/gem-release) |
+| Continuous integration |  [![Build Status](https://secure.travis-ci.org/svenfuchs/gem-release.svg?branch=master)](https://travis-ci.org/svenfuchs/gem-release) |
+| Test coverage          |  [![Coverage Status](https://coveralls.io/repos/svenfuchs/gem-release/badge.svg)](https://coveralls.io/r/svenfuchs/gem-release) |
 | Documentation          |  [Documentation](http://rdoc.info/github/svenfuchs/gem-release/frames) |
 | Credits                |  [Contributors](https://github.com/svenfuchs/gem-release/graphs/contributors) |
 
@@ -20,6 +20,7 @@ It adds the commands `bootstrap`, `gemspec`, `bump`, `tag` and a `release` to th
 * [Installation](#installation)
 * [Configuration](#configuration)
 * [Conventions](#conventions)
+* [Piping](#piping)
 * [Reference](#reference)
 * [Scenarios](#scenarios)
 * [Development](#development)
@@ -85,6 +86,29 @@ When bumping the version of an existing gem `gem-name` the following locations a
 * `lib/gem/name/version.rb`
 * `lib/gem-name/version.rb`
 
+# Piping
+
+Output depends on a `tty` being available or not. I.e. when run as an
+individual command colorized human readable output will be printed (see the
+Demo screencast above). When attached to a pipe then output is kept simple and
+parsable.
+
+E.g.:
+
+```
+$ gem bump --pretend | cat
+bump gem-release 1.0.0 1.0.1
+git_add lib/gem/release/version.rb
+git_commit "Bump gem-release to 1.0.1"
+```
+
+This is useful, for example, for grabbing the next version number:
+
+```
+$ gem bump --pretend --no-commit | awk '{ print $4 }'
+1.0.1
+```
+
 
 # Reference
 

data/lib/gem/release.rb

@@ -3,8 +3,14 @@ module Gem
     Abort = Class.new(StandardError)
 
     STRATEGIES = {
-      git:  '`git ls-files app lib`.split("\n")',
-      glob: "Dir.glob('{bin/*,lib/**/*,[A-Z]*}')"
+      git:  {
+        files: '`git ls-files app lib`.split("\n")',
+        bin_files: '`git ls-files bin`.split("\n").map { |f| File.basename(f) }',
+      },
+      glob: {
+        files: "Dir.glob('{bin/*,lib/**/*,[A-Z]*}')",
+        bin_files: "Dir.glob('bin/*').map { |f| File.basename(f) }",
+      }
     }
   end
 end

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

@@ -60,6 +60,7 @@ module Gem
         DEFAULTS = {
           strategy:  :glob,
           scaffold:  true,
+          bin:       false,
           git:       true,
           github:    false,
           push:      false,
@@ -70,10 +71,11 @@ module Gem
         DESCR = {
           scaffold: 'Scaffold gem files',
           dir:      'Directory to place the gem in (defaults to the given name, or the current working dir)',
+          bin:      'Create an executable ./bin/[name], add executables directive to .gemspec',
           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)',
+          travis:   'Use the travis group (by default adds .travis.yml)',
           strategy: 'Strategy for collecting files [glob|git] in .gemspec',
           git:      'Initialize a git repo',
           github:   'Initialize a git repo, create on github',
@@ -89,6 +91,10 @@ module Gem
           opts[:dir] = value
         end
 
+        opt '--bin', descr(:bin) do
+          opts[:bin] = true
+        end
+
         opt '-t', '--template NAME', descr(:template) do |value|
           (opts[:templates] ||= []) << value
         end
@@ -170,10 +176,15 @@ module Gem
 
           def files
             files = Files::Templates.new(FILES, opts[:templates], data).all
+            files << executable if opts[:bin]
             files << license if opts[:license]
             files.compact
           end
 
+          def executable
+            Files::Templates.executable("bin/#{gem.name}")
+          end
+
           def license
             file = Files::Templates.license(opts[:license], data)
             warn :unknown_license, opts[:license] unless file

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

@@ -29,11 +29,16 @@ module Gem
         }
 
         DESCR = {
+          bin:      'Add bin files directive to the gemspec (defaults to true if a ./bin directory exists)',
           dir:      'Directory to place the gem in (defaults to the given name, or the current working dir)',
           license:  'License(s) to list in the gemspec',
           strategy: 'Strategy for collecting files [glob|git] in gemspec'
         }
 
+        opt '--[no]-bin', descr(:bin) do |value|
+          opts[:bin] = value
+        end
+
         opt '--dir DIR', descr(:dir) do |value|
           opts[:dir] = value
         end

data/lib/gem/release/data.rb

@@ -18,7 +18,8 @@ module Gem
           licenses:     licenses,
           summary:      '[summary]',
           description:  '[description]',
-          files:        files
+          files:        files,
+          bin_files:    bin_files
         }
       end
 
@@ -61,6 +62,14 @@ module Gem
         end
 
         def files
+          strategy[:files]
+        end
+
+        def bin_files
+          strategy[:bin_files] if opts.key?(:bin) ? opts[:bin] : File.directory?('./bin')
+        end
+
+        def strategy
           STRATEGIES[(opts[:strategy] || :glob).to_sym] || STRATEGIES[:glob]
         end
     end

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

@@ -13,12 +13,13 @@ module Gem
           'version.rb' => 'lib/%{gem_path}/version.rb'
         }
 
-        attr_accessor :source, :target, :data
+        attr_accessor :source, :target, :data, :opts
 
-        def initialize(source, target, data)
+        def initialize(source, target, data, opts)
           @source = source
           @target = (FILES[target] || target) % data
           @data   = data
+          @opts   = opts
         end
 
         PATH = File.expand_path('../..', __FILE__)
@@ -31,6 +32,7 @@ module Gem
           return false if exists?
           FileUtils.mkdir_p(File.dirname(target))
           File.write(target, render)
+          FileUtils.chmod('+x', target) if opts[:executable]
           true
         end
 

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

@@ -14,12 +14,24 @@ module Gem
           ['../../templates/%s', __FILE__],
         ]
 
+        EXECUTABLE = [
+          ['./.gem-release/executable'],
+          ['~/.gem-release/executable'],
+          ['../../templates/executable', __FILE__],
+        ]
+
         LICENSE = [
           ['./.gem-release/licenses'],
           ['~/.gem-release/licenses'],
           ['../../templates/licenses', __FILE__],
         ]
 
+        def self.executable(target)
+          file = Templates.new([".*"], [], {}).executable
+          file.target = target if file
+          file
+        end
+
         def self.license(name, data)
           file = Templates.new(["#{name}{,.*}"], [], data).license
           file.target = "LICENSE#{File.extname(file.target)}" if file
@@ -43,13 +55,17 @@ module Gem
           templates_for(CUSTOM, '**/*')
         end
 
+        def executable
+          templates_for(EXECUTABLE).first
+        end
+
         def license
           templates_for(LICENSE, files).first
         end
 
-        def templates_for(sources, files)
+        def templates_for(sources, files = nil, opts = {})
           all = Group.new(groups, data, sources, files).all
-          all.map { |source, target| Template.new(source, target, data) }
+          all.map { |source, target| Template.new(source, target, data, opts) }
         end
       end
     end

data/lib/gem/release/files/templates/group.rb

@@ -22,7 +22,9 @@ module Gem
           private
 
             def pattern
-              "{#{paths.join(',')}}/{#{files.join(',')}}"
+              pattern = "{#{paths.join(',')}}"
+              pattern << "/{#{files.join(',')}}" if files.any?
+              pattern
             end
 
             def relative(file)

data/lib/gem/release/templates/executable

@@ -0,0 +1 @@
+#!/usr/bin/env ruby

data/lib/gem/release/templates/gemspec

@@ -13,7 +13,9 @@ Gem::Specification.new do |s|
   s.summary       = '<%= summary %>'
   s.description   = '<%= description %>'
 
-  s.files         = <%= files %>
+  s.files         = <%= files %><% if bin_files %>
+  s.executables   = <%= bin_files %>
+<% end %>
   s.platform      = Gem::Platform::RUBY
   s.require_paths = ['lib']
 end

data/lib/gem/release/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem-release
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc.2
+  version: 2.0.0.rc.3
 platform: ruby
 authors:
 - Sven Fuchs
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-18 00:00:00.000000000 Z
+date: 2018-03-24 00:00:00.000000000 Z
 dependencies: []
 description: Release your ruby gems with ease. (What a bold statement for such a tiny
   plugin ...)
@@ -56,6 +56,7 @@ files:
 - lib/gem/release/support/registry.rb
 - lib/gem/release/templates/.gitignore
 - lib/gem/release/templates/Gemfile
+- lib/gem/release/templates/executable
 - lib/gem/release/templates/gemspec
 - lib/gem/release/templates/licenses/mit.md
 - lib/gem/release/templates/licenses/mpl-2.md