vump 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aec555f8504102bf24f667af29270bd3bbddda7e
+  data.tar.gz: eb683df338dd18f371f592927ec89bf61e16550b
+SHA512:
+  metadata.gz: 25671712156e0c878b307250f177112fec08583d4114762d399d1f9c22f64e9f5d0eda4a2f8f1b842760ed1cfa5a1f96791fd515513cde42617090a06dff977a
+  data.tar.gz: f9502e799488ae0d16d15a0fe13afaa425fdb6de8829ae8574d8f9f8db433acb688a334fc241b82be2aa85860d65ed7acaa879bd565ade11b0d0555dbadfbb16

data/README.adoc

@@ -0,0 +1,41 @@
+= vump: Semantic version bumper
+Jaroslav Šmolík <grissius@gmail.com>
+:semver: https://semver.org/[semver]
+:git: https://git-scm.com/[git]
+
+CLI tool to easily manage projects using {semver} and automate menial version raising.
+
+== Introduction
+
+When working on a project with version management, increasing a version is a mundane, boring task. It might consist of as much as following steps:
+
+* modify `VERSION` file
+* modify package file version
+* update changelog (e.g. if using keepachangelog move unreleased to this version, start new unreleased, update footnote)
+* create a commit
+* tag a commit
+* double check previous steps, because you might have forgotten any of them
+
+Which is exhausting. If following any standards at all, like {semver}, keepachagnelog etc, it does not require any human input, but to decide which version to increase.
+
+== Usage
+In root of project directory, choose which version (from {semver}) to bump, and supply it as a sole argument.
+```
+vump <major|minor|patch>
+```
+
+TIP: You can use any discriminative prefixes such as `maj`, `min`, or even `ma`, `mi` and `p`.
+
+=== What it does
+The program loads all modules, each being responsible for a single file it understands.
+Each module checks if the file exists and if so, it will read the last version.
+The versions across modules must match and are bumped as desired and written back into files.
+
+After all file modules are done, {git} module adds all modified files and creates a tagged commit, if {git} is used in the project.
+
+WARNING: As the interface implies, your project must follow the {semver} specifiaction.
+
+=== Options
+`vump --version`:: Print program version
+`vump --verbose patch`, `vump -v patch`:: Print debug logs
+`vump --silent patch`, `vump -s patch`:: Print only warning and error logs

data/bin/vump

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/cli'
+
+Vump::CLI.start(ARGV)

data/lib/cli.rb

@@ -0,0 +1,65 @@
+require File.expand_path('vump/version', __dir__)
+require File.expand_path('vump/meta', __dir__)
+require File.expand_path('vump', __dir__)
+require 'optparse'
+
+# Root module for package Vump
+module Vump
+  # CLI module for package Vump
+  module CLI
+    # Parse CLI arguemnts
+    #
+    # @param [Array[String]] _ arguments (not used now)
+    #   OptionParser parses ARGV
+    # @return [Array[String], Array[String]] options and args
+    def self.parse_argv(_)
+      options = {}
+      args = OptionParser.new do |opt|
+        opt.on('-h', '--help') { options[:help] = true }
+        opt.on('--version') { options[:version] = true }
+        opt.on('-v', '--verbose') { options[:verbose] = true }
+        opt.on('-s', '--silent') { options[:silent] = true }
+      end.parse!
+      [options, args]
+    end
+
+    # Tets if CLI arguments are valid.
+    #
+    # @param [Array[String]] args CLI args
+    # @return true if all valid
+    def self.valid_args(args)
+      if args.length != 1
+        Vump.logger.error "Wrong number of args. Got #{args.length}, expected 1"
+        false
+      elsif !/^(ma|mi|p)/i.match(args.first)
+        Vump.logger.error 'Unknown version to bump. <major|minor|patch>'
+        false
+      else
+        true
+      end
+    end
+
+    def self.setup(options)
+      Vump.logger.level = Logger::INFO
+      if options[:verbose]
+        Vump.logger.level = Logger::DEBUG
+      elsif options[:silent]
+        Vump.logger.level = Logger::UNKNOWN
+      end
+    end
+
+    # Main CLI command
+    def self.start(argv)
+      options, args = parse_argv(argv)
+      if options[:version]
+        puts "vump #{Vump::VERSION}"
+      elsif valid_args(args)
+        Vump.orchestrate(args)
+      else
+        puts 'Error: invalid version part to bump.' unless args.empty?
+        puts Vump::SUMMARY if options[:help]
+        puts 'vump <major|minor|patch>'
+      end
+    end
+  end
+end

data/lib/vump/meta.rb

@@ -0,0 +1,4 @@
+module Vump
+  # Brief summary of the package
+  SUMMARY = 'Raise version version in root of semver project.'.freeze
+end

data/lib/vump/semver/module/keepachangelog.rb

