version_manager 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4567a65cab744ad2b8e0cba5546a907616df5f56
+  data.tar.gz: 90579a75079d72e8e2dbe1bc1dfb24e5a36bbfe1
+SHA512:
+  metadata.gz: ba96ca3be67e8289b7b717b538bc997ea9409967bc5ac927c62ac852a586dc3de2492e8f53d02233c8693a3a52ffd8841a13e0eb0dad447e62027ca5f616bea5
+  data.tar.gz: d29871302090e70b2cf670ae3070727f204fc2839010b108fa373636620503ca4af52dfd75b39e793b7be6218f0b80c0494941f8125c0f7d611324eb4822e5ef

data/README.md

@@ -0,0 +1,68 @@
+# Version Manager
+
+Automatically manage version updates and tagging. The new version will be written to your version file,
+history file and as a tagged git commit.
+
+## Dependencies
+
+* Ruby >= 2.2
+* Rake
+
+## Installation
+
+```ruby
+
+# In Gemfile
+
+group :development do
+  gem "version_manager"
+end
+
+# In a Rake configuration file
+
+require "version_manager/rake_task"
+
+VersionManager::RakeTask.new(:release) do |config| # Argument is the namespace for tasks
+  config.version_file = "lib/version.rb" # Path to your version file
+  config.version_constant = "VERSION" # Version constant including namespaces
+  config.history_file = "history.rdoc" # History file to be updated
+  config.tag_format = "v%s" # %s will be replaced with the new version as tag names
+  config.logger = Logger.new # Replace the logger to turn off / modify stdout logging
+end
+
+```
+
+## Usage
+
+```
+
+bundle exec rake release:patch # Patch release eg 1.2.3 => 1.2.4
+bundle exec rake release:minor # Minor release eg 1.2.3 => 1.3.0
+bundle exec rake release:major # Major release eg 1.2.3 => 2.0.0
+
+```
+
+## Configuration
+
+### `config.version_file`
+
+The file which will be passed to `load` in order to load your current version number. It should be an absoltue
+file path or relative to your project's root
+
+### `config.version_constant`
+
+The constant which will be loaded as the current version. For example, if your version number is in a module
+called `MyModule` as the constant `MY_VERSION`, the `version_constant` would be `"MyModule::MY_VERSION"` (as a string)
+
+### `config.history_file`
+
+Path to your history file. Currently only supports rdoc format.
+
+### `config.tag_format`
+
+The format git tags will be given after version has been updated. `%s` will be replaced with the version number
+
+### `config.logger`
+
+The logger to use when printing info messages. By default this just logs the messages with no formatting to STDOUT.
+If you want to suppress logging you can just use `Logger.new "/dev/null"`

data/lib/version_manager/configuration.rb

@@ -0,0 +1,29 @@
+require "logger"
+
+module VersionManager
+  class Configuration
+    attr_accessor :history_file, :version_file, :version_constant, :tag_format, :logger
+
+    def initialize
+      @logger = unformatter_logger
+      @history_file = "history.rdoc"
+      @tag_format = "v%s"
+      @version_file = "lib/version.rb"
+      @version_constant = "VERSION"
+    end
+
+    private
+
+    def unformatter_logger
+      logger = Logger.new STDOUT
+      logger.formatter = log_formatter
+      logger
+    end
+
+    def log_formatter
+      proc {|_severity, _datetime, _progname, msg|
+        msg + "\n"
+      }
+    end
+  end
+end

data/lib/version_manager/git/cli.rb

@@ -0,0 +1,17 @@
+module VersionManager
+  module Git
+    module CLI
+      def add *files
+        `git add #{files.join(" ")}`
+      end
+
+      def commit message
+        `git commit -m '#{message}'`
+      end
+
+      def tag message
+        `git tag -am '#{message}' #{message}`
+      end
+    end
+  end
+end

data/lib/version_manager/git/stub.rb

@@ -0,0 +1,29 @@
+module VersionManager
+  module Git
+    module Stub
+      def add *files
+        @files = files
+      end
+
+      def commit message
+        @commit_message = message
+      end
+
+      def tag message
+        @tag_message = message
+      end
+
+      def files
+        @files
+      end
+
+      def commit_message
+        @commit_message
+      end
+
+      def tag_message
+        @tag_message
+      end
+    end
+  end
+end

data/lib/version_manager/git.rb

@@ -0,0 +1,12 @@
+require "version_manager/git/cli"
+require "version_manager/git/stub"
+
+module VersionManager
+  module Git
+    extend CLI
+
+    def self.stub_api
+      singleton_class.prepend VersionManager::Git::Stub
+    end
+  end
+end

data/lib/version_manager/rake_task.rb

