vump 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcf27e70f95a805688552dc9d1647403860b6398
-  data.tar.gz: 82e6414209deebbc5ed2863b2701c8c59b702e25
+  metadata.gz: 613a312760f307d42f96f1019b0a884e23b6e91c
+  data.tar.gz: ab8ed5aa2d16a536805a697b09d9c1b1c06e2afe
 SHA512:
-  metadata.gz: 58da967536c9c45c6b93b92b6d36ec0cdb26af1b41317c4a08aabef486d66bf1f6045c16f0fec29bacfa30bf9ab7ac361cd1609b7566f4c0734907bddf699e16
-  data.tar.gz: 03b909422251c88ccac0264960b6b7d1e92e6a96db3cd937eaf6fb2417373129023434cfc61ef3eb765174f9638eff8feeb0e918e4f8ba5f2d1e27b60a7c0cc5
+  metadata.gz: 8683c206999fab3d91440c675af837385b5b6e2a05c53af56811324d1f78155830a62fbb1fc8ad88708932ab119ebca6a79405a128aab1aee6e9c708e4eebc00
+  data.tar.gz: 7d5522467b1e8468f416075fb2795b3c62834b47b25823d698a3125398887614f0a22076ad6e1c061532bc2246919f9055bf11f2d0a112d52c91155bb1718564

data/README.adoc

@@ -2,6 +2,11 @@
 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.
 
@@ -18,6 +23,15 @@ When working on a project with version management, increasing a version is a mun
 
 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.
 ```
@@ -39,3 +53,35 @@ WARNING: As the interface implies, your project must follow the {semver} specifi
 `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/VERSION

@@ -1 +1 @@
-1.0.2
+1.1.0

data/lib/cli.rb

@@ -20,6 +20,7 @@ module Vump
         opt.on('-v', '--verbose') { options[:verbose] = true }
         opt.on('-s', '--silent') { options[:silent] = true }
       end.parse!
+      setup(options)
       [options, args]
     end
 
@@ -52,13 +53,13 @@ module Vump
     def self.start(argv)
       options, args = parse_argv(argv)
       if options[:version]
-        puts "vump #{Vump::VERSION}"
+        Vump.logger.info "vump #{Vump::VERSION}"
+      elsif options[:help]
+        Vump.logger.info Vump::SUMMARY
       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>'
+        Vump.logger.info 'vump <major|minor|patch>'
       end
     end
   end

data/lib/vump.rb

@@ -1,5 +1,7 @@
 require File.expand_path('vump/semver/semver', __dir__)
-Dir[File.expand_path('vump/semver/module/*.rb', __dir__)]
+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'
 
@@ -27,15 +29,15 @@ module Vump
   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 }
+    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"
-    modules_versions.empty? ? [[], []] : modules_versions.transpose
+    mods_vers.empty? ? [[], []] : mods_vers.transpose
   end
 
   # Format CLI output
@@ -49,18 +51,17 @@ module Vump
     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)
+      Vump::VersionModules::VcsModules::Git.revise(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
+  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/version_modules/file_modules/keepachangelog.rb

@@ -0,0 +1,50 @@
+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

@@ -0,0 +1,29 @@
+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

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,26 @@
+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

@@ -0,0 +1,45 @@
+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

@@ -0,0 +1,19 @@
+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

data/vump.gemspec

@@ -14,7 +14,12 @@ Gem::Specification.new do |s|
   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*', 'VERSION']
+  s.files = Dir['bin/*',
+                'lib/**/*',
+                '*.gemspec',
+                'LICENSE*',
+                'README*',
+                'VERSION']
   s.executables = Dir['bin/*'].map { |f| File.basename(f) }
   s.has_rdoc    = 'yard'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vump
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Jaroslav Šmolík
@@ -80,13 +80,14 @@ files:
 - 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/semver/version_modules/file_modules/keepachangelog.rb
+- lib/vump/semver/version_modules/file_modules/npm.rb
+- lib/vump/semver/version_modules/file_modules/npm_lock.rb
+- lib/vump/semver/version_modules/file_modules/version_file.rb
+- lib/vump/semver/version_modules/read_write_version_module.rb
+- lib/vump/semver/version_modules/vcs_modules/git.rb
 - lib/vump/version.rb
 - vump.gemspec
 homepage: https://github.com/grissius/vump

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

@@ -1,48 +0,0 @@
-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

@@ -1,27 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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

@@ -1,24 +0,0 @@
-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/read_write_version_module.rb

@@ -1,43 +0,0 @@
-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