@@ -0,0 +1,48 @@
+require 'json'
+require 'date'
+require 'keepachangelog'
+require_relative '../read_write_version_module'
+require_relative '../monkey/keepachangelog'
+
+module Vump
+  module VersionModule
+    # [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+    class KeepAChangeLog < ReadWriteVersionModule
+      def self.name
+        'CHANGELOG.md'
+      end
+
+      def path
+        @base + '/CHANGELOG.md'
+      end
+
+      def scrape(str)
+        Keepachangelog::MarkdownParser
+          .parse(str)['versions']
+          .keys
+          .reject { |v| v == 'Unreleased' }
+          .first
+      end
+
+      def compose(new_version)
+        content = Keepachangelog::MarkdownParser.parse(@read_contents)
+        content = release_changelog(content, new_version)
+        parser = Keepachangelog::Parser.new
+        parser.parsed_content = content
+        parser.to_md + "\n"
+      end
+
+      def release_changelog(changelog, new_version)
+        versions = changelog['versions']
+        # inherit all from unreleased
+        versions[new_version] = versions['Unreleased']
+                                .clone
+        # update date
+        versions[new_version]['date'] = Date.today.to_s
+        # reset unreleased
+        versions['Unreleased']['changes'] = {}
+        changelog
+      end
+    end
+  end
+end

data/lib/vump/semver/module/npm.rb

@@ -0,0 +1,27 @@
+require 'json'
+require_relative '../read_write_version_module'
+
+module Vump
+  module VersionModule
+    # Npm version module for package.json
+    class Npm < ReadWriteVersionModule
+      def self.name
+        'package.json'
+      end
+
+      def path
+        @base + '/package.json'
+      end
+
+      def scrape(str)
+        JSON.parse(str)['version']
+      end
+
+      def compose(new_version)
+        json = JSON.parse(@read_contents)
+        json['version'] = new_version
+        JSON.pretty_generate(json) + "\n"
+      end
+    end
+  end
+end

data/lib/vump/semver/module/npm_lock.rb

@@ -0,0 +1,13 @@
+require 'json'
+require_relative 'npm'
+
+module Vump
+  module VersionModule
+    # Npm version module for package.json
+    class NpmLock < Npm
+      def path
+        @base + '/package-lock.json'
+      end
+    end
+  end
+end

data/lib/vump/semver/module/version_file.rb

@@ -0,0 +1,24 @@
+require_relative '../read_write_version_module'
+
+module Vump
+  module VersionModule
+    # Module for VERSION file
+    class VersionFile < ReadWriteVersionModule
+      def self.name
+        'VERSION'
+      end
+
+      def path
+        @base + '/VERSION'
+      end
+
+      def scrape(str)
+        str.strip
+      end
+
+      def compose(new_version)
+        new_version + "\n"
+      end
+    end
+  end
+end

data/lib/vump/semver/monkey/keepachangelog.rb

@@ -0,0 +1,23 @@
+require 'keepachangelog'
+
+# Monkey library patch
+module Keepachangelog
+  # Monkey library patch
+  class MarkdownPrinter
+    # Add tag prefix
+    def anchor(v, i)
+      from_v = i == v.length - 1 ? first_commit : 'v' + v[i + 1]
+      to_v = Gem::Version.correct?(v[i]) ? 'v' + v[i] : 'HEAD'
+      "[#{v[i]}]: #{options[:url]}/compare/#{from_v}...#{to_v}"
+    end
+
+    # Add newline after empty section
+    def version(header, content)
+      chnages = content['changes']
+      [
+        version_header(header, content['date']),
+        chnages.empty? ? '' : chnages.map { |k, v| section(k, v) }
+      ]
+    end
+  end
+end

data/lib/vump/semver/read_write_version_module.rb

@@ -0,0 +1,43 @@
+module Vump
+  # Read write version module archetype
+  class ReadWriteVersionModule
+    def initialize(base)
+      @base = base
+    end
+
+    def read
+      name = self.class.name
+      if File.file?(path)
+        @read_contents = File.read(path)
+        ver = scrape(@read_contents)
+        Vump.logger.debug("#{name} read `#{ver}` from `#{path}`")
+      else
+        Vump.logger.debug("#{name} could not find `#{path}`")
+      end
+      ver
+    end
+
+    def write(new_version)
+      name = self.class.name
+      File.write(path, compose(new_version))
+      Vump.logger.debug("#{name} bumped to `#{new_version}` in `#{path}`")
+      Vump.logger.info("#{name} successfully bumped!")
+    end
+
+    def self.name
+      raise NotImplementedError
+    end
+
+    def path
+      raise NotImplementedError
+    end
+
+    def scrape(_str)
+      raise NotImplementedError
+    end
+
+    def compose(_new_version)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/vump/semver/semver.rb

