mark_version 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f35e7c74b39b1c809626c10952f61ff295245575
+  data.tar.gz: 15bdcf1e538f11949b1ad67066b5fab113a137a9
+SHA512:
+  metadata.gz: a8cf25e4603c898e339805a1e24fa4ade50e73bd26afc9f4d4f695029dd03d9a1ae85a98216c158acd0c1c31af192baf3eace958bd9b2566f8615e63ed689b7c
+  data.tar.gz: a0a20eb179613d13a763fa63b64b3702a0e9227f7daf160c459959053af7ad2780e156f0a968f48dcc88532129afc8d10c34a33cd6276a00abcc4aedfcc38f86

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--color

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Grayden Smith
+
+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,2 @@
+# mark_version
+A ruby gem used to track versions of ruby applications and tools

data/lib/mark_version/version_file.rb

@@ -0,0 +1,118 @@
+class VersionFile
+  attr_reader :file_name
+
+  def initialize(file_name = 'VERSION')
+    fail "Version file '#{file_name}' does not exist." unless File.file?(file_name)
+    @file_name = file_name
+    @version_file = open(file_name, 'r+')
+  end
+
+  def version
+    @version_file.rewind
+    version = @version_file.readline.chomp
+    version
+  end
+
+  def short_version
+    return version unless release_candidate?
+
+    version.split('-')[0]
+  end
+
+  def patch
+    fail 'Cannot patch a release candidate, it needs to be released first.' if release_candidate?
+    version = version_as_array
+    version[2] = (version[2].to_i + 1).to_s
+
+    write(version.join('.'))
+  end
+
+  def minor
+    fail 'Cannot minor increment a release candidate, it needs to be released first.' if release_candidate?
+    version = version_as_array
+    version[2] = '0'
+    version[1] = (version[1].to_i + 1).to_s
+
+    write(version.join('.'))
+  end
+
+  def major
+    fail 'Cannot major increment a release candidate, it needs to be released first.' if release_candidate?
+    version = version_as_array
+    version[2] = '0'
+    version[1] = '0'
+    version[0] = (version[0].to_i + 1).to_s
+
+    write(version.join('.'))
+  end
+
+  def minor_release_candidate
+    fail 'Cannot make a releae candidate out of a release candidate. To increment to the next release candidate, invoke "increment_release_candidate".' if release_candidate?
+    minor
+    write("#{short_version}-RC1")
+  end
+
+  def major_release_candidate
+    fail 'Cannot make a releae candidate out of a release candidate. To increment to the next release candidate, invoke "increment_release_candidate".' if release_candidate?
+    major
+    write("#{version}-RC1")
+  end
+
+  def increment_release_candidate
+    fail 'Cannot increment the release candidate version on a non release candidate.' unless release_candidate?
+    write("#{short_version}-RC#{next_release_candidate}")
+  end
+
+  def release
+    fail 'Cannot release a non release candidate.' unless release_candidate?
+    write(short_version)
+  end
+
+  def current_patch_version
+    if version.include?('RC')
+      version_as_array[2].split('-')[0]
+    else
+      version_as_array[2]
+    end
+  end
+
+  def current_minor_version
+    version_as_array[1]
+  end
+
+  def current_major_version
+    version_as_array[0]
+  end
+
+  def release_candidate_iteration
+    version.split('RC')[1].to_s
+  end
+
+  def release_candidate?
+    version.include?('RC')
+  end
+
+  private
+
+  def version_as_array
+    version.split('.')
+  end
+
+  def next_release_candidate
+    return 1 unless release_candidate?
+
+    release_candidate_iteration.to_i + 1
+  end
+
+  def revision
+    `git rev-parse --short HEAD`.chomp
+  end
+
+  def write(version)
+    @version_file.rewind
+    @version_file.puts(version)
+    @version_file.print(revision)
+    @version_file.rewind
+    version
+  end
+end

data/lib/mark_version.rb

@@ -0,0 +1 @@
+require 'mark_version/version_file.rb'

data/lib/tasks/mark_version.rake

@@ -0,0 +1,80 @@
+namespace :version do
+  def version
+    VersionFile.new.version
+  end
+
+  def file_name
+    VersionFile.new.file_name
+  end
+
+  def commit
+    system("git add #{file_name}")
+    system("git commit -m 'To version #{version}'")
+  end
+
+  def tag
+    system("git tag #{version} -a -m \"Release version #{version}\"")
+  end
+
+  desc "create a new patch-level (n.n.X) release"
+
+  task :patch => :environment do
+    VersionFile.new.patch
+    commit
+    tag
+  end
+
+  desc "create a new minor-level (n.X.n) release"
+
+  task :minor => :environment do
+    VersionFile.new.minor
+    commit
+    tag
+  end
+
+  desc "create a new major-level (X.n.n) release"
+
+  task :major => :environment do
+    VersionFile.new.major
+    commit
+    tag
+  end
+
+  desc "create a new minor-level (n.X.n-RC1) release candidate"
+
+  task :minor_release_candidate => :environment do
+    VersionFile.new.minor_release_candidate
+    commit
+    tag
+  end
+
+  desc "create a new major-level (X.n.n-RC1) release candidate"
+
+  task :major_release_candidate => :environment do
+    VersionFile.new.major_release_candidate
+    commit
+    tag
+  end
+
+  desc "increments the current release candidate (n.n.n-RCX)"
+
+  task :increment_release_candidate => :environment do
+    VersionFile.new.increment_release_candidate
+    commit
+    tag
+  end
+
+  desc "releases the current release candidate (n.n.n)"
+
+  task :release => :environment do
+    VersionFile.new.release
+    commit
+    tag
+  end
+
+  desc "print the current version level from the VERSION file"
+
+  task :show => :environment do
+    puts version
+  end
+end

