vump 1.2.0 → 2.0.0.pre.alpha.1

data/README.adoc

@@ -1,87 +0,0 @@
-= vump: Semantic version bumper
-Jaroslav Šmolík <grissius@gmail.com>
-:semver: https://semver.org/[semver]
-:git: https://git-scm.com/[git]
-:rubychangelog: https://rubygems.org/gems/keepachangelog[keepachangelog]
-
-image:https://travis-ci.org/grissius/vump.svg["Build Status", link="https://travis-ci.org/grissius/vump"]
-image:https://img.shields.io/gem/v/vump.svg?style=flat[Gem Version, link="https://rubygems.org/gems/vump"]
-image:https://img.shields.io/badge/yard-docs-blue.svg[Yard Docs, link="http://www.rubydoc.info/github/grissius/vump"]
-
-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.
-
-== Install
-```
-gem install vump
-```
-=== Requirements
-
-* ruby >= 2.2
-
-
-== 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
-
-== Current modules
-
-[WARNING]
-====
-Non-trivial modules do not operate on text, but parsed objects, which might result in ugly diffs after first usage.
-
-If you encounter any fishy :fish: behaviour due to this let me know!
-====
-
-VERSION::
-Find and bump version in `./VERSION` file.
-+
-* Expect just verison with whitepsaces around
-* Write version followed by a newline.
-
-Npm::
-Find and bump version in `./package.json` file.
-+
-* Parse JSON, modify as object.
-* Serialize back to JSON, append newline.
-NpmLock::
-Find and bump version in `./package-lock.json` file
-+
-* Same as Npm.
-Keepachangelog::
-Find and bump version in `./CHANGELOG.md` file.
-+
-* Parse changelog by {rubychangelog}.
-* Add changes from `Unreleased` version to new release with current date.
-* Add empty `Unreleased` version.
-* Serialize back into markdown.

data/lib/cli.rb

@@ -1,74 +0,0 @@
-require_relative 'vump/version'
-require_relative 'vump/meta'
-require_relative 'vump'
-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!
-      setup(options)
-      [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
-
-    def self.log_meta(options)
-      if options[:version]
-        Vump.logger.info "vump #{Vump::VERSION}"
-      elsif options[:help]
-        Vump.logger.info Vump::SUMMARY
-      end
-    end
-
-    # Main CLI command
-    def self.start(argv)
-      options, args = parse_argv(argv)
-      if options[:version] || options[:help]
-        log_meta(options)
-        exit true
-      elsif valid_args(args)
-        exit Vump.orchestrate(args)
-      else
-        Vump.logger.info 'vump <major|minor|patch>'
-        exit false
-      end
-    end
-  end
-end

data/lib/vump.rb

@@ -1,69 +0,0 @@
-require_relative 'vump/semver/semver'
-Dir[File.expand_path('vump/semver/version_modules/file_modules/*.rb', __dir__)]
-  .each { |file| require file }
-Dir[File.expand_path('vump/semver/version_modules/vcs_modules/*.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)
-    mods_vers = Vump::VersionModules::FileModules
-                .constants
-                .map { |m| Vump::VersionModules::FileModules.const_get(m) }
-                .select { |m| m.is_a? Class }
-                .map { |m| m.new(base) }
-                .map { |m| [m, m.read] }
-                .select { |_m, v| v }
-    # "unzip"
-    mods_vers.empty? ? [[], []] : mods_vers.transpose
-  end
-
-  # Format CLI output
-  #
-  # @param [Array[String]] args CLI args
-  # @return [bool] true if successful
-  def self.orchestrate(args)
-    v_modules, current_versions = modules
-    if current_versions.uniq.length > 1
-      Vump.logger.error 'Different versions detected. Quitting.'
-      return false
-    else
-      new_version = bump(args.first, Vump::Semver.new(current_versions.first))
-      v_modules.each { |m| m.write(new_version.to_s) }
-      Vump::VersionModules::VcsModules::Git.revise(v_modules, new_version)
-      return true
-    end
-  end
-
-  # Module containing all worker modules to be executed on bump
-  module VersionModules
-    # All file read/write modules to be exectued
-    module FileModules
-    end
-    # All VCS modules to be exectued
-    module VcsModules
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-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/version_modules/file_modules/keepachangelog.rb

@@ -1,50 +0,0 @@
-require 'json'
-require 'date'
-require 'keepachangelog'
-require_relative '../read_write_version_module'
-require_relative '../../monkey/keepachangelog'
-
-module Vump
-  module VersionModules
-    module FileModules
-      # [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-      class KeepAChangeLog < Vump::VersionModules::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
-end

data/lib/vump/semver/version_modules/file_modules/npm.rb

@@ -1,29 +0,0 @@
-require 'json'
-require_relative '../read_write_version_module'
-
-module Vump
-  module VersionModules
-    module FileModules
-      # Npm version module for package.json
-      class Npm < Vump::VersionModules::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
-end

data/lib/vump/semver/version_modules/file_modules/npm_lock.rb

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

data/lib/vump/semver/version_modules/file_modules/version_file.rb

@@ -1,26 +0,0 @@
-require_relative '../read_write_version_module'
-
-module Vump
-  module VersionModules
-    module FileModules
-      # Module for VERSION file
-      class VersionFile < Vump::VersionModules::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
-end

data/lib/vump/semver/version_modules/read_write_version_module.rb

@@ -1,45 +0,0 @@
-module Vump
-  module VersionModules
-    # 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
-end

data/lib/vump/semver/version_modules/vcs_modules/git.rb

@@ -1,19 +0,0 @@
-module Vump
-  module VersionModules
-    module VcsModules
-      # Git VCS module
-      class Git
-        def self.revise(modules, release_version)
-          return unless File.exist?(Dir.pwd + '/.git')
-          modules.each { |m| `git add #{m.path}` }
-          msg = "Release #{release_version}"
-          tag = "v#{release_version}"
-          `git commit -m "#{msg}"` unless modules.empty?
-          Vump.logger.info "Git commit \"#{msg}\" created"
-          `git tag "#{tag}"`
-          Vump.logger.info "Git tag \"#{tag}\" created"
-        end
-      end
-    end
-  end
-end