vump 1.2.0 → 2.0.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3d543e02895efb7d90e6290285d2dac81231fa64
-  data.tar.gz: 8b74fc23c676f4fb68420500ec3c316889cd7381
+SHA256:
+  metadata.gz: ec1748a44dde478e47b682e58b26b93acd5576b1943b190f6d51273503bdb41b
+  data.tar.gz: 15ca18dc809e13ccd90e93fa213b2428931a2005353bbf8c40b608993ac8183c
 SHA512:
-  metadata.gz: 833188c62cabdb019ca07567876f6973f4041dd9bb40b90041ae4b82d729fbd9d09243f454e9976f244b670fa208aaa96710cffded9e1cfcf935a1f837b359ce
-  data.tar.gz: 7937abf084f9a310de1714bf636c20b58a712bc1ddb8018f8b3f8eb1875f1a807a4e11e7437b72e617f9d7f148765d893e8f714e00bbe3582a1653036d95889a
+  metadata.gz: e8318b5ea233fed11cf79c570ef1748f5fc98a6393065246f6dbfd29dbe28cb87e83bd35de3b6bc21426e71b2472c96cc00e0fd4fa327b7f44bd1d01efd82236
+  data.tar.gz: 92bbad25ecf6116304382d3097b98191dc841914593b8a8ad85f950466735343ff081d73b063d6586e4e1a7b110963e036393af77f3e7e97c347e4b3974d0fec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jaroslav Šmolík
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+<p align="center">
+  <img src="https://i.imgur.com/ZH8ftR9.png" height="170">
+</p>
+
+# Vump
+
+[![Build Status](https://img.shields.io/travis/grissius/vump/master.svg?style=flat-square)](https://travis-ci.org/grissius/vump)
+[![Coverage Status](https://img.shields.io/coveralls/github/grissius/vump.svg?style=flat-square)](https://coveralls.io/github/grissius/vump?branch=master)
+[![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)
+
+CLI semantic verison bumper for every project. With a kitty inside.
+
+## Demo
+:construction: TODO
+
+## Getting started
+
+```
+gem install vump
+```
+
+:gem: Don't like ruby? There are likely to be prebundled packages for Linux, Windows and Mac in the future.
+
+## Usage
+
+```
+vump <major|minor|patch> [...options]
+```
+
+| Option               | Example value | Explanation                                                         |
+|----------------------|---------------|---------------------------------------------------------------------|
+| `--silent` , `-s`    | -             | Restrict output                                                     |
+| `--version`, `-v`    | -             | Output Vump's version                                               |
+| `--help`   , `-h`    | -             | Print this help                                                     |
+| `--no-git` ,         | -             | Skip staging, commit and tag                                        |
+| `--tag-prefix`, `-t` | `@foo/v`      | Modify version string prefix for git tag (default "v")              |
+| `--build`  , `-b`    | `001`         | Set semver's build tag (default none)                               |
+| `--pre`              | `alpha.1`     | Set semver's pre release tag (default none)                         |
+| `--date`   ,         | `2020-12-20`  | Modify date of committing release. Used by changelog. (default now) |
+| `--dry`    , `-d`    | -             | Dry run (no writes or CSV manipulation)                             |
+| `--path`   , `-p`    | `/foo/bar`    | Path to the repo (default pwd)                                      |
+
+## License
+
+Licensed under [MIT](./LICENSE)

data/VERSION

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

data/bin/vump

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-
-require_relative '../lib/cli'
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'vump/cli/cli'
 
 Vump::CLI.start(ARGV)

data/lib/vump/cli/cli.rb

@@ -0,0 +1,100 @@
+require 'vump/vump'
+require 'vump/meta'
+require 'time'
+
+module Vump
+  module CLI
+    def self.parse_args(inputs) # rubocop:disable Metrics/MethodLength
+      options = {}
+      args = []
+      inputs.each do |input|
+        case input
+        when /--(?<key>.*?)=(?<value>.*)/
+          options[Regexp.last_match(1).to_sym] = Regexp.last_match(2)
+        when /--?(.*)/
+          options[Regexp.last_match(1).to_sym] = true
+        else
+          args << input
+        end
+      end
+      [args, options]
+    end
+
+    def self.parse_inputs(inputs)
+      args, options = parse_args(inputs)
+      [parse_arg(args), parse_options(options)]
+    end
+
+    def self.parse_arg(args)
+      case args.first
+      when /^ma.*/
+        :major
+      when /^mi.*/
+        :minor
+      else
+        :patch
+      end
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/BlockLength
+    def self.parse_options(options)
+      defaults = {
+        date: Time.now,
+        dry: false,
+        no_git: false,
+        silent: false,
+        verbose: false,
+        version: false,
+        tag_prefix: 'v',
+        path: Dir.pwd,
+      }
+      options.keys.each_with_object(defaults) do |k, acc|
+        case k
+        when :s, :silent
+          acc[:silent] = options[k]
+        when :verbose
+          acc[:verbose] = options[k]
+        when :d, :dry
+          acc[:dry] = options[k]
+        when :'no-git', :no_git
+          acc[:no_git] = options[k]
+        when :v, :version
+          acc[:version] = options[k]
+        when :h, :help
+          acc[:help] = options[k]
+        when :t, :tag_prefix, :'tag-prefix'
+          acc[:tag_prefix] = options[k]
+        when :b, :build
+          acc[:build] = options[k]
+        when :pre
+          acc[:pre] = options[k]
+        when :date
+          acc[:date] = Time.parse(options[k]) rescue defaults[:date]
+        when :p, :path
+          acc[:path] = options[k]
+        else
+          acc[k] = options[k]
+        end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/BlockLength
+
+    def self.start(inputs)
+      arg, opts = parse_inputs(inputs)
+      return puts ::Vump::Meta.version if opts[:version]
+
+      vump = ::Vump::Vump.new(opts[:path], arg, opts)
+      if opts[:help]
+        vump.help
+      else
+        vump.bump(arg, opts[:pre], opts[:build])
+      end
+    end
+  end
+end

data/lib/vump/cli/reporter.rb

@@ -0,0 +1,116 @@
+require 'command_line_reporter'
+require 'logger'
+require 'vump/meta'
+
+FRAGMENTS1 = <<'_'.freeze
+
+                                                          |\__/,|   (`\
+                                      Vump              _.|o o  |_   ) )
+_
+# rubocop:disable Layout/IndentHeredoc
+FRAGMENTS2 = <<'_'.freeze
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━(((━━━(((━━━━━━━━━━━━━━━━
+_
+# rubocop:enable Layout/IndentHeredoc
+module Vump
+  class Reporter
+    include CommandLineReporter
+
+    def initialize(options)
+      @modules = {}
+      @level = ::Logger::INFO
+      @level = ::Logger::DEBUG if options[:verbose]
+      @level = ::Logger::UNKNOWN if options[:silent]
+    end
+
+    def add_loaded_modules(mods)
+      mods.map(&:name).each { |m| @modules[m] = { loaded: true } }
+    end
+
+    def add_relevant_modules(mods)
+      mods.map(&:name).each { |m| @modules[m][:relevant] = true }
+    end
+
+    def add_read_version(mod, version)
+      @modules[mod.name][:read_version] = version
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/LineLength
+    def help
+      puts 'vump'.bold.yellow + ' <major|minor|patch> [...options]'.yellow
+      header title: 'Available options:'
+      table(border: false) do
+        [
+          ['-s, --silent', '', 'Restrict output'],
+          ['-v, --version', '', 'Output Vump\'s version'],
+          ['-h, --help', '', 'Print this help'],
+          ['--no-git', '', 'Skip staging, commit and tag'],
+          ['-t, --tag-prefix', '=@foo/v', 'Modify version string prefix for git tag (default "v")'],
+          ['-b, --build', '=001', 'Set semver\'s build tag (default none)'],
+          ['--pre', '=alpha1', 'Set semver\'s pre release tag (default none)'],
+          ['--date', '=2020-12-20', 'Modify date of committing release. Used by changelog. (default now)'],
+          ['-d, --dry', '', 'Dry run (no writes or CSV manipulation)'],
+          ['-p, --path', '=/foo/bar', 'Path to the repo (default pwd)'],
+        ].each do |option, arg, descr|
+          row do
+            column(option, width: 18, color: 'yellow')
+            column(arg, width: 12, color: 'cyan')
+            column(descr, width: 40)
+          end
+        end
+      end
+    end
+
+    def report_preamble(base_path, arg, options)
+      return if @level > ::Logger::INFO
+
+      puts FRAGMENTS1.chomp.bold.yellow + ' ' + Meta.version.yellow
+      puts FRAGMENTS2.chomp.bold.yellow
+      puts "#{' ' * 27} Semantic version bumper\n".yellow
+
+      return if @level > ::Logger::DEBUG
+
+      table(border: false) do
+        row do
+          column('Base path', width: 10)
+          column(base_path, width: 70)
+        end
+        row do
+          column('Argument')
+          column(arg)
+        end
+        row do
+          column('Options')
+          column(options)
+        end
+      end
+    end
+
+    def report_module_overview
+      return if @level > ::Logger::INFO
+
+      header title: 'Version module overview', align: 'center', width: 80
+      table(border: true) do
+        row do
+          column('NAME', width: 20)
+          column('STATUS', width: 30)
+          column('READ VERSION', width: 20)
+        end
+        @modules.each do |name, data|
+          row do
+            rel = data[:relevant]
+            column(name)
+            column(rel ? 'relevant' : 'loaded', color: rel ? 'green' : nil)
+            column(data[:read_version], color: rel ? 'green' : nil)
+          end
+        end
+      end
+    end
+
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/LineLength
+  end
+end

data/lib/vump/git/git.rb

@@ -0,0 +1,42 @@
+require 'git'
+require 'logger'
+
+module Vump
+  class Git
+    def initialize(base, options = {})
+      @git = ::Git.open(base)
+      @logger = options[:logger]
+      @options = options
+    rescue ArgumentError
+      @git = nil
+    end
+
+    def loaded?
+      !@git.nil?
+    end
+
+    def stage(files)
+      @logger.debug("Staging files: #{files}") if @logger
+      @git.add(files) unless @options[:dry]
+      @logger.debug('Files staged') if @logger
+    end
+
+    def commit(version)
+      message = "Release version #{version}"
+      result = @options[:dry] ? 'Dry run success' : @git.commit(message)
+      if @logger
+        if result != ''
+          @logger.info("Created commit #{message}")
+        else
+          @logger.error('Could not commit files. Perhaps the hook failed.')
+        end
+      end
+      result == '' ? false : message
+    end
+
+    def tag(version_tag)
+      @git.add_tag(version_tag) unless @options[:dry]
+      @logger.info("Created tag #{version_tag}") if @logger
+    end
+  end
+end

data/lib/vump/logger/logger.rb

@@ -0,0 +1,34 @@
+require 'logger'
+require 'forwardable'
+
+module Vump
+  class Logger
+    extend Forwardable
+    def_delegators :@logger, :level=
+
+    def initialize(options = {})
+      @logger = ::Logger.new(options[:out] || STDOUT)
+      @logger.level = ::Logger::DEBUG if options[:verbose]
+      @logger.level = ::Logger::UNKNOWN if options[:silent]
+      @logger.formatter = proc do |_severity, _datetime, progname, msg|
+        progname ? "[#{progname}] #{msg}\n" : "#{msg}\n"
+      end
+    end
+
+    def info(message, module_name = nil)
+      @logger.add(::Logger::INFO, message, module_name)
+    end
+
+    def debug(message, module_name = nil)
+      @logger.add(::Logger::DEBUG, message, module_name)
+    end
+
+    def warn(message, module_name = nil)
+      @logger.add(::Logger::WARN, message, module_name)
+    end
+
+    def error(message, module_name = nil)
+      @logger.add(::Logger::ERROR, message, module_name)
+    end
+  end
+end

data/lib/vump/meta.rb

@@ -1,4 +1,40 @@
+require 'vump/modules/version_file'
+
 module Vump
-  # Brief summary of the package
-  SUMMARY = 'Raise version version in root of semver project.'.freeze
+  module Meta
+    def self.name
+      'vump'.freeze
+    end
+
+    def self.version
+      VersionFile.new(File.expand_path('../..', __dir__)).read
+    end
+
+    def self.summary
+      'Raise version version in root of semver project.'.freeze
+    end
+
+    def self.description
+      text = <<-DESCRIPTION
+        Semantic version bumper. CLI tool to easily manage projects using semver and automate menial version raising.
+      DESCRIPTION
+      text.strip
+    end
+
+    def self.homepage
+      'https://github.com/grissius/vump'.freeze
+    end
+
+    def self.license
+      'MIT'.freeze
+    end
+
+    def self.author
+      'Jaroslav Šmolík'.freeze
+    end
+
+    def self.email
+      'grissius@gmail.com'.freeze
+    end
+  end
 end

data/lib/vump/modules/base_file_module.rb

@@ -0,0 +1,39 @@
+require 'vump/modules/base_module'
+
+module Vump
+  class BaseFileModule < BaseModule
+    def filename
+      raise NotImplementedError, "Missing filename on #{name}"
+    end
+
+    def file_path
+      File.expand_path(filename, @base_path)
+    end
+
+    def relevant?
+      File.file?(file_path)
+    end
+
+    def to_stage
+      [file_path]
+    end
+
+    def read
+      @contents = File.read(file_path)
+      select(@contents)
+    end
+
+    def write(version)
+      contents = compose(@contents, version)
+      File.write(file_path, contents) unless @options[:dry]
+    end
+
+    def select(_contents)
+      raise NotImplementedError, "Missing select on #{name}"
+    end
+
+    def compose(_contents, _version)
+      raise NotImplementedError, "Missing compose on #{name}"
+    end
+  end
+end