@@ -0,0 +1,55 @@
+module Vump
+  # Representation of version notation according to https://semver.org/
+  class Semver
+    def initialize(string = nil)
+      @pre = @build = false
+      @major = @minor = @patch = 0
+      load string if string
+    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>:= <major>.<minor>.<patch>
+      @major, @minor, @patch = version
+                               .match(/(\d+)\.(\d+)\.(\d+)/)
+                               .captures
+                               .map(&:to_i)
+    end
+
+    def reset(what)
+      levels = %i[@build @pre @patch @minor @major]
+      # tag to false, version to 0
+      reset_to = %i[@build @pre].include?(what) ? false : 0
+      instance_variable_set(what, reset_to)
+      # reset lesser sections
+      reset levels[levels.index(what) - 1] if levels.index(what) != 0
+    end
+
+    def bump_patch
+      reset :@pre
+      @patch += 1
+    end
+
+    def bump_minor
+      reset :@patch
+      @minor += 1
+    end
+
+    def bump_major
+      reset :@minor
+      @major += 1
+    end
+
+    def to_s
+      str = "#{@major}.#{@minor}.#{@patch}"
+      str << "-#{@pre}" if @pre
+      str << "+#{@build}" if @build
+      str
+    end
+  end
+end

data/lib/vump/version.rb

@@ -0,0 +1,4 @@
+module Vump
+  # Package version
+  VERSION = File.read(File.expand_path('../../VERSION', __dir__)).strip.freeze
+end

data/lib/vump.rb

@@ -0,0 +1,66 @@
+require File.expand_path('vump/semver/semver', __dir__)
+Dir[File.expand_path('vump/semver/module/*.rb', __dir__)]
+  .each { |file| require file }
+require 'logger'
+
+# Root package module
+module Vump
+  @@logger = Logger.new(STDOUT)
+  @@logger.formatter = proc do |severity, _datetime, _progname, msg|
+    "#{severity}: #{msg}\n"
+  end
+
+  def self.logger
+    @@logger
+  end
+
+  def self.bump(what, version)
+    case what
+    when /^ma/i
+      version.bump_major
+    when /^mi/i
+      version.bump_minor
+    when /^p/i
+      version.bump_patch
+    end
+    version
+  end
+
+  def self.modules(base = Dir.pwd)
+    modules_versions = Vump::VersionModule
+                       .constants
+                       .map { |m| Vump::VersionModule.const_get(m) }
+                       .select { |m| m.is_a? Class }
+                       .map { |m| m.new(base) }
+                       .map { |m| [m, m.read] }
+                       .select { |_m, v| v }
+    # "unzip"
+    modules_versions.empty? ? [[], []] : modules_versions.transpose
+  end
+
+  # Format CLI output
+  #
+  # @param [Array[String]] args CLI args
+  # @return [String] output
+  def self.orchestrate(args)
+    v_modules, current_versions = modules
+    if current_versions.uniq.length > 1
+      Vump.logger.error 'Different versions detected. Quitting.'
+    else
+      new_version = bump(args.first, Vump::Semver.new(current_versions.first))
+      v_modules.each { |m| m.write(new_version.to_s) }
+      git(v_modules, new_version)
+    end
+  end
+
+  def self.git(modules, release_version)
+    return unless File.exist?(Dir.pwd + '/.git')
+    modules.each { |m| `git add #{m.path}` }
+    `git commit -m "Release #{release_version}"` unless modules.empty?
+    `git tag "v#{release_version}"`
+  end
+
+  # Module containing all worker modules to be executed on bump
+  module VersionModule
+  end
+end

data/vump.gemspec

@@ -0,0 +1,28 @@
+require File.expand_path('lib/vump/version', __dir__)
+require File.expand_path('lib/vump/meta', __dir__)
+
+Gem::Specification.new do |s|
+  s.name        = 'vump'
+  s.version     = Vump::VERSION
+  s.homepage    = 'https://github.com/grissius/vump'
+  s.license     = 'MIT'
+  s.author      = 'Jaroslav Šmolík'
+  s.email       = 'grissius@gmail.com'
+
+  s.summary     = Vump::SUMMARY
+  s.description = <<-DESCRIPTION
+  Semantic version bumper. CLI tool to easily manage projects using semver and automate menial version raising.
+DESCRIPTION
+
+  s.files       = Dir['bin/*', 'lib/**/*', '*.gemspec', 'LICENSE*', 'README*']
+  s.executables = Dir['bin/*'].map { |f| File.basename(f) }
+  s.has_rdoc    = 'yard'
+
+  s.required_ruby_version = '>= 2.2'
+
+  s.add_runtime_dependency 'keepachangelog', '~> 0.5.3'
+
+  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'rspec', '~> 3.6'
+  s.add_development_dependency 'yard', '~> 0.9'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: vump
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jaroslav Šmolík
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: keepachangelog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: "  Semantic version bumper. CLI tool to easily manage projects using
+  semver and automate menial version raising.\n"
+email: grissius@gmail.com
+executables:
+- vump
+extensions: []
+extra_rdoc_files: []
+files:
+- README.adoc
+- bin/vump
+- lib/cli.rb
+- lib/vump.rb
+- lib/vump/meta.rb
+- lib/vump/semver/module/keepachangelog.rb
+- lib/vump/semver/module/npm.rb
+- lib/vump/semver/module/npm_lock.rb
+- lib/vump/semver/module/version_file.rb
+- lib/vump/semver/monkey/keepachangelog.rb
+- lib/vump/semver/read_write_version_module.rb
+- lib/vump/semver/semver.rb
+- lib/vump/version.rb
+- vump.gemspec
+homepage: https://github.com/grissius/vump
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Raise version version in root of semver project.
+test_files: []