bmp 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2c8239d42b3a23ccafc9aa63bb1d68c0b93771c
-  data.tar.gz: 5428fb76d0951706ff3c538d12059d8931594ba9
+  metadata.gz: 1be786e4639ed92e94de9d5f6ccdfc5721eb7eb9
+  data.tar.gz: a6c6c2bc71fc02ad26b0eaa71b128b0f525d242c
 SHA512:
-  metadata.gz: ce2e10ce24b53b7f515106ed3b3eb83f5b4332a97718e363f127d91eb20226f0ba1046724267c8f01e3c2f3c00574e146008172e174fcd33e2ddd7a8c77156f5
-  data.tar.gz: dd40f2c484593c87a248a8ecb77531f438debb64eec606cff7c5041592859f5d5ae5826949bf45290568300304ab7dd33a8a864171c450d4f2d9c77bc80f2caf
+  metadata.gz: 3ef35703e36536a76674aafd79db3bdb212ef6204ee4c8b75635b3e715efc4be2eb0dd27ce00964af2fed2857084ce20ac0d68f6a42d41bfaaf6a0c201eb4a66
+  data.tar.gz: fc0e6a7e78866bdc86ab75999f19070f99d8b60d3e46edda313b9983abb7c2eea46209485e5ffee9bd26fdafef1ab0abc98d182426dd4dbaf205fdb6ecf62aed

data/.bmp.yml

@@ -1,6 +1,6 @@
 ---
-version: 1.2.0
-commit: 'chore(version): bump to v%.%.%'
+version: 1.3.1
+commit: 'chore(version): :arrow_heading_up: bump to v%.%.%'
 files:
   README.md: Bmp v%.%.%
-  lib/bump/version.rb: VERSION = "%.%.%"
+  lib/bump/version.rb: VERSION = '%.%.%'

data/.editorconfig

@@ -3,5 +3,4 @@ root = true
 trim_trailing_whitespace = true
 insert_final_newline = true
 indent_style = space
-[*.rb]
-indent_size = 4
+indent_size = 2

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 50
+Metrics/ClassLength:
+  Max: 300
+Metrics/ParameterLists:
+  Enabled: false

data/Gemfile

@@ -1,12 +1,12 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in bump.gemspec
 gemspec
 
 gem 'slop', '~> 4.2.0'
 gem 'rspec'
 
 group :test do
+  gem 'rubocop', '~> 0.40.0', require: false
   gem 'simplecov', require: false
   gem 'coveralls', require: false
 end

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    bmp (1.2.0)
+    bmp (1.3.1)
       slop (~> 4.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.2.0)
     coveralls (0.8.3)
       json (~> 1.8)
       rest-client (>= 1.6.8, < 2)
@@ -22,6 +23,10 @@ GEM
     json (1.8.3)
     mime-types (2.6.2)
     netrc (0.10.3)