data/mark_version.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name = 'mark_version'
+  s.version = '0.0.0'
+  s.date = '2015-05-30'
+  s.summary = 'A tool for recording the version of a ruby application.'
+  s.authors = ['Grayden Smith']
+  s.email = 'grayden@tech-vision.ca'
+  s.files = `git ls-files`.split($/)
+  s.homepage = 'http://graydens.ca'
+  s.license = 'MIT'
+
+  s.add_development_dependency 'rspec', '~> 3.2'
+end

data/spec/fixtures/version_file.txt

@@ -0,0 +1,2 @@
+0.9.12
+42324b

data/spec/version_file_spec.rb

@@ -0,0 +1,306 @@
+require 'mark_version'
+
+describe VersionFile do
+  let(:file_path) { 'spec/fixtures/version_file.txt' }
+
+  before(:each) do
+    File.write(file_path, "0.9.12\n42324b")
+  end
+
+  def version_file
+    VersionFile.new(file_path)
+  end
+
+  it 'gets the current version from the file' do
+    # versions should be in format: i.e. '0.9.12'
+    expect(version_file.version).to match(/^\d+\.\d+.\d+/)
+  end
+
+  it 'is able to get the version file name' do
+    expect(version_file.file_name).to eq file_path
+  end
+
+  context 'incrementing the patch version' do
+    before(:each) do
+      version_file.patch
+    end
+
+    it 'increments patch version' do
+      expect(version_file.current_patch_version).to eq '13'
+    end
+
+    it 'keeps the minor version the same' do
+      expect(version_file.current_minor_version).to eq '9'
+    end
+
+    it 'keeps the major version the same' do
+      expect(version_file.current_major_version).to eq '0'
+    end
+
+    it 'does not be a release candidate' do
+      expect(version_file.release_candidate?).not_to be
+    end
+  end
+
+  context 'incrementing the minor version' do
+    before(:each) do
+      version_file.minor
+    end
+
+    it 'resets the patch version' do
+      expect(version_file.current_patch_version).to eq '0'
+    end
+
+    it 'increments the minor version' do
+      expect(version_file.current_minor_version).to eq '10'
+    end
+
+    it 'does not change the major version' do
+      expect(version_file.current_major_version).to eq '0'
+    end
+
+    it 'does not be a release candidate' do
+      expect(version_file).not_to be_release_candidate
+    end
+  end
+
+  context 'incrementing the major version' do
+    before(:each) do
+      version_file.major
+    end
+
+    it 'resets the patch version' do
+      expect(version_file.current_patch_version).to eq '0'
+    end
+
+    it 'resets the minor version' do
+      expect(version_file.current_minor_version).to eq '0'
+    end
+
+    it 'increments major version' do
+      expect(version_file.current_major_version).to eq '1'
+    end
+
+    it 'does not be a release candidate' do
+      expect(version_file).not_to be_release_candidate
+    end
+  end
+
+  context 'creating a minor version release candidate' do
+    before(:each) do
+      version_file.minor_release_candidate
+    end
+
+    it 'marks the version as a release candidate' do
+      expect(version_file).to be_release_candidate
+    end
+
+    it 'resets the patch version' do
+      expect(version_file.current_patch_version).to eq '0'
+    end
+
+    it 'increments the minor version' do
+      expect(version_file.current_minor_version).to eq '10'
+    end
+
+    it 'does not change the major version' do
+      expect(version_file.current_major_version).to eq '0'
+    end
+
+    it 'is at RC iteration 1' do
+      expect(version_file.release_candidate_iteration).to eq '1'
+    end
+
+    it 'has RC and the RC version number at the end of the name' do
+      expect(version_file.version).to eq '0.10.0-RC1'
+    end
+  end
+
+  context 'creating a major version release candidate' do
+    before(:each) do
+      version_file.major_release_candidate
+    end
+
+    it 'marks the version as a release candidate' do
+      expect(version_file).to be_release_candidate
+    end
+
+    it 'resets the patch version' do
+      expect(version_file.current_patch_version).to eq '0'
+    end
+
+    it 'increments the minor version' do
+      expect(version_file.current_minor_version).to eq '0'
+    end
+
+    it 'does not change the major version' do
+      expect(version_file.current_major_version).to eq '1'
+    end
+
+    it 'is at RC iteration 1' do
+      expect(version_file.release_candidate_iteration).to eq '1'
+    end
+
+    it 'has RC and the RC version number at the end of the name' do
+      expect(version_file.version).to eq '1.0.0-RC1'
+    end
+  end
+
+  context 'incrementing a minor version release candidate' do
+    before(:each) do
+      version_file.minor_release_candidate
+      version_file.increment_release_candidate
+    end
+
+    it 'marks the version as a release candidate' do
+      expect(version_file).to be_release_candidate
+    end
+
+    it 'resets the patch version' do
+      expect(version_file.current_patch_version).to eq '0'
+    end
+
+    it 'increments the minor version' do
+      expect(version_file.current_minor_version).to eq '10'
+    end
+
+    it 'does not change the major version' do
+      expect(version_file.current_major_version).to eq '0'
+    end
+
+    it 'is at RC iteration 2' do
+      expect(version_file.release_candidate_iteration).to eq '2'
+    end
+
+    it 'has RC and the RC version number at the end of the name' do
+      expect(version_file.version).to eq '0.10.0-RC2'
+    end
+  end
+
+  context 'incrementing a major version release candidate' do
+    before(:each) do
+      version_file.major_release_candidate
+      version_file.increment_release_candidate
+    end
+
+    it 'marks the version as a release candidate' do
+      expect(version_file).to be_release_candidate
+    end
+
+    it 'resets the patch version' do
+      expect(version_file.current_patch_version).to eq '0'
+    end
+
+    it 'increments the minor version' do
+      expect(version_file.current_minor_version).to eq '0'
+    end
+
+    it 'does not change the major version' do
+      expect(version_file.current_major_version).to eq '1'
+    end
+
+    it 'is at RC iteration 2' do
+      expect(version_file.release_candidate_iteration).to eq '2'
+    end
+
+    it 'has RC and the RC version number at the end of the name' do
+      expect(version_file.version).to eq '1.0.0-RC2'
+    end
+  end
+
+  context 'releasing a release candidate' do
+    context 'minor release candidate' do
+      before(:each) do
+        version_file.minor_release_candidate
+        version_file.release
+      end
+
+      it 'removes the release candidate' do
+        expect(version_file).not_to be_release_candidate
+      end
+
+      it 'does not change the patch version' do
+        expect(version_file.current_patch_version).to eq '0'
+      end
+
+      it 'does not change the minor version' do
+        expect(version_file.current_minor_version).to eq '10'
+      end
+
+      it 'does not change the major version' do
+        expect(version_file.current_major_version).to eq '0'
+      end
+
+      it 'goes back to looking like a normal release' do
+        expect(version_file.version).to eq '0.10.0'
+      end
+    end
+
+    context 'major release candidate' do
+      before(:each) do
+        version_file.major_release_candidate
+        version_file.release
+      end
+
+      it 'removes the release candidate' do
+        expect(version_file).not_to be_release_candidate
+      end
+
+      it 'does not change the patch version' do
+        expect(version_file.current_patch_version).to eq '0'
+      end
+
+      it 'does not change the minor version' do
+        expect(version_file.current_minor_version).to eq '0'
+      end
+
+      it 'does not change the major version' do
+        expect(version_file.current_major_version).to eq '1'
+      end
+
+      it 'goes back to looking like a normal release' do
+        expect(version_file.version).to eq '1.0.0'
+      end
+    end
+  end
+
+  context 'error conditions' do
+    it 'does not be able to increment the release candidate unless the current version is some kind of release candidate' do
+      expect { version_file.increment_release_candidate }.to raise_error
+    end
+
+    it 'does not be able to declare a minor release candidate unless the current version is not a release candidate' do
+      version_file.minor_release_candidate
+
+      expect { version_file.minor_release_candidate }.to raise_error
+    end
+
+    it 'does not be able to declare a minor release candidate unless the current version is not a release candidate' do
+      version_file.minor_release_candidate
+
+      expect { version_file.major_release_candidate }.to raise_error
+    end
+
+    it 'does not be able to increment the patch version on a release candidate' do
+      version_file.minor_release_candidate
+
+      expect { version_file.patch }.to raise_error
+    end
+
+    it 'does not be able to increment the minor version on a release candidate' do
+      version_file.minor_release_candidate
+
+      expect { version_file.minor }.to raise_error
+    end
+
+    it 'does not be able to increment the major version on a release candidate' do
+      version_file.minor_release_candidate
+
+      expect { version_file.major }.to raise_error
+    end
+
+    it 'cannot release a non release candidate' do
+      expect { version_file.release }.to raise_error
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: mark_version
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Grayden Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: 
+email: grayden@tech-vision.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- LICENSE
+- README.md
+- lib/mark_version.rb
+- lib/mark_version/version_file.rb
+- lib/tasks/mark_version.rake
+- mark_version.gemspec
+- spec/fixtures/version_file.txt
+- spec/version_file_spec.rb
+homepage: http://graydens.ca
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A tool for recording the version of a ruby application.
+test_files: []