gem-release 1.0.0 → 2.0.0.dev.1

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

@@ -0,0 +1,222 @@
+require 'gem/release/cmds/base'
+require 'gem/release/data'
+require 'gem/release/files/templates'
+
+module Gem
+  module Release
+    module Cmds
+      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.
+
+          If no argument is given the current directory name is used as the gem name. If
+          one or many arguments are given then these will be used as gem names, and new
+          directories will be created accordingly.
+
+          By default the following files will be created:
+
+          * `.gitignore`
+          * `Gemspec`
+          * `[gem-name].gemspec`
+          * `LICENSE.md`
+          * `lib/[gem]/[name].rb`
+          * `lib/[gem]/[name]/version.rb`
+
+          Templates in the first existing one of these directories will always be used to
+          create additional files:
+
+          * `./.gem-release/default` (local)
+          * `~/.gem-release/default` (global)
+
+          If `--template [group]` is given additional files will be created from the
+          first existing one of these directories:
+
+          * `./.gem-release/[group]` (local)
+          * `~/.gem-release/[group]` (global)
+
+          It is possible to specify several template groups in order to add files from
+          several custom template directories.
+
+          If `--template rspec` is given then additionally the files `.rspec` and
+          `spec/spec_helper.rb` will be created, or whatever files exist in a local or
+          global directory `.gem-release/templates/rspec`.
+
+          If `--template travis` is given then additionally the file `.travis.yml` will
+          be created, or whatever files exist in a local or 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`.
+        str
+
+        arg :gem_name, 'name of the gem (optional, will default to the current directory name if not specified)'
+
+        DEFAULTS = {
+          strategy:  :glob,
+          scaffold:  true,
+          git:       true,
+          github:    false,
+          push:      false,
+          license:   :mit,
+          templates: []
+        }
+
+        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',
+          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)',
+          strategy: 'Strategy for collecting files [glob|git] in .gemspec',
+          git:      'Initialize a git repo',
+          github:   'Initialize a git repo, create on github',
+          remote:   'Git remote repository',
+          push:     'Push the git repo to github'
+        }
+
+        opt '--[no]-scaffold', DESCR[:scaffold] do |value|
+          opts[:scaffold] = value
+        end
+
+        opt '--dir DIR', DESCR[:dir] do |value|
+          opts[:dir] = value
+        end
+
+        opt '-t', '--template NAME', DESCR[:template] do |value|
+          (opts[:templates] ||= []) << value
+        end
+
+        opt '--rspec', DESCR[:rspec] do |value|
+          (opts[:templates] ||= []) << value
+        end
+
+        opt '--travis', DESCR[:travis] do |value|
+          (opts[:templates] ||= []) << value
+        end
+
+        opt '-l', '--no-license NAME', DESCR[:license] do |value|
+          value ? (opts[:license] ||= []) << value : opts[:license] = []
+        end
+
+        opt '-s', '--strategy NAME', DESCR[:strategy] do |value|
+          opts[:strategy] = value
+        end
+
+        opt '--git', DESCR[:git] do |value|
+          opts[:git] = value
+        end
+
+        opt '--github', DESCR[:github] do |value|
+          opts[:github] = value
+        end
+
+        opt '--remote', DESCR[:remote] do |value|
+          opts[:remote] = value
+        end
+
+        opt '--push', DESCR[:push] do |value|
+          opts[:push] = value
+        end
+
+        MSGS = {
+          scaffold:        'Scaffolding gem %s',
+          create:          'Creating %s',
+          exists:          'Skipping existing file %s',
+          git_init:        'Initializing git repository',
+          git_add:         'Adding files',
+          git_commit:      'Creating initial commit',
+          git_remote:      'Adding git remote %s',
+          git_push:        'Pushing to git remote %s',
+          unknown_license: 'Unknown license: %s'
+        }
+
+        CMDS = {
+          git_init:   'git init',
+          git_add:    'git add .',
+          git_commit: 'git commit -m "Initial commit"',
+          git_remote: 'git remote add %s https://github.com/%s.git',
+          git_push:   'git push -u %s master'
+        }
+
+        def run
+          in_dirs do
+            scaffold    if opts[:scaffold]
+            init_git    if opts[:github] || opts[:git]
+            create_repo if opts[:github]
+          end
+        end
+
+        private
+
+          FILES = %w(
+            .gitignore
+            Gemfile
+            gemspec
+            main.rb
+            version.rb
+          )
+
+          def scaffold
+            announce :scaffold, gem.name
+            files.each { |file| write(file) }
+          end
+
+          def files
+            files = Files::Templates.new(FILES, opts[:templates], data).all
+            files << license if opts[:license]
+            files.compact
+          end
+
+          def license
+            file = Files::Templates.license(opts[:license], data)
+            warn :unknown_license, opts[:license] unless file
+            file
+          end
+
+          def write(file)
+            msg   = :create if pretend?
+            msg ||= file.write ? :create : :exists
+            level = msg == :create ? :info : :warn
+            send(level, msg, file.target)
+          end
+
+          def init_git
+            cmd :git_init
+            cmd :git_add
+            cmd :git_commit
+          end
+
+          def create_repo
+            cmd :git_remote, remote, "#{github_user_name}/#{gem.name}"
+            cmd :git_push, remote if opts[:push]
+          end
+
+          def data
+            Data.new(system, gem, opts).data
+          end
+
+          def remote
+            opts[:remote] || :origin
+          end
+
+          def opts
+            @opts ||= normalize(super)
+          end
+
+          def normalize(opts)
+            opts[:templates] << 'rspec'  if opts.delete(:rspec)
+            opts[:templates] << 'travis' if opts.delete(:travis)
+            opts
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,165 @@
+require 'gem/release/cmds/base'
+require 'gem/release/files/version'
+
+module Gem
+  module Release
+    module Cmds
+      class Bump < Base
+        summary 'Bumps one, several, or all gems in this directory.'
+
+        description <<~str
+          Bumps the version number defined in lib/[gem_name]/version.rb to to a given,
+          specific version number, or to the next major, minor, patch, or pre-release
+          level.
+
+          Optionally it pushes to the origin repository. Also, optionally it invokes the
+          `gem tag` and/or `gem release` command.
+
+          If no argument is given the first gemspec's name is assumed as the gem name.
+          If one or many arguments are given then these will be used as gem names. If
+          `--recurse` is given then all gem names from all gemspecs in this directory or
+          any of its subdirectories will be used.
+
+          The version can be bumped to either one of these targets:
+
+          ```
+          major
+          1.1.1       # Bump to the given, specific version number
+          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)
+          ```
+
+          When searching for the version file for a gem named `gem-name`: the following
+          paths will be searched relative to the gemspec's directory.
+
+          * `lib/gem-name/version.rb`
+          * `lib/gem/name/version.rb`
+        str
+
+        arg :gem_name, 'name of the gem (optional, will use the directory name, or all gemspecs if --recurse is given)'
+
+        DESCR = {
+          version: 'Target version: next [major|minor|patch|pre|release] or a given version number [x.x.x]',
+          commit:  'Perform a commit after incrementing gem version',
+          push:    'Push the new commit to the git remote repository',
+          remote:  'Git remote to push to (defaults to origin)',
+          tag:     'Shortcut for running the `gem tag` command',
+          recurse: 'Recurse into directories that contain gemspec files',
+          release: 'Shortcut for the `gem release` command'
+        }
+
+        DEFAULTS = {
+          commit: true,
+          push:   true,
+          remote: 'origin'
+        }
+
+        opt '-c', '--[no-]commit', DESCR[:commit] do |value|
+          opts[:commit] = value
+        end
+
+        opt '-p', '--[no-]push', DESCR[:push] do |value|
+          opts[:push] = value
+        end
+
+        opt '--remote REMOTE', DESCR[:remote] do |value|
+          opts[:remote] = value
+        end
+
+        opt '-v', '--version VERSION', DESCR[:version] do |value|
+          opts[:version] = value
+        end
+
+        opt '-t', '--tag', DESCR[:tag] do |value|
+          opts[:tag] = value
+        end
+
+        opt '-r', '--release', DESCR[:release] do |value|
+          opts[:release] = value
+        end
+
+        opt '--recurse', DESCR[:recurse] do |value|
+          opts[:recurse] = value
+        end
+
+        MSGS = {
+          not_found:  'Ignoring %s. Version file %s not found.',
+          no_remote:  'Cannot push to missing git remote %s.',
+          bump:       'Bumping %s from version %s to %s',
+          version:    'Changing version in %s from %s to %s',
+          git_add:    'Staging %s',
+          git_commit: 'Creating commit',
+          git_push:   'Pushing to the %s git repository'
+        }
+
+        CMDS = {
+          git_add:    'git add %s',
+          git_commit: 'git commit -m "Bump to %s"',
+          git_push:   'git push %s'
+        }
+
+        def run
+          in_gem_dirs do
+            validate
+            bump
+            commit  if opts[:commit]
+            push    if opts[:commit] && opts[:push]
+            reset
+          end
+          tag     if opts[:tag]
+          release if opts[:release]
+        end
+
+        private
+
+          def validate
+            abort :not_found, gem.name, version.path unless version.exists?
+            abort :no_remote, remote if push? && !git_remotes.include?(remote)
+          end
+
+          def bump
+            announce :bump, gem.name, version.from, version.to
+            return true if pretend?
+            notice :version, version.path, version.from, version.to
+            version.bump
+          end
+
+          def commit
+            cmd :git_add, version.path
+            cmd :git_commit, version.to
+          end
+
+          def push
+            cmd :git_push, remote
+          end
+
+          def tag
+            Tag.new(context, args, opts).run
+          end
+
+          def release
+            Release.new(context, args, except(opts, :tag)).run
+          end
+
+          def reset
+            @version = nil
+          end
+
+          def version
+            @version ||= Files::Version.new(gem.name, opts[:version])
+          end
+
+          def push?
+            opts[:push]
+          end
+
+          def remote
+            opts[:remote]
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+require 'gem/release/cmds/base'
+require 'gem/release/data'
+require 'gem/release/files/template'
+
+module Gem
+  module Release
+    module Cmds
+      class Gemspec < Base
+        summary 'Generates a gemspec.'
+
+        description <<~str
+          #{summary}
+
+          If no argument is given the current directory name is used as the gem name. If
+          one or many arguments are given then these will be used as gem names, and new
+          directories will be created accordingly.
+
+          The generated `gemspec` file will use the `glob` strategy for finding files by
+          default. Known strategies are:
+
+          * `glob` - uses the glob pattern `{bin/*,lib/**/*,[A-Z]*}`
+          * `git`  - uses the git command `git ls-files app lib`
+        str
+
+        arg :gem_name, 'name of the gem (optional, will default to the current directory name if not specified)'
+
+        DEFAULTS = {
+          strategy: :glob
+        }
+
+        DESCR = {
+          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 '--dir DIR', DESCR[:dir] do |value|
+          opts[:dir] = value
+        end
+
+        opt '-l', '--[no]-license[s] NAMES', DESCR[:license] do |value|
+          value ? (opts[:license] ||= []) << value : opts[:license] = []
+        end
+
+        opt '-s', '--strategy', DESCR[:strategy] do |value|
+          opts[:strategy] = value
+        end
+
+        MSGS = {
+          gemspec: 'Generating %s.gemspec',
+          create:  'Creating %s',
+          exists:  'Skipping %s: already exists'
+        }
+
+        def run
+          in_dirs do
+            announce :gemspec, gem.name
+            generate
+          end
+        end
+
+        private
+
+          def generate
+            msg   = :create if pretend?
+            msg ||= file.write ? :create : :exists
+            level = msg == :create ? :notice : :warn
+            send(level, msg, file.target)
+          end
+
+          def file
+            templates["#{gem.name}.gemspec"]
+          end
+
+          def templates
+            Files::Templates.new(['gemspec'], opts[:template], data)
+          end
+
+          def data
+            Data.new(system, gem, opts).data
+          end
+      end
+    end
+  end
+end