vump 2.0.0.pre.alpha.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec1748a44dde478e47b682e58b26b93acd5576b1943b190f6d51273503bdb41b
-  data.tar.gz: 15ca18dc809e13ccd90e93fa213b2428931a2005353bbf8c40b608993ac8183c
+  metadata.gz: 9f02945e44f4f83779a9cad49ec9c57f1f3bef719f072e53cb795d2c69030f97
+  data.tar.gz: e6d702152984f02d78828d6200e6089fccbae43f1891302ef8dee6dce65b0dbc
 SHA512:
-  metadata.gz: e8318b5ea233fed11cf79c570ef1748f5fc98a6393065246f6dbfd29dbe28cb87e83bd35de3b6bc21426e71b2472c96cc00e0fd4fa327b7f44bd1d01efd82236
-  data.tar.gz: 92bbad25ecf6116304382d3097b98191dc841914593b8a8ad85f950466735343ff081d73b063d6586e4e1a7b110963e036393af77f3e7e97c347e4b3974d0fec
+  metadata.gz: 874d16aad24498b659d27ba99b2e3a01631cc53dda1c469fb46d98754de79e28d4b824c25317cd8660b48f9aff859d4215919dbad930e22ab1febbae387ef6d0
+  data.tar.gz: 3257dbcf0ac6558fadeafdd44c6981c95f0af0cce4f986ce5218de7e8cb8063dff8b61d8ce8b24d20cb778ed319564a177494580ec4f888bbfc524aea95d69a2

data/README.md

@@ -1,6 +1,5 @@
-<p align="center">
+<div align="center">
   <img src="https://i.imgur.com/ZH8ftR9.png" height="170">
-</p>
 
 # Vump
 
