version_tracker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c9ccf35a8fd399ff71c248ef6c56e67cea3f3f8
+  data.tar.gz: 58f795cc7fc22539870662cbe709e6cd24ad280f
+SHA512:
+  metadata.gz: cbb5de30de51935ab5ee4b609113da30ddc11c381dd76d172b2dfa51e24dd7486e46b0e76f8db96ef25a9db9a7f547fb6f3374d41003b838f2286191ac95901a
+  data.tar.gz: 4ef94aef036c5a2ef1675ca0f783ef9fdc9e33727dcfb99a8f937bb1b6093e4514e4a2ee1379d503d0af362f276e38d865c75e5baf00f645929c07b40095fb8d

data/README.md

@@ -0,0 +1,54 @@
+# VersionTracker
+
+Add Version to your Rails Application.
+Currently supported version format is *major.minor.patch*, i.e. `0.0.0`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'version_tracker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install version_tracker
+
+## Usage
+
+### Using Command Line
+```
+version init [value]  # Initialize VERSION File with provided value.
+                      # Default: 0.0.0 if value is not provided and VERSION File does not exist
+version read          # Read current VERSION
+version bump [part]   # Bump VERSION based on part. Valid part: major, minor, patch. Default: patch
+version tag           # Tag using current VERSION
+  
+OPTIONS:
+  -r, --release                    Push to release branch using current version
+  -m, --message=MESSAGE            Push with custom commit message
+  -p, --push                       Push to current branch
+  -h, --help                       Help
+```
+
+### Using Rake Tasks
+```ruby
+rake version_tracker:initialize       # Initialize Version
+rake version_tracker:current_version  # Read Version
+rake version_tracker:bump_major       # Bump Major
+rake version_tracker:bump_minor       # Bump Minor
+rake version_tracker:bump_patch       # Bump Patch
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/version_tracker/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/bin/version

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'version_tracker/command_line'
+
+
+options = {}
+
+option_parser =
+  OptionParser.new do |opts|
+    opts.banner = <<BANNER
+Version Tracker: Manages Rails Application Version
+
+USAGE:
+  version init [value]  # Initialize VERSION File with provided value. Default: 0.0.0 if value is not provided and VERSION File does not exist
+  version read          # Read current VERSION
+  version bump [part]   # Bump VERSION based on part. Valid part: major, minor, patch. Default: patch
+  version tag           # Tag using current VERSION
+
+OPTIONS:
+BANNER
+
+    opts.on('-r', '--release', 'Push to release branch using current version') do
+      options[:release] = true
+    end
+
+
+    opts.on('-m MESSAGE', '--message=MESSAGE', 'Push with custom commit message') do |message|
+      options[:message] = message
+    end
+
+
+    opts.on('-p', '--push', 'Push to current branch') do
+      options[:push] = true
+    end
+
+
+    opts.on('-h', '--help', 'Help') do
+      puts opts
+      exit
+    end
+
+  end
+
+option_parser.parse!
+
+result, status = VersionTracker::CommandLine.new.execute ARGV, options
+
+puts result
+puts option_parser if status == VersionTracker::CommandLine::RESULT_STATUS::ERROR
+
+exit status

data/lib/errors/version_tracker_error.rb

@@ -0,0 +1,2 @@
+class VersionTrackerError < StandardError
+end

data/lib/tasks/version_tracker.rake

@@ -0,0 +1,44 @@
+require 'version_tracker'
+
+
+namespace :version_tracker do
+
+
+  def bump part
+    version_tracker = VersionTracker::Bumper.new
+    version_tracker.bump :part => part
+
+    puts version_tracker.version
+  end
+
+
+  desc 'Initialize Version'
+  task :initialize do
+    VersionTracker::Bumper.new.init
+  end
+
+
+  desc 'Read Version'
+  task :current_version do
+    puts VersionTracker::Bumper.new.version
+  end
+
+
+  desc 'Bump Major'
+  task :bump_major do
+    bump :major
+  end
+
+
+  desc 'Bump Minor'
+  task :bump_minor do
+    bump :minor
+  end
+
+
+  desc 'Bump Patch'
+  task :bump_patch do
+    bump :patch
+  end
+
+end

data/lib/version_tracker/bumper.rb

@@ -0,0 +1,106 @@
+#
+#
+# Reference:
+#   http://semver.org/
+#
+#
+
+require 'errors/version_tracker_error'
+require 'version_tracker/file_manager'
+
+
+module VersionTracker
+
+  class Bumper
+
+    attr_accessor :parts
+
+
+    DELIMITER = '.'
+    INITIAL_VERSION = '0.0.0'
+    BASIC_FORMAT = /^\d+\.\d+\.\d+$/
+
+
+    module PARTS
+      MAJOR = 0
+      MINOR = 1
+      PATCH = 2
+    end
+
+
+    def init version = nil
+      raise VersionTrackerError, 'Version format is invalid' if version && !(BASIC_FORMAT =~ version)
+
+      FileManager.write(version || INITIAL_VERSION)
+    end
+
+
+    #
+    #
+    # Options:
+    #   :part
+    #   :value
+    #
+    #
+    def bump options = {}
+      raise VersionTrackerError, 'Version File is not initialized' unless FileManager.initialized?
+
+      part = options[:part] || :patch
+
+      unless [:major, :minor, :patch].include?(part)
+        raise VersionTrackerError, 'Invalid Part Parameter.'
+      end
+
+
+      value = options[:value]
+      if value && !value.is_a?(Integer)
+        raise VersionTrackerError, 'Value should be of Integer Type'
+      end
+
+      self.send "bump_#{part}".to_sym, value
+    end
+
+
+    def version
+      raise VersionTrackerError, 'Version File is not initialized' unless FileManager.initialized?
+
+      FileManager.read
+    end
+
+
+    def parts
+      version_parts = self.version.split DELIMITER
+
+      hash = {}
+      hash[:major] = version_parts[PARTS::MAJOR].to_i
+      hash[:minor] = version_parts[PARTS::MINOR].to_i
+      hash[:patch] = version_parts[PARTS::PATCH].to_i
+
+      hash
+    end
+
+
+
+    protected
+
+    def bump_major value
+      value = value || self.parts[:major] + 1
+      FileManager.write [value, 0, 0].join DELIMITER
+    end
+
+
+    def bump_minor value
+      value = value || self.parts[:minor] + 1
+      FileManager.write [self.parts[:major], value, 0].join DELIMITER
+    end
+
+
+    def bump_patch value
+      value = value || self.parts[:patch] + 1
+      FileManager.write(
+        [self.parts[:major], self.parts[:minor], value].join DELIMITER)
+    end
+
+  end
+
+end

data/lib/version_tracker/command_line.rb

@@ -0,0 +1,118 @@
+require 'errors/version_tracker_error'
+require 'version_tracker/bumper'
+
+
+module VersionTracker
+
+  class CommandLine
+
+    module COMMANDS
+      INIT = 'init'
+      BUMP = 'bump'
+      READ = 'read'
+      TAG = 'tag'
+    end
+
+
+    module RESULT_STATUS
+      SUCCESS = 0
+      ERROR = 1
+    end
+
+
+    VALID_COMMANDS = %w(init bump read tag)
+    VALID_PARTS = %w(major minor patch)
+    DEFAULT_PART = 'patch'
+    DEFAULT_COMMIT_MESSAGE = 'Set Version to'
+
+
+    def initialize
+      @version_tracker = VersionTracker::Bumper.new
+    end
+
+
+    def execute args = [], options = {}
+      command = args[0] || COMMANDS::READ
+      raise VersionTrackerError, 'Invalid command' unless VALID_COMMANDS.include?(command)
+
+      @options = options.merge(:argument => args[1])
+
+
+      result =
+        case command
+        when COMMANDS::INIT
+          @version_tracker.init @options[:argument]
+          @version_tracker.version
+        when COMMANDS::READ
+          @version_tracker.version
+        when COMMANDS::TAG
+          self.git_tag
+          "Successfully created tag for #{@version_tracker.version}"
+        when COMMANDS::BUMP
+          self.bump
+          @version_tracker.version
+        end
+
+      self.release if !!@options[:release]
+      self.push if !!@options[:push] && !@options[:release]
+
+      [result, RESULT_STATUS::SUCCESS]
+    rescue VersionTrackerError => e
+      return [e.message, RESULT_STATUS::ERROR]
+    end
+
+
+
+
+
+    protected
+
+    def git_tag
+      result = system("git tag #{@version_tracker.version}")
+      raise VersionTrackerError, 'Failed to create tag' unless result
+
+      system("git push origin #{@version_tracker.version}")
+      raise VersionTrackerError, 'Failed to create tag' unless result
+    end
+
+
+    def bump
+      part = @options[:argument] || DEFAULT_PART
+      raise VersionTrackerError, 'Invalid part' unless VALID_PARTS.include?(part)
+
+      @version_tracker.bump :part => part.to_sym
+    end
+
+
+    def release
+      branch = ['release', @version_tracker.version].join '/'
+
+      exists = system "git rev-parse --verify #{branch}"
+      create_branch = '-b' unless exists
+
+      system ['git', 'checkout', create_branch, branch].join(' ')
+      self.git_commit branch
+    end
+
+
+    def push
+      result = `git rev-parse --abbrev-ref HEAD`
+      branch = result.gsub /\n/, ''
+      self.git_commit branch
+    end
+
+
+    def message
+      @options[:message] || [DEFAULT_COMMIT_MESSAGE, @version_tracker.version].join(' ')
+    end
+
+
+    def git_commit branch
+      system 'git add VERSION'
+      system "git commit -m '#{self.message}'"
+      system "git push origin #{branch}"
+    end
+
+  end
+
+end

data/lib/version_tracker/file_manager.rb

@@ -0,0 +1,31 @@
+require 'errors/version_tracker_error'
+
+
+module VersionTracker
+
+  class FileManager
+
+    FILENAME = 'VERSION'
+
+
+    def self.initialized?
+      File.exist? FILENAME
+    end
+
+
+    def self.read
+      raise VersionTrackerError, 'VERSION File does not exist.' unless self.initialized?
+
+      File.read FILENAME
+    end
+
+
+    def self.write version
+      File.open(FILENAME, 'w') do |file|
+        file.write version
+      end
+    end
+
+  end
+
+end

data/lib/version_tracker/railtie.rb

@@ -0,0 +1,14 @@
+require 'version_tracker'
+require 'rails'
+
+module VersionTracker
+
+  class Railtie < Rails::Railtie
+    railtie_name :version_tracker
+
+    rake_tasks do
+      load "tasks/version_tracker.rake"
+    end
+  end
+
+end

data/lib/version_tracker/version.rb

@@ -0,0 +1,3 @@
+module VersionTracker
+  VERSION = "0.1.0"
+end

data/lib/version_tracker.rb

@@ -0,0 +1,9 @@
+require 'version_tracker/version'
+require 'version_tracker/bumper'
+require 'version_tracker/file_manager'
+
+module VersionTracker
+
+  require 'version_tracker/railtie' if defined?(Rails)
+
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: version_tracker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Braymon Ramirez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Add Version to your Rails Application
+email:
+- braymon.ramirez@gmail.com
+executables:
+- version
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/version
+- lib/errors/version_tracker_error.rb
+- lib/tasks/version_tracker.rake
+- lib/version_tracker.rb
+- lib/version_tracker/bumper.rb
+- lib/version_tracker/command_line.rb
+- lib/version_tracker/file_manager.rb
+- lib/version_tracker/railtie.rb
+- lib/version_tracker/version.rb
+homepage: https://github.com/brayramirez/version_tracker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Provides command line and rake tasks to bump versions of your Rails Applications
+test_files: []