gem-release 1.0.0 → 2.0.0.dev.1

data/README.md.erb

@@ -0,0 +1,159 @@
+# gem release [![Build Status](https://secure.travis-ci.org/svenfuchs/gem-release.png)](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.
+
+It adds the commands `bootstrap`, `gemspec`, `bump`, `tag` and a `release` to the rubygems `gem` command.
+
+| Project                |  Gem Release |
+| ---------------------- | ------------ |
+| 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) |
+| Documentation          |  [Documentation](http://rdoc.info/github/svenfuchs/gem-release/frames) |
+| Credits                |  [Contributors](https://github.com/svenfuchs/gem-release/graphs/contributors) |
+
+# Table of contents
+
+* [Demo](#demo)
+* [Installation](#installation)
+* [Configuration](#configuration)
+* [Conventions](#conventions)
+* [Reference](#reference)
+* [Scenarios](#scenarios)
+* [Development](#development)
+
+# Demo
+
+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)
+
+## Installation
+
+The gem provides a rubygems plugin, so it's just:
+
+```
+gem install gem-release
+```
+
+
+# Configuration
+
+Defaults for all options can be specified in a config file at either one of
+these locations:
+
+* `~/.gem_release/config.yml`
+* `~/.gem_release.yml`
+* `./.gem_release/config.yml`
+* `./.gem_release.yml`
+
+Config files must be in the [YAML](http://www.yaml.org/) format, and list
+options per command. Common options can be set on the root.
+
+For instance, the following entries will set the `quiet` flag for all commands,
+and a custom host name with `gem release`:
+
+```yaml
+quiet: true
+
+release:
+  host: https://example.com
+```
+
+Defaults for all options also can be specified as environment variables, for
+example `GEM_RELEASE_PRETEND=true`.
+
+Defaults specified in config files and environment variables can be overridden
+as command line options when issuing the respective `gem` command.
+
+Only the first config file found in the locations given above will be used, if
+any, and defaults from this config file will be merged with both environment
+variables and given command line options.
+
+
+# Conventions
+
+When bootstrapping a new gem:
+
+* A gem name `gem_name` is left untouched when mapped to the path `lib/gem_name`, and the Ruby constant name `GemName`.
+* A gem name `gem-name` is mapped to the path `lib/gem/name`, and the Ruby constant name `Gem::Name`
+
+When bumping the version of an existing gem `gem-name` the following locations are checked:
+
+* `lib/gem/name/version.rb`
+* `lib/gem-name/version.rb`
+
+
+# Reference
+
+The gem `gem-release` adds the following commands to the rubygems `gem` command:
+
+<% cmds.each do |name, help| -%>
+  * [gem <%= name %>](#gem-<%= name %>) - <%= help[:summary] %>
+<% end -%>
+
+<% cmds.each do |name, help| -%>
+## gem <%= name %>
+
+<%= help[:summary] %>
+
+<% if help[:arguments] -%>
+### Arguments
+
+```
+<%= help[:arguments] %>
+```
+
+<% end -%>
+<% if help[:options] -%>
+### Options
+
+```
+<%= help[:options] %>
+```
+<% end -%>
+
+<% if help[:description] -%>
+### Description
+
+<%= help[:description] %>
+
+<% end -%>
+<% end -%>
+
+# Scenarios
+
+<% scenarios.each do |scenario| -%>
+* [<%= scenario[:title] %>](#<%= scenario[:id] %>)
+<% end -%>
+
+<% scenarios.each do |scenario| -%>
+<%= scenario[:text] %>
+<% end -%>
+
+# Development
+
+Running tests:
+
+```
+bundle install
+bundle exec rspec
+```
+
+Testing commands against a [Geminabox](https://github.com/geminabox/geminabox) instance:
+
+```
+# start geminabox
+bundle install
+bundle exec rackup
+
+# workaround rubygems issue with a missing key
+# see https://github.com/geminabox/geminabox/issues/153
+echo ':localhost: none' >> ~/.gem/credentials
+
+# test release
+bundle exec gem release --host=http://localhost:9292 --key localhost
+```
+

data/TODO.txt

@@ -0,0 +1,194 @@
+# Todo
+
+* Make it so that if no arg is given, we fallback to the first gemspec file
+  first. only if there's no gemspec file we use the dirname?
+
+* Add a changelog
+
+* Release and tag should fail if there are uncommitted changes
+  https://github.com/svenfuchs/gem-release/issues/34
+
+* Make sure we don't double tag the same repo when several args are given
+
+# Fix
+
+* Misleading success message
+  https://github.com/svenfuchs/gem-release/issues/60
+
+# Double check
+
+- Issues with in-repo gems [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
+
+- gem bump --tag --release pushes the wrong version [3]
+  https://github.com/svenfuchs/gem-release/issues/36
+
+# Refactor
+
+should create the directory foo, and cd into it
+
+  cd tmp
+  gem bootstrap foo
+
+
+should bootstrap a gem foo
+
+  cd foo
+  gem bootstrap
+
+should fail, as there's no foo.gemspec
+
+  cd tmp
+  gem bump foo
+
+should bump the first gemspec's gem, no matter the dir name
+
+  cd foo
+  gem bump
+
+# Scenario: Nested gem with conventional directory name
+
+### Setup
+
+```
+export GEM_RELEASE_PUSH=false
+cd /tmp
+rm -rf sinja
+gem bootstrap sinja
+cd sinja
+mkdir extensions
+cd extensions
+gem bootstrap sinja-sequel
+cd /tmp/sinja
+tree
+```
+
+### Directory structure
+
+```
+.
+├── Gemfile
+├── LICENSE.md
+├── extensions
+│   └── sinja-sequel
+│       ├── Gemfile
+│       ├── LICENSE.md
+│       ├── lib
+│       │   └── sinja
+│       │       ├── sequel
+│       │       │   └── version.rb
+│       │       └── sequel.rb
+│       └── sinja-sequel.gemspec
+├── lib
+│   ├── sinja
+│   │   └── version.rb
+│   └── sinja.rb
+└── sinja.gemspec
+```
+
+### Behaviour
+
+```
+# this bumps both sinja and sinja-sequel
+cd /tmp/sinja
+gem bump --recurse
+
+# this bumps sinja
+cd /tmp/sinja
+gem bump
+
+# this also bumps sinja
+cd /tmp/sinja
+gem bump sinja
+
+# this bumps sinja-sequel only
+cd /tmp/sinja
+gem bump sinja-sequel
+
+# this also bumps sinja-sequel only
+cd /tmp/sinja/extensions/sinja-sequel
+gem bump
+
+# this also bumps sinja-sequel only
+cd /tmp/sinja/extensions/sinja-sequel
+gem bump sinja-sequel
+```
+
+## Nested gem with irregular directory name
+
+### Setup
+
+```
+export GEM_RELEASE_PUSH=false
+cd /tmp
+rm -rf sinja
+gem bootstrap sinja
+cd sinja
+mkdir -p extensions
+cd extensions
+gem bootstrap sinja-sequel
+mv sinja-sequel sequel
+cd /tmp/sinja
+tree
+```
+
+### Directory structure
+
+```
+.
+├── Gemfile
+├── LICENSE.md
+├── extensions
+│   └── sequel
+│       ├── Gemfile
+│       ├── LICENSE.md
+│       ├── lib
+│       │   └── sinja
+│       │       ├── sequel
+│       │       │   └── version.rb
+│       │       └── sequel.rb
+│       └── sinja-sequel.gemspec
+├── lib
+│   ├── sinja
+│   │   └── version.rb
+│   └── sinja.rb
+└── sinja.gemspec
+```
+
+### Behaviour
+
+```
+# this bumps both sinja and sinja-sequel
+cd /tmp/sinja
+gem bump --recurse
+
+# this bumps sinja
+cd /tmp/sinja
+gem bump
+
+# this also bumps sinja
+cd /tmp/sinja
+gem bump sinja
+
+# this bumps sinja-sequel only
+cd /tmp/sinja
+gem bump sinja-sequel
+
+# this also bumps sinja-sequel only
+cd /tmp/sinja/extensions/sinja-sequel
+gem bump
+
+# this also bumps sinja-sequel only
+cd /tmp/sinja/extensions/sinja-sequel
+gem bump sinja-sequel
+```
+

data/lib/gem/release.rb

@@ -0,0 +1,13 @@
+module Gem
+  module Release
+    Abort = Class.new(StandardError)
+
+    STRATEGIES = {
+      git:  '`git ls-files app lib`.split("\n")',
+      glob: "Dir.glob('{bin/*,lib/**/*,[A-Z]*}')"
+    }
+  end
+end
+
+require 'gem/release/cmds'
+require 'gem/release/config'

data/lib/gem/release/cmds.rb

@@ -0,0 +1,16 @@
+require 'gem/release/cmds/bootstrap'
+require 'gem/release/cmds/bump'
+require 'gem/release/cmds/gemspec'
+require 'gem/release/cmds/release'
+require 'gem/release/cmds/runner'
+require 'gem/release/cmds/tag'
+
+module Gem
+  module Release
+    module Cmds
+      def self.[](cmd)
+        Base[cmd]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,101 @@
+require 'gem/release/helper'
+require 'gem/release/helper/hash'
+require 'gem/release/helper/string'
+require 'gem/release/support/registry'
+
+module Gem
+  module Release
+    module Cmds
+      class Base < Struct.new(:context, :args, :opts)
+        include Helper, Helper::Hash, Helper::String, Registry
+
+        class << self
+          include Helper::String
+
+          def inherited(cmd)
+            cmd.register underscore(cmd.name.split('::').last)
+          end
+
+          def arg(name, summary)
+            args << [name, summary]
+          end
+
+          def args
+            @args ||= []
+          end
+
+          def opt(*args, &block)
+            opts << [args, block]
+          end
+
+          def opts
+            @opts ||= superclass != self.class && superclass.respond_to?(:opts) ? superclass.opts.dup : []
+          end
+
+          def usage(usage = nil)
+            usage ? @usage = usage : @usage || '[usage]'
+          end
+
+          WIDTH = 70
+
+          def summary(summary = nil)
+            summary ? @summary = wrap(summary, WIDTH) : @summary || '[summary]'
+          end
+
+          def description(description = nil)
+            description ? @description = wrap(description, WIDTH) : @description
+          end
+        end
+
+        opt '--pretend' do
+          opts[:pretend] = true
+        end
+
+        opt '--quiet' do
+          opts[:quiet] = true
+        end
+
+        attr_reader :gem
+
+        def initialize(context, args, opts)
+          opts = defaults.merge(opts)
+          super
+        end
+
+        def in_dirs
+          context.in_dirs(args, opts) do |name|
+            @gem = Context::Gem.new(name)
+            yield
+          end
+        end
+
+        def in_gem_dirs
+          context.in_gem_dirs(args, opts) do |name|
+            @gem = Context::Gem.new(name)
+            yield
+          end
+        end
+
+        def pretend?
+          !!opts[:pretend]
+        end
+
+        def quiet?
+          opts[:quiet] || opts[:silent]
+        end
+
+        def opts
+          @opts ||= config.merge(super)
+        end
+
+        def config
+          context.config.for(registry_key)
+        end
+
+        def defaults
+          self.class.const_defined?(:DEFAULTS) ? self.class::DEFAULTS : {}
+        end
+      end
+    end
+  end
+end