bump 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4cc77e3ae46a84602fc8c584624d77b69a44ef4e
-  data.tar.gz: a8a1fad7cc8f4f3db749556b81f1c51c168aaaa0
+SHA256:
+  metadata.gz: edcda9c3ea370efa0927b59c72718d997c204026139349f9c3ed8a5d62b688d8
+  data.tar.gz: c866f3dd937aad196d1bc1204115698f4f28ebc027abdca2ea07ded1ede4ef3d
 SHA512:
-  metadata.gz: e170caed9096057c8826562869cfd62b30b6cb25577b601242e17e3e603d620ddd5f43890cb7e47aa506719d2d198d13c18d581cfeaa21053c75757c3247d575
-  data.tar.gz: 48323ff4e45dd6d626781b7251402376c5821cb14f8bcb3ed5b9c8cf198f0af6893c69c3356ff26fdece50e6466e247069022fbcc79db85e71223951595d976a
+  metadata.gz: d911a104915b66431136fece97b24853b039bddde41f30839a95d104647280e108f567da9359f2740b37d625ad81941a4fbf64a5e9c8914475bb95b86e21ecff
+  data.tar.gz: 2ca0ed62d336d9db203a7ee864498e14e8eab70316179ae92649803a426d2a6f75f1349a9c5d5ecf5ccb9b9431004f7a05d2b7edbb854512f2ea62408c682632

data/README.md

@@ -17,7 +17,7 @@ A gem to bump versions of gems and chef-cookbooks.
 
     bump current
 
-> Current version: 0.1.2
+> 0.1.2
 
 ### Bump (major, minor, patch, pre)
 
@@ -29,13 +29,13 @@ A gem to bump versions of gems and chef-cookbooks.
 
     bump show-next patch
 
-> Next patch version: 0.1.3
+> 0.1.3
 
 ### Show version file path
 
     bump file
 
-> Version file path: lib/foo/version.rb
+> lib/foo/version.rb
 
 ## Options
 
@@ -66,7 +66,7 @@ Do not run `bundle` command after bumping.
 
 Bump the version in additional files.
 
-    bump patch --reaplace-in Readme.md
+    bump patch --replace-in Readme.md
 
 ### `--commit-message [MSG], -m [MSG]`
 
@@ -80,7 +80,7 @@ or
 
 ### `--changelog`
 
-Update `CHANGELOG.md` when bumping.
+Updates `CHANGELOG.md` when bumping.
 This requires a heading (starting with `##`) that includes the previous version and a heading above that, for example:
 
 ```markdown
@@ -91,6 +91,16 @@ This requires a heading (starting with `##`) that includes the previous version
 - Added foo
 ```
 
+### `--edit-changelog`
+
+Updates CHANGELOG.md when bumping (see above), and
+opens the changelog in an editor specified in `$EDITOR` (or `vi`),
+then waits for the editor to be closed and continues.
+
+```bash
+EDITOR="subl -n -w" bump patch --edit-changelog
+```
+
 ## Rake
 
 ```ruby
@@ -106,6 +116,8 @@ require "bump/tasks"
 #
 # Maintain changelog:
 # Bump.changelog = true
+# Opens the changelog in an editor when bumping
+# Bump.changelog = :editor
 ```
 
     rake bump:current                           # display current version

data/bin/bump

@@ -28,6 +28,8 @@ OptionParser.new do |opts|
   opts.on("--tag-prefix TAG_PREFIX", "Prefix the tag with this string, ex. 'v'") { |tag_prefix| options[:tag_prefix] = tag_prefix }
   opts.on("--replace-in FILE", String, "Replace old version with the new version additionally in this file") { |f| (options[:replace_in] ||= []) << f }
   opts.on("--changelog", "Update CHANGELOG.md") { options[:changelog] = true }
+  opts.on("--edit-changelog", "Use $EDITOR to open changelog before committing, e.g. 'subl -n -w' or 'nano'.") { options[:changelog] = :editor }
+  opts.on("--value-only", "Do not prefix the output with any descriptive text") { options[:value_only] = true }
   opts.on("-h", "--help", "Show this.") { puts opts; exit }
 end.parse!
 

data/lib/bump.rb

@@ -43,14 +43,14 @@ module Bump
 
           bump_set(options[:version], options)
         when "current"
-          ["Current version: #{current}", 0]
+          [current, 0]
         when "show-next"
           increment = options[:increment]
           raise InvalidIncrementError unless BUMPS.include?(increment)
 
           [next_version(increment), 0]
         when "file"
-          ["Version file path: #{file}", 0]
+          [file, 0]
         else
           raise InvalidOptionError
         end
@@ -145,6 +145,8 @@ module Bump
           error = bump_changelog(log, next_version)
           return [error, 1] if error
 
+          open_changelog(log) if options[:changelog] == :editor
+
           git_add log if options[:commit]
         end
 
@@ -152,12 +154,21 @@ module Bump
         commit next_version, options if options[:commit]
 
         # tell user the result
-        ["Bump version #{current} to #{next_version}", 0]
+        [next_version, 0]
+      end
+
+      def open_changelog(log)
+        editor = ENV['EDITOR'] || "vi"
+        system "#{editor} #{log}"
       end
 
       def bundler_with_clean_env(&block)
         if defined?(Bundler)
-          Bundler.with_clean_env(&block)
+          if Bundler.respond_to?(:with_unbundled_env)
+            Bundler.with_unbundled_env(&block)
+          else
+            Bundler.with_clean_env(&block)
+          end
         else
           yield
         end
@@ -177,16 +188,21 @@ module Bump
       def bump_changelog(file, current)
         parts = File.read(file).split(/(^##+.*)/) # headlines and their content
         prev_index = parts.index { |p| p =~ /(^##+.*(\d+\.\d+\.\d+(\.[a-z]+)?).*)/ } # position of previous version
-        return "Unable to find previous version" unless prev_index
+        return "Unable to find previous version in CHANGELOG.md" unless prev_index
 
         # reuse the same style by just swapping the numbers
-        new_heading = "\n" + parts[prev_index].sub($2, current)
-
+        new_heading = parts[prev_index].sub($2, current)
         # add current date if previous heading used that
         new_heading.sub!(/\d\d\d\d-\d\d-\d\d/, Time.now.strftime('%Y-%m-%d'))
 
-        # put our new heading underneath the "Next" heading, which should be above the last version
-        parts.insert prev_index - 1, new_heading
+        if prev_index < 2
+          # previous version is first '##' element (no '## Next' present), add line feed after version to avoid
+          # '## v1.0.1## v1.0.0'
+          parts.insert prev_index - 1, new_heading + "\n"
+        else
+          # put our new heading underneath the "Next" heading, which should be above the last version
+          parts.insert prev_index - 1, "\n" + new_heading
+        end
 
         File.write file, parts.join("")
         nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bump
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Gregory Marcilhacy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-12 00:00:00.000000000 Z
+date: 2020-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email: g.marcilhacy@gmail.com
 executables:
 - bump
@@ -81,7 +81,7 @@ homepage: https://github.com/gregorym/bump
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -96,9 +96,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Bump your gem version file
 test_files: []