@@ -0,0 +1,27 @@
+require "rake/tasklib"
+require "version_manager"
+require "version_manager/version_updater"
+
+module VersionManager
+  class RakeTask < Rake::TaskLib
+    EXAMPLES = {
+      major: "1.2.3 => 2.0.0",
+      minor: "1.2.3 => 1.3.0",
+      patch: "1.2.3 => 1.2.4",
+    }.freeze
+
+    # rubocop: disable Metrics/MethodLength
+    def initialize task_namespace = :release
+      yield(VersionManager.configuration) if block_given?
+      namespace task_namespace do
+        [:major, :minor, :patch].each do |v|
+          desc "Increment your #{v} version number eg #{EXAMPLES[v]}"
+          task v do
+            VersionUpdater.new.call(v)
+          end
+        end
+      end
+    end
+    # rubocop: enable all
+  end
+end

data/lib/version_manager/version.rb

@@ -0,0 +1,3 @@
+module VersionManager
+  VERSION = "1.0.0".freeze
+end

data/lib/version_manager/version_finder.rb

@@ -0,0 +1,10 @@
+require "version_manager/version_number"
+
+module VersionManager
+  class VersionFinder
+    def call
+      load VersionManager.configuration.version_file
+      VersionNumber.new Object.const_get(VersionManager.configuration.version_constant)
+    end
+  end
+end

data/lib/version_manager/version_number.rb

@@ -0,0 +1,33 @@
+module VersionManager
+  class VersionNumber
+    attr_reader :major, :minor, :patch, :starting_version
+
+    def initialize version_string
+      @starting_version = version_string
+      @major, @minor, @patch = version_string.split(".").map(&:to_i)
+    end
+
+    def inc_major
+      @major += 1
+      @minor = 0
+      @patch = 0
+    end
+
+    def inc_minor
+      @minor += 1
+      @patch = 0
+    end
+
+    def inc_patch
+      @patch += 1
+    end
+
+    def to_s
+      "#{@major}.#{@minor}.#{@patch}"
+    end
+
+    def to_tag
+      VersionManager.configuration.tag_format % to_s
+    end
+  end
+end

data/lib/version_manager/version_tagger.rb

@@ -0,0 +1,32 @@
+require "version_manager/git"
+
+module VersionManager
+  class VersionTagger
+    def call version
+      logger.info "Committing and tagging..."
+      tag version
+      logger.info "Done"
+      logger.info "Run `git push origin master --tags` to deploy your new tag (#{version.to_tag})"
+    end
+
+    private
+
+    def tag version
+      Git.add history_file, version_file
+      Git.commit "Update version to #{version.to_tag}"
+      Git.tag version.to_tag
+    end
+
+    def history_file
+      VersionManager.configuration.history_file
+    end
+
+    def version_file
+      VersionManager.configuration.version_file
+    end
+
+    def logger
+      VersionManager.configuration.logger
+    end
+  end
+end

data/lib/version_manager/version_updater.rb

@@ -0,0 +1,12 @@
+require "version_manager/version_finder"
+require "version_manager/version_writer"
+
+module VersionManager
+  class VersionUpdater
+    def call update_type
+      v = VersionFinder.new.call
+      v.send(:"inc_#{update_type}")
+      VersionWriter.new.call v
+    end
+  end
+end

data/lib/version_manager/version_writer.rb

@@ -0,0 +1,31 @@
+require "version_manager/version_tagger"
+
+module VersionManager
+  class VersionWriter
+    def call version
+      File.write version_file, updated_version_file(version)
+      File.write history_file, updated_history_file(version) if File.exist?(history_file)
+      VersionTagger.new.call version
+    end
+
+    def updated_version_file new_version
+      File.read(version_file).gsub(new_version.starting_version, new_version.to_s)
+    end
+
+    def updated_history_file new_version
+      current_history = File.read history_file
+      date = Date.today.strftime("%d %B %Y")
+      "== #{new_version.to_tag} (#{date})\n\n#{current_history}"
+    end
+
+    private
+
+    def history_file
+      VersionManager.configuration.history_file
+    end
+
+    def version_file
+      VersionManager.configuration.version_file
+    end
+  end
+end

data/lib/version_manager.rb

@@ -0,0 +1,7 @@
+require "version_manager/configuration"
+
+module VersionManager
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: version_manager
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tom Bowden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: Increment your project's version and history file automatically
+email: tom.b1992@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/version_manager.rb
+- lib/version_manager/configuration.rb
+- lib/version_manager/git.rb
+- lib/version_manager/git/cli.rb
+- lib/version_manager/git/stub.rb
+- lib/version_manager/rake_task.rb
+- lib/version_manager/version.rb
+- lib/version_manager/version_finder.rb
+- lib/version_manager/version_number.rb
+- lib/version_manager/version_tagger.rb
+- lib/version_manager/version_updater.rb
+- lib/version_manager/version_writer.rb
+homepage: http://github.com/tpbowden/version_manager.git
+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.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.2
+signing_key: 
+specification_version: 4
+summary: Convenience tasks for version management
+test_files: []