+    parser (2.3.1.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
     rake (10.4.2)
     rest-client (1.8.0)
       http-cookie (>= 1.0.2, < 2.0)
@@ -40,6 +45,13 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
+    rubocop (0.40.0)
+      parser (>= 2.3.1.0, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
     simplecov (0.10.0)
       docile (~> 1.1.0)
       json (~> 1.8)
@@ -53,6 +65,7 @@ GEM
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.1)
+    unicode-display_width (1.0.5)
 
 PLATFORMS
   ruby
@@ -63,6 +76,7 @@ DEPENDENCIES
   coveralls
   rake
   rspec
+  rubocop (~> 0.40.0)
   simplecov
   slop (~> 4.2.0)
 

data/README.md

@@ -1,5 +1,4 @@
-# Bmp v1.2.0
-
+# Bmp v1.3.1
 [![Gem Version](https://img.shields.io/gem/v/bmp.svg)](http://badge.fury.io/rb/bmp)
 [![Build Status](https://img.shields.io/travis/kt3k/bmp.svg)](https://travis-ci.org/kt3k/bmp)
 [![Coverage Status](https://img.shields.io/coveralls/kt3k/bmp.svg)](https://coveralls.io/r/kt3k/bmp)
@@ -9,7 +8,7 @@
 
 `bmp` command bumps and updates the version numbers in a repository according to the yaml file `.bmp.yml`. This is convenient if you have written many version numbers in your repository. This command helps you consistently update the version information in your repository.
 
-## Installation
+## Install
 
 ```sh
 gem install bmp
@@ -116,3 +115,43 @@ And this command also tag it as `vX.Y.Z`.
 # License
 
 MIT
+
+# Development
+
+## dev commands
+
+### dependency download
+
+    bundle install
+
+### lint
+
+    rake rubocop
+
+### test
+
+    rake spec
+
+### install dev version
+
+    rake install
+
+### release
+
+    rake release
+
+## Domain models
+
+Domain models are in `./lib/bump/domain` dir.
+
+### VersionNumber
+
+`VersionNumber` model represents the version number and bumps itself with levels.
+
+### FileUpdateRule
+
+`FileUpdateRule` model represents unit rule of version number replacement. A rule has a version number, a file path and a pattern for replacement.
+
+### BumpInfo
+
+`BumpInfo` model represents overall bumping strategy in a project. This model loosely corresponds to the contents of `.bmp.yml`.

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task :default => :spec
+task default: :spec

data/TODO.md

@@ -1,26 +1,24 @@
 # TODO
 
-- Add frontend layer between slop and application
-- use mock library
-- gh-pages yardoc
-- bmp -t|--touch -> create empty .bmp.yml
+- upload document, gh-pages yardoc
 
 - yaml parse error handling
 - no `version` case handling
 - no `files` case handling
 
-- interactive init, bump --init
+- feat: interactive init, bump --init
 
-- test FileRewriteRule
-- test FileRewriteRuleFactory
-- test VersionDescriptor
-- test VersionDescriptorRepository
+# DONE
+- refactor: application.rb returns boolean, bin/bmp exits with the returned boolean
+- use mock library
 - test Application
 - test CLI
 - test Logger
 - test Command
-
-# DONE
+- test FileRewriteRule
+- test FileRewriteRuleFactory
+- test VersionDescriptor
+- test VersionDescriptorRepository
 - support pre-release version number (of semver)
 - support build version number (of semver) - pending
 - Generate documentaion

data/bin/bmp

@@ -1,6 +1,18 @@
 #! /usr/bin/env ruby
 
 require 'bump'
+require 'slop'
 
-Bump::CLI.new.main
+exit Bump::CLI.new(Slop.parse do |o|
+  o.banner = "Usage: #{Bump::CLI::CLI_NAME} [-p|-m|-j] [-c]"
 
+  o.bool '-i', '--info', 'show current version info'
+  o.bool '-p', '--patch', 'bump patch (0.0.1) level'
+  o.bool '-m', '--minor', 'bump minor (0.1.0) level'
+  o.bool '-j', '--major', 'bump major (1.0.0) level'
+  o.bool '-c', '--commit', 'commit bump changes (git required)'
+  o.bool '-h', '--help', 'show this help and exit'
+  o.bool '-v', '--version', 'show the version of this command and exit'
+  o.bool '-r', '--release', 'remove the pre-release version id'
+  o.string '-s', '--preid', 'set the pre-release version id (e.g. alpha, beta.1)'
+end).main

data/bump.gemspec

@@ -1,25 +1,24 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'bump/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "bmp"
+  spec.name = 'bmp'
   spec.version       = Bump::VERSION
-  spec.authors       = ["Yoshiya Hinosawa"]
-  spec.email         = ["stibium121@gmail.com"]
-  spec.description   = "Bump version numbers in a repository"
-  spec.summary       = "No hassle on bumping"
-  spec.homepage      = "https://github.com/kt3k/bump"
-  spec.license       = "MIT License"
+  spec.authors       = ['Yoshiya Hinosawa']
+  spec.email         = ['stibium121@gmail.com']
+  spec.description   = 'Bump version numbers in a repository'
+  spec.summary       = 'No hassle on bumping'
+  spec.homepage      = 'https://github.com/kt3k/bump'
+  spec.license       = 'MIT License'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($RS)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency "slop", "~> 4.2.0"
+  spec.add_runtime_dependency 'slop', '~> 4.2.0'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
 end

data/lib/bump.rb

@@ -1,4 +1,3 @@
-
 require 'bump/version'
 require 'bump/domain'
 require 'bump/application'

data/lib/bump/application.rb

@@ -1,280 +1,291 @@
-# lib/bump/application.rb
-
 require 'bump/command'
 
 module Bump
+  # The application
+  class Application
+    # @param [Hash] options The cli options
+    # @param [String] help The help message
+    # @param [String] version The version expression of this command
+    # @param [String] file The file name of bump info file
+    # @param [Bump::Logger] logger The logger
+    # @param [Bump::Command] logger The command executer
+    def initialize(options, help, version, file, logger, command = nil)
+      @options = options
+      @help = help
+      @version = version
+      @file = file
+      @logger = logger
+      @command = command
+      @command = Bump::Command.new @logger if @command.nil?
+    end
 
-    # The application
-    class Application
-
-        # @param [Hash] options The cli options
-        # @param [String] help The help message
-        # @param [String] version The version expression of this command
-        # @param [String] file The file name of bump info file
-        # @param [Bump::Logger] logger The logger
-        def initialize options, help, version, file, logger
-            @options = options
-            @help = help
-            @version = version
-            @file = file
-            @logger = logger
-        end
-
-        # Returns a symbol which represents the action to perform.
-        #
-        # @return [Symbol]
-        def selectAction
-            if @options[:help]
-                return :help
-            end
-
-            if @options[:version]
-                return :version
-            end
-
-            if @options[:info]
-                return :info
-            end
-
-            if @options[:major] || @options[:minor] || @options[:patch] || @options[:commit] || @options[:preid] || @options[:release]
-                return :bump
-            end
-
-            # command without options invokes info action
-            return :info
-        end
-
-        # handler of `bmp --version`
-        #
-        # @return [void]
-        def actionVersion
-            log @version
-        end
-
-        # handler of `bmp --help`
-        #
-        # @return [void]
-        def actionHelp
-            log @help
-        end
-
-        # Gets the bump info
-        #
-        # @return [Bump::BumpInfo]
-        def getBumpInfo
-
-            repo = BumpInfoRepository.new @file
-
-            begin
-                bumpInfo = repo.fromFile
-            rescue Errno::ENOENT => e then
-                log_red "Error: the file `#{@file}` not found."
-                exit 1
-            end
-
-            return bumpInfo
+    # Returns a symbol which represents the action to perform.
+    # @return [Symbol]
+    def select_action
+      return :help if @options[:help]
 
-        end
+      return :version if @options[:version]
 
-        # Saves the bump info
-        #
-        # @param [Bump::BumpInfo] bumpInfo
-        # @return [void]
-        def saveBumpInfo bumpInfo
-            repo = BumpInfoRepository.new @file
+      return :info if @options[:info]
 
-            repo.save bumpInfo
-        end
+      return :bump if bump_option? @options
 
-        # Shows the version patterns.
-        #
-        # @param [Bump::BumpInfo] bumpInfo
-        # @return [void]
-        def showVersionPatterns bumpInfo
+      # command without options invokes info action
+      :info
+    end
 
-            log "Current Version:", false
-            log_green " #{bumpInfo.beforeVersion}"
+    # Returns true iff it's a bump option.
+    # @param [Hash] options The options
+    def bump_option?(options)
+      options[:major] || options[:minor] || options[:patch] || options[:commit] || options[:preid] || options[:release]
+    end
 
-            log "Version patterns:"
+    # handler of `bmp --version`
+    #
+    # @return [void]
+    def action_version
+      log @version
 
-            bumpInfo.updateRules.each do |rule|
+      true
+    end
 
-                if not rule.fileExists
+    # handler of `bmp --help`
+    #
+    # @return [void]
+    def action_help
+      log @help
 
-                    log_red "  #{rule.file}:", false
-                    log_red " '#{rule.beforePattern}' (file not found)"
+      true
+    end
 
-                    next
+    # Gets the bump info
+    # @private
+    # @return [Bump::BumpInfo]
+    def create_bump_info
+      repo = BumpInfoRepository.new @file
 
-                end
+      begin
+        bump_info = repo.from_file
+      rescue Errno::ENOENT
+        log_red "Error: the file `#{@file}` not found."
+        return nil
+      end
 
-                log "  #{rule.file}:", false
+      bump_info
+    end
 
-                if not rule.patternExists
+    # Saves the bump info
+    # @param [Bump::BumpInfo] bumpInfo
+    # @return [void]
+    def save_bump_info(bump_info)
+      repo = BumpInfoRepository.new @file
 
-                    log_red " '#{rule.beforePattern}' (pattern not found)"
+      repo.save bump_info
+    end
 
-                    next
+    # Shows the version patterns.
+    # @param [Bump::BumpInfo] bumpInfo
+    # @return [void]
+    def print_version_patterns(bump_info)
+      log 'Current Version:', false
+      log_green " #{bump_info.before_version}"
 
-                end
+      log 'Version patterns:'
 
-                log_green " '#{rule.beforePattern}'"
-            end
-        end
+      bump_info.update_rules.each do |rule|
+        print_rule rule
+      end
+    end
 
-        # handler of `bmp [--info]`
-        #
-        # @return [void]
-        def actionInfo
+    # Prints the pattern info for the given rule
+    # @param [Bump::FileUpdateRule] rule The rule
+    def print_rule(rule)
+      unless rule.file_exists
+        log_red "  #{rule.file}:", false
+        log_red " '#{rule.before_pattern}' (file not found)"
 
-            bumpInfo = getBumpInfo
+        return
+      end
 
-            showVersionPatterns bumpInfo
+      log "  #{rule.file}:", false
 
-            if bumpInfo.check
-                exit 0
-            else
-                exit 1
-            end
+      unless rule.pattern_exists
+        log_red " '#{rule.before_pattern}' (pattern not found)"
 
-        end
+        return
+      end
 
+      log_green " '#{rule.before_pattern}'"
+    end
 
-        # Checks the bumping is possible.
-        #
-        # @param [Bump::BumpInfo] bumpInfo
-        # @return [void]
-        def checkBumpInfo bumpInfo
+    # handler of `bmp [--info]`
+    #
+    # @return [void]
+    def action_info
+      bump_info = create_bump_info
 
-            if not bumpInfo.check
-                log_red "Some patterns are invalid!"
-                log_red "Stops updating version numbers."
-                log
+      return false if bump_info.nil?
 
-                showVersionPatterns bumpInfo
+      print_version_patterns bump_info
 
-                exit 1
-            end
+      bump_info.valid?
+    end
 
-        end
+    # Checks the bumping is possible.
+    # @param [Bump::BumpInfo] bumpInfo
+    # @return [void]
+    def print_invalid_bump_info(bump_info)
+      log_red 'Some patterns are invalid!'
+      log_red 'Stops updating version numbers.'
+      log
 
-        # Reports the bumping details.
-        #
-        # @param [Bump::BumpInfo] bumpInfo
-        # @return [void]
-        def report bumpInfo
-            bumpInfo.updateRules.each do |rule|
+      print_version_patterns bump_info
+    end
 
-                log "#{rule.file}"
-                log "  Performed pattern replacement:"
-                log_green "    '#{rule.beforePattern}' => '#{rule.afterPattern}'"
-                log
+    # Reports the bumping details.
+    # @param [Bump::BumpInfo] bumpInfo
+    def report(bump_info)
+      bump_info.update_rules.each do |rule|
+        log rule.file.to_s
+        log '  Performed pattern replacement:'
+        log_green "    '#{rule.before_pattern}' => '#{rule.after_pattern}'"
+        log
+      end
+    end
 
-            end
-        end
+    # The bump action
+    # @return [Boolean] true iff success
+    def action_bump
+      bump_info = create_bump_info
 
-        # handler of `bmp --patch|--minor|--major|--commit`
-        #
-        # @return [void]
-        def actionBump
+      return false if bump_info.nil?
 
-            bumpInfo = getBumpInfo
+      print_bump_plan bump_info
 
-            [:major, :minor, :patch].each do |level|
-                if @options[level]
-                    bumpInfo.bump level
-                    log "Bump #{level} level"
-                    log_green "  #{bumpInfo.beforeVersion} => #{bumpInfo.afterVersion}"
-                    break
-                end
-            end
+      unless bump_info.valid?
+        print_invalid_bump_info bump_info
 
-            if @options[:preid]
-                preid = @options[:preid]
-                bumpInfo.setPreid preid
-                log "Set pre-release version id: ", false
-                log_green preid
-                log_green "  #{bumpInfo.beforeVersion} => #{bumpInfo.afterVersion}"
-            end
+        return false
+      end
 
-            if @options[:release]
-                bumpInfo.setPreid nil
-                log "Remove pre-release version id"
-                log_green "  #{bumpInfo.beforeVersion} => #{bumpInfo.afterVersion}"
-            end
+      bump_info.perform_update
 
-            log
+      report bump_info
 
-            checkBumpInfo bumpInfo
+      save_bump_info bump_info
 
-            bumpInfo.performUpdate
+      commit_and_tag bump_info if @options[:commit]
 
-            report bumpInfo
+      true
+    end
 
-            saveBumpInfo bumpInfo
+    # Gets the requested bump level.
+    # @return [Symbol]
+    def bump_level
+      return :major if @options[:major]
+      return :minor if @options[:minor]
+      return :patch if @options[:patch]
+    end
 
-            comm = Command.new @logger
+    # Prints the version bump plan.
+    # @param [Bump::BumpInfo] bump_info The bump info
+    def print_bump_plan(bump_info)
+      level = bump_level
+      print_bump_plan_level level, bump_info unless level.nil?
 
-            if @options[:commit]
-                comm.exec "git add ."
-                comm.exec "git commit -m '#{bumpInfo.getCommitMessage}'"
-                comm.exec "git tag v#{bumpInfo.afterVersion}"
-            end
-        end
+      preid = @options[:preid]
+      print_bump_plan_preid preid, bump_info unless preid.nil?
 
-        # The entry point
-        #
-        # @return [void]
-        def main
+      print_bump_plan_release bump_info if @options[:release]
 
-            action = selectAction
+      log
+    end
 
-            case action
-            when :version
-                actionVersion
-            when :help
-                actionHelp
-            when :info
-                actionInfo
-            when :bump
-                actionBump
-            end
+    # Prints the bump plan for the given level.
+    # @param [Symbol] level The level
+    # @param [Bump::BumpInfo] bump_info The bump info
+    def print_bump_plan_level(level, bump_info)
+      bump_info.bump level
 
-        end
+      log "Bump #{level} level"
+      print_version_transition bump_info
+    end
 
-        # Logs the message
-        #
-        # @param [String] message
-        # @param [Boolean] newline
-        # @return [void]
-        def log message = '', newline = true
+    # Prints the bump plan for the give preid.
+    # @param [Bump::BumpInfo] bump_info The bump info
+    def print_bump_plan_preid(preid, bump_info)
+      bump_info.preid = preid
 
-            @logger.log message, newline
+      log 'Set pre-release version id: ', false
+      log_green preid
+      print_version_transition bump_info
+    end
 
-        end
+    # Prints the bump plan for the release
+    # @param [Bump::BumpInfo] bump_info The bump info
+    def print_bump_plan_release(bump_info)
+      bump_info.preid = nil
 
-        # Logs the message in red
-        #
-        # @param [String] message
-        # @param [Boolean] newline
-        # @return [void]
-        def log_red message, newline = true
-
-            log @logger.red(message), newline
+      log 'Remove pre-release version id'
+      print_version_transition bump_info
+    end
 
-        end
+    # Prints the version transition.
+    # @param [Bump::BumpInfo] bump_info The bump info
+    def print_version_transition(bump_info)
+      log_green "  #{bump_info.before_version} => #{bump_info.after_version}"
+    end
 
-        # Logs the message in green
-        #
-        # @param [String] message
-        # @param [Boolean] newline
-        # @return [void]
-        def log_green message, newline = true
+    # Commits current changes and tag it by the current version.
+    # @param [Bump::BumpInfo] bump_info The bump info
+    def commit_and_tag(bump_info)
+      @logger.log '===> executing commands'
+      @command.exec 'git add .'
+      @command.exec "git commit -m '#{bump_info.commit_message}'"
+      @command.exec "git tag v#{bump_info.after_version}"
+    end
 
-            log @logger.green(message), newline
+    # The entry point
+    #
+    # @return [void]
+    def main
+      case select_action
+      when :version
+        action_version
+      when :help
+        action_help
+      when :info
+        action_info
+      when :bump
+        action_bump
+      end
+    end
 
-        end
+    # Logs the message
+    #
+    # @param [String] message
+    # @param [Boolean] newline
+    # @return [void]
+    def log(message = '', newline = true)
+      @logger.log message, newline
+    end
 
+    # Logs the message in red
+    #
+    # @param [String] message
+    # @param [Boolean] newline
+    # @return [void]
+    def log_red(message, newline = true)
+      log @logger.red(message), newline
     end
 
+    # Logs the message in green
+    #
+    # @param [String] message
+    # @param [Boolean] newline
+    # @return [void]
+    def log_green(message, newline = true)
+      log @logger.green(message), newline
+    end
+  end
 end