@@ -9,24 +8,62 @@
 [![Gem](https://img.shields.io/gem/v/vump.svg?style=flat-square)](https://rubygems.org/gems/vump)
 [![Maintainability](https://img.shields.io/codeclimate/maintainability/grissius/vump.svg?style=flat-square)](https://codeclimate.com/github/grissius/vump)
 [![License](https://img.shields.io/github/license/grissius/vump.svg?style=flat-square)](https://github.com/grissius/vump/blob/master/LICENSE)
+[![vump](https://img.shields.io/static/v1.svg?label=versions&message=well-behaved&color=f39c12&style=flat-square&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz48IURPQ1RZUEUgc3ZnIFBVQkxJQyAiLS8vVzNDLy9EVEQgU1ZHIDEuMS8vRU4iICJodHRwOi8vd3d3LnczLm9yZy9HcmFwaGljcy9TVkcvMS4xL0RURC9zdmcxMS5kdGQiPjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiIHdpZHRoPSI4Ny42ODNweCIgaGVpZ2h0PSIxMDYuMTgzcHgiIHZpZXdCb3g9IjAgMCA4Ny42ODMgMTA2LjE4MyIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgODcuNjgzIDEwNi4xODMiIHhtbDpzcGFjZT0icHJlc2VydmUiPjxwYXRoIGZpbGw9IiNGRkZGRkYiIGQ9Ik04Ny4xNjcsNzEuNDIxYy0wLjk5Mi0zLjUzNS0zLjEwNy01LjgxOC02Ljg2My02LjM1Yy0zLjcyNy0wLjUyOS02LjYwNywwLjgyNC04LjMyOCw0LjEzN2MtMS4xNDUsMi4yMDEtMS45ODgsNC41Ny0yLjgzMiw2LjkxNGMtMS40ODQsNC4xMTktMy40MzksNy44OTMtNi42MDcsMTEuMDM3Yy0xMC45MzIsMTAuODQ2LTM0Ljk2MSwxMi4wMzctNDYuODA3LDIuMTdjLTEuNDUxLTEuMjA5LTMuMzQtMi4yMzYtMy41NzgtNC40MzljMC45OTItMC45MywxLjk3OS0wLjMwNSwyLjkyNi0wLjI3MWM5LjEzNywwLjMxMywxOC4zNDIsMS41NzIsMjcuMzQ4LTAuODI4YzcuOTA2LTIuMTA3LDEwLjAzMy05LjU4Niw0Ljg3MS0xNS45NTdjLTEuMzItMS42MjktMy40NjMtMi41NzYtNC4xMzUtNC44MjhjMS41ODItMS41MjksMy41MjktMC44NjksNS4yNjYtMS4xMDJjNy4zMTMtMC45NzMsMTMuNzUyLTMuNjU0LDE5LjAyMS05LjAxMmMxMi41NzgtMTIuNzg1LDEyLjAwOC0zOC4zNDMsNi4yMTUtNTAuNDRjLTEuMzItMi43NTMtMi44NTctMi44NDUtNS4wMTgtMS4xNDljLTMuMjkxLDIuNTgyLTYuNDE2LDUuMzYzLTguNzAxLDguODg1Yy0xLjU5LDIuNDUyLTMuNDcxLDMuMTM1LTYuMzI4LDIuNTgyYy02LjQyNi0xLjI0NS0xMi45NDEtMS4yNi0xOS4zNjUtMC4wMjNjLTMuMDMzLDAuNTgzLTUuMTA1LDAuMDI1LTYuNzI1LTIuNzAzYy0xLjg5MS0zLjE4NC00LjYxOS01LjY5Ny03LjQ4NC03Ljk4NmMtMy44ODctMy4xMDMtNS4yMTMtMi44NDItNi43NzksMS43OTdjLTQuNjk3LDEzLjkyMi00Ljg1MiwyNy43ODEsMS4zODksNDEuMzVjMS4wOSwyLjM2OSwyLjIyOSwzLjk4NC0wLjg3OSw2LjE2N0MtNS4yMTQsNjQuNzA0LTQuNDYsODYuNjUzLDE1LjM1OCw5OC42MmMxNC44MDMsOC45MzYsMzAuNjA0LDkuMzM2LDQ2Ljc0NCw0LjQxNGMxMC4xMDctMy4wODIsMTguMjgxLTguODIyLDIzLjAyOS0xOC41OUM4Ny4xMTgsODAuMzYsODguNDczLDc2LjA3Nyw4Ny4xNjcsNzEuNDIxeiBNNTguNDM2LDM2LjU4N2MyLjM0OCwwLDQuMjUsMS45MDMsNC4yNSw0LjI1cy0xLjkwMiw0LjI1LTQuMjUsNC4yNXMtNC4yNS0xLjkwMy00LjI1LTQuMjVTNTYuMDg4LDM2LjU4Nyw1OC40MzYsMzYuNTg3eiBNNDMuMzczLDQ3LjU4N2MyLjAxNiwwLDMuNjQ5LDAuMjczLDMuNjQ5LDEuMTY4YzAsMi4wMTUtMS42MzQsMy42NDktMy42NDksMy42NDlzLTMuNjQ5LTEuNjM0LTMuNjQ5LTMuNjQ5QzM5LjcyMyw0Ny44Niw0MS4zNTcsNDcuNTg3LDQzLjM3Myw0Ny41ODd6IE0yOS4zNzQsMzYuNTg3YzIuMzQ4LDAsNC4yNSwxLjkwMyw0LjI1LDQuMjVzLTEuOTAyLDQuMjUtNC4yNSw0LjI1cy00LjI1LTEuOTAzLTQuMjUtNC4yNVMyNy4wMjYsMzYuNTg3LDI5LjM3NCwzNi41ODd6Ii8+PC9zdmc+)](https://github.com/grissius/vump)
 
-CLI semantic verison bumper for every project. With a kitty inside.
+
+CLI semantic version bumper for every project. With a kitty inside.
+
+</div>
 
 ## Demo
 :construction: TODO
 
+## Motivation
+Do you like when projects use semantic versioning a keep a maintained changelog? I bet you do.
+Yet it is not rare that a patch version change breaks your app.
+Versions of a random maintained project are a mess.
+Most of the time, developers use version, because they are forced to, not because they want to.
+
+Here is why:
+
+1. Some people don't know or understand the benefits, for those there are projects like [semver](https://semver.org/), [keep-a-changelog](https://keepachangelog.com) etc.
+2. The others are lazy. It is hard. The routine is boring, menial and frustrating if you make a mistake, since you cannot usually republish with the same version tag. For those, I made [vump](https://github.com/grissius/vump).
+
+### Vump do I do?
+
+I try to understand you project. You decide which semver update best describes the unreleased changes and I will snoop your project, do all the file writes in the current directory and then stage them, commit and tag.
+
+If it sounds simple, it's because it is. You might argue that there are many CLI tools doing just the same (find them bellow), even more. That might be true. But very few have ambition to handle different platforms under one hood, and hang on fast to existing standards!
+
+### Features
+
+ - :package: Modular and generic approach
+ - :mortar_board: Opinionated, based on standards
+ - :ledger: Changelog management
+ - :cop: Synced, controlled version
+ - :heavy_check_mark: Solid test coverage
+ - :information_source: User documentation
+ - :speech_balloon: Helpful output
+ - :wrench: Handful of options
+
+
 ## Getting started
 
-```
+```bash
 gem install vump
 ```
 
 :gem: Don't like ruby? There are likely to be prebundled packages for Linux, Windows and Mac in the future.
 
+```bash
+cd my-project
+vump patch
+```
+
 ## Usage
 
 ```
-vump <major|minor|patch> [...options]
+vump [<major|minor|patch|<semver-string>>] [...options]
 ```
 
 | Option               | Example value | Explanation                                                         |
@@ -42,6 +79,57 @@ vump <major|minor|patch> [...options]
 | `--dry`    , `-d`    | -             | Dry run (no writes or CSV manipulation)                             |
 | `--path`   , `-p`    | `/foo/bar`    | Path to the repo (default pwd)                                      |
 
+### Examples
+
+- Bump minor version (`mi` is a prefix that cannot be confused with semver or other bumps)
+```ps
+vump mi
+```
+- Bump patch version of project in `~/Projects/foo`. Ommit all git operations.
+```ps
+vump patch -p=~/Projects/foo --no-git
+```
+- Set version of the projet on `1.1.1-beta-3` (use semver's [pre-release](https://semver.org/#spec-item-9))
+```ps
+vump 1.1.1 --pre=beta-3
+```
+
+
+## How to use for your project
+Vump finds which modules are relevant for your project, asks them for version and if all relevent modules align, it bumps each of them. There are some modules, you can use no matter the project:
+
+**Changelog** module manipulates with `CHANGELOG.md` file according to [keep-a-changelog](https://keepachangelog.com) standard. Using Vump you get changelog maintanance for free, all you need to do is to track your changes in _Unreleased_ section.
+
+**Version file** is probably the simplest module of all. It keeps just the version string followed by a newline in `VERSION` text file. You can use it along with other modules, or if you have no other place to keep your version.
+This module also comes handy, when your metadata are stored in a non-static file (meaning, it is interpreted via any runtime). This is the case for ruby for instance. Vump cannot parse interpret the complexity of ruby runtime. But you can read version from the `VERSION` file in your gemspec.
+
+- **JavaScript / Node.js**
+  - :rainbow: **npm** Native module for npm's `package.json` and `package-lock.json`
+  - :construction: **bower** - native module coming soon
+  - :construction: **component** - native module coming soon
+
+- **Ruby**
+  - :sunny: **rubygems** - Dynamic specification, you can [use](https://stackoverflow.com/a/23135266) `VERSION` file
+- **PHP**
+  - :construction: **composer** - native module coming soon
+- **Python**
+  - :sunny: **PyPI** - Dynamic specification, you can use `VERSION` file
+
+Are you missing something? Please let me know and I will gladly implement new module!
+
+## Related projects
+- [python-versioneer](https://github.com/warner/python-versioneer)
+- [version-bump-prompt](https://www.npmjs.com/package/version-bump-prompt)
+- [npm-bump](https://www.npmjs.com/package/npm-bump)
+- [bump](https://github.com/fabiospampinato/bump)
+- [php-bump-version](https://packagist.org/packages/quazardous/php-bump-version)
+- [perl-bump-version](https://metacpan.org/pod/release/DBOOK/App-RewriteVersion-0.003/script/perl-bump-version)
+- [dotnet-bump](https://github.com/killwort/dotnet-bump)
+- [release-it](https://www.npmjs.com/package/release-it)
+- [bumped](https://github.com/bumped/bumped)
+
+Are there any other good alternatives? Please let me know and I will update the list!
+
 ## License
 
 Licensed under [MIT](./LICENSE)

data/VERSION

@@ -1 +1 @@
-2.0.0-alpha.1
+2.0.0

data/lib/vump/cli/cli.rb

@@ -31,8 +31,10 @@ module Vump
         :major
       when /^mi.*/
         :minor
-      else
+      when /^p/
         :patch
+      else
+        args.first
       end
     end
 
@@ -49,6 +51,8 @@ module Vump
         verbose: false,
         version: false,
         tag_prefix: 'v',
+        build: nil,
+        pre: nil,
         path: Dir.pwd,
       }
       options.keys.each_with_object(defaults) do |k, acc|

data/lib/vump/cli/reporter.rb

@@ -38,8 +38,9 @@ module Vump
     # rubocop:disable Metrics/MethodLength
     # rubocop:disable Metrics/AbcSize
     # rubocop:disable Metrics/LineLength
+    # rubocop:disable Metrics/CyclomaticComplexity
     def help
-      puts 'vump'.bold.yellow + ' <major|minor|patch> [...options]'.yellow
+      puts 'vump'.bold.yellow + ' [<major|minor|patch|<semver-string>>] [...options]'.yellow
       header title: 'Available options:'
       table(border: false) do
         [
@@ -99,6 +100,8 @@ module Vump
           column('READ VERSION', width: 20)
         end
         @modules.each do |name, data|
+          next if !data[:relevant] && @level > ::Logger::DEBUG
+
           row do
             rel = data[:relevant]
             column(name)
@@ -112,5 +115,6 @@ module Vump
     # rubocop:enable Metrics/AbcSize
     # rubocop:enable Metrics/MethodLength
     # rubocop:enable Metrics/LineLength
+    # rubocop:enable Metrics/CyclomaticComplexity
   end
 end

data/lib/vump/git/git.rb

@@ -26,7 +26,7 @@ module Vump
       result = @options[:dry] ? 'Dry run success' : @git.commit(message)
       if @logger
         if result != ''
-          @logger.info("Created commit #{message}")
+          @logger.info("Created commit #{message.yellow}")
         else
           @logger.error('Could not commit files. Perhaps the hook failed.')
         end
@@ -36,7 +36,7 @@ module Vump
 
     def tag(version_tag)
       @git.add_tag(version_tag) unless @options[:dry]
-      @logger.info("Created tag #{version_tag}") if @logger
+      @logger.info("Created tag #{version_tag.yellow}") if @logger
     end
   end
 end

data/lib/vump/logger/logger.rb

@@ -8,6 +8,7 @@ module Vump
 
     def initialize(options = {})
       @logger = ::Logger.new(options[:out] || STDOUT)
+      @logger.level = ::Logger::INFO
       @logger.level = ::Logger::DEBUG if options[:verbose]
       @logger.level = ::Logger::UNKNOWN if options[:silent]
       @logger.formatter = proc do |_severity, _datetime, progname, msg|
@@ -28,7 +29,7 @@ module Vump
     end
 
     def error(message, module_name = nil)
-      @logger.add(::Logger::ERROR, message, module_name)
+      @logger.add(::Logger::ERROR, message.red, module_name)
     end
   end
 end

data/lib/vump/modules/package_json.rb

@@ -1,4 +1,5 @@
 require 'vump/modules/base_file_module'
+require 'json'
 
 module Vump
   class PackageJson < BaseFileModule
@@ -11,14 +12,14 @@ module Vump
     end
 
     def select(contents)
-      @parsed = JSON.parse(contents)
+      @parsed = ::JSON.parse(contents)
       @parsed['version']
     end
 
     def compose(_contents, version)
       json = @parsed.clone
       json['version'] = version
-      JSON.pretty_generate(json) + "\n"
+      ::JSON.pretty_generate(json) + "\n"
     end
   end
 end

data/lib/vump/semver/semver.rb

@@ -9,19 +9,23 @@ module Vump
     end
 
     def load(string)
-      # <numeral>[-<sufix>]
-      version, sufix = string
-        .match(/([\d\.]+)(?:\-)?(.*)?/)
-        .captures
-      # <sufix>:= [<pre>][+<build>]
-      @pre, @build = sufix.split('+', 2).map { |s| s.empty? ? false : s }
+      # <numeral>[-<pre>][+<build>]
+      version, @pre, @build = string
+        .match(/([\d\.]+)(?:\-)?([^\+]*)(?:\+)?(.*)?/)
+        .to_a
+        .drop(1)
       # <numeral>:= <major>.<minor>.<patch>
       @major, @minor, @patch = version
         .match(/(\d+)\.(\d+)\.(\d+)/)
-        .captures
+        .to_a
+        .drop(1)
         .map(&:to_i)
     end
 
+    def valid?
+      [@major, @minor, @patch].all? { |v| v.is_a?(Numeric) }
+    end
+
     def reset(what)
       levels = %i[@build @pre @patch @minor @major]
       # tag to false, version to 0
@@ -59,8 +63,8 @@ module Vump
 
     def to_s
       str = "#{@major}.#{@minor}.#{@patch}"
-      str << "-#{@pre}" if @pre
-      str << "+#{@build}" if @build
+      str << "-#{@pre}" if @pre && @pre != ''
+      str << "+#{@build}" if @build && @build != ''
       str
     end
   end

data/lib/vump/vump.rb

@@ -50,11 +50,11 @@ module Vump
     def select_version(versions)
       @reporter.report_module_overview
       if versions.uniq.length > 1
-        @logger.warn("Inconsitent version records: #{versions}")
+        @logger.error("Inconsitent version records: #{versions}")
         return false
       end
       @logger.info(
-        "Single version extracted from all modules: #{versions.first}"
+        "Version extracted #{versions.first.yellow}"
       )
       versions.first
     end
@@ -64,7 +64,7 @@ module Vump
         mod.write(version)
         @logger.debug("Writing new version \"#{version}\"", mod.class)
       end
-      @logger.info("All relevant modules written \"#{version}\"")
+      @logger.info("Relevant modules have written #{version.yellow}")
 
       if @git.loaded?
         commit(modules, version) unless @options[:no_git]
@@ -76,17 +76,30 @@ module Vump
     def commit(modules, version)
       files_to_stage = modules.map(&:to_stage).flatten
       @git.stage(files_to_stage)
-      @git.tag(version) if @git.commit(version)
+      @git.tag("#{@options[:tag_prefix]}#{version}") if @git.commit(version)
     end
 
-    def bump(arg = false, pre = false, build = false)
+    def compose_version(latest, arg, pre, build)
+      semver = Semver.new(latest)
+      semver.bump(arg) if arg
+      # if arg is string, overwrite
+      semver = Semver.new(arg) if arg.is_a?(String)
+      semver.pre = pre
+      semver.build = build
+      semver
+    end
+
+    def bump(arg = nil, pre = nil, build = nil)
       modules = load_modules
       version = select_version(read_versions(modules))
-      semver = Semver.new(version)
-      semver.bump(arg) if arg
-      semver.pre = pre if pre
-      semver.build = build if build
-      write_versions(modules, semver.to_s)
+      return unless version
+
+      semver = compose_version(version, arg, pre, build)
+      if semver.valid?
+        write_versions(modules, semver.to_s)
+      else
+        @logger.error("Provided version #{arg} is not a valid semver string")
+      end
     end
 
     def help

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vump
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.alpha.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Jaroslav Šmolík
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-28 00:00:00.000000000 Z
+date: 2019-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: command_line_reporter
@@ -205,11 +205,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Raise version version in root of semver project.