mark_version 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e59137ca71ad5cba33dc35cbe58abf30062fac3
-  data.tar.gz: 230fd695e36fcd59f46091a9d65b46501851d2b8
+  metadata.gz: 1bd23ab2a35e9fb968a4277dd60cf63a32f115a9
+  data.tar.gz: 9bd454eaa3cb167fcdac60e8b4f1eb0b4ba800cb
 SHA512:
-  metadata.gz: c6c341a76be0de9213f186936bfa012eb3b943cecf714cc5347025ee5187b02ebfc76a1ea5cabfaf5e929078b9166d8daf3f7d39ef765e3776fa23351fcbdffe
-  data.tar.gz: f5a03479bd0d03dcd42bea28e09009e181d1e57b4653bb1f727e58822444ecc445edb4e53dfa449e419104347bd81f17242ecc539b1c71d947217d990ea153cc
+  metadata.gz: b667cae79ff60d3f801ffd36a996259ee976bf31dde5a5692dce78aa50c48f1e2d56608dc83ea7ce7d819f5e902e935bf5ea2f9347d89a624ea72599c789875c
+  data.tar.gz: fe8ce74967dd0f39ecbe20376041163f6969a0cce0a90cef552a131a1b8b375907503f896dd2d8caf759da4dc188b1833246119621a67ff15c8a2d0c92bbed28

data/.mark_version/VERSION

@@ -0,0 +1 @@
+0.0.0

data/.rspec

@@ -1 +1,2 @@
 --color
+--require 'spec_helper'

data/lib/mark_version.rb

@@ -1,2 +1,5 @@
-require 'mark_version/version_file.rb'
-require 'mark_version/mark_version_cli.rb'
+require 'mark_version/version_file'
+require 'mark_version/mark_version_cli'
+require 'mark_version/git'
+require 'mark_version/project'
+require 'mark_version/mark_version_config'

data/lib/mark_version/git.rb

@@ -0,0 +1,73 @@
+class Git
+  def self.branch
+    `git rev-parse --abbrev-ref HEAD`.chomp
+  end
+
+  def self.ahead_of_version_by(branch)
+    `git rev-list #{self.last_version_commit}..#{branch} --count`.chomp
+  end
+
+  def self.ahead_of_version?(branch)
+    self.ahead_of_version_by(branch).to_i > 0
+  end
+
+  def self.current_ahead_of_version?
+    ahead_of_version?('HEAD')
+  end
+
+  def self.current_ahead_by
+    ahead_of_version_by('HEAD')
+  end
+
+  def self.ahead_of_release_by
+    `git rev-list #{closest_release_branch}..HEAD --count`.chomp
+  end
+
+  def self.ahead_of_branch_by(branch)
+    `git rev-list #{branch}..HEAD --count`.chomp
+  end
+
+  def self.closest_release_branch
+    branch = nil
+    distance = nil
+
+    MarkVersionConfig.new.release_branches.each do |branch|
+      if distance.nil? || ahead_of_branch_by(branch) < distance
+        branch = branch
+        distance = ahead_of_branch_by(branch)
+      end
+    end
+
+    branch || 'master'
+  end
+
+  def self.on_release_branch?
+    MarkVersionConfig.new.release_branches.include?(branch)
+  end
+
+  def self.short_hash
+    `git rev-parse --short HEAD`.chomp
+  end
+
+  def self.last_version_commit
+    `git log --format="%h" .mark_version/VERSION | head -n 1`.chomp
+  end
+
+  def self.commit_and_tag(version)
+    commit(version)
+    tag(version)
+  end
+
+  def self.commit(version)
+    `git add .mark_version/VERSION`
+    `git commit -m "To version #{version}"`
+  end
+
+  def self.tag(version)
+    `git tag #{version} -a -m "Release version #{version}"`
+  end
+
+  def self.push
+    `git push origin --tags`
+  end
+end

data/lib/mark_version/mark_version_cli.rb

@@ -5,81 +5,51 @@ class MarkVersionCli < Thor
 
   desc 'init', 'initialize the project to start tracking it\'s version'
   def init
-    VersionFile.new.init
-    commit
-    tag
+    Project.init
   end
 
   desc 'patch', 'create a new patch-level (n.n.X) release'
   def patch
-    VersionFile.new.patch
-    commit
-    tag
+    Project.patch
   end
 
   desc 'minor', 'create a new minor-level (n.X.n) release'
   def minor
-    VersionFile.new.minor
-    commit
-    tag
+    Project.minor
   end
 
   desc 'major', 'create a new major-level (X.n.n) release'
   def major
-    VersionFile.new.major
-    commit
-    tag
+    Project.major
   end
 
   desc 'minor_release_candidate', 'create a new minor-level (n.X.n-RC1) release candidate'
   def minor_release_candidate
-    VersionFile.new.minor_release_candidate
-    commit
-    tag
+    Project.minor_release_candidate
   end
 
   desc 'major_release_candidate', 'create a new major-level (X.n.n-RC1) release candidate'
   def major_release_candidate
-    VersionFile.new.major_release_candidate
-    commit
-    tag
+    Project.major_release_candidate
   end
 
   desc 'increment_release_candidate', 'increments the current release candidate (n.n.n-RCX)'
   def increment_release_candidate
-    VersionFile.new.increment_release_candidate
-    commit
-    tag
+    Project.increment_release_candidate
   end
 
   desc 'release', 'releases the current release candidate (n.n.n)'
   def release
-    VersionFile.new.release
-    commit
-    tag
+    Project.release
   end
 
   desc 'show', "print the current version level from the VERSION file"
+  option :dev, type: :boolean
   def show
-    puts version
-  end
-
-  no_commands {
-    def version
-      VersionFile.new.version
+    if options[:dev]
+      puts Project.dev_version
+    else
+      puts Project.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
-  }
+  end
 end

data/lib/mark_version/mark_version_config.rb

@@ -0,0 +1,82 @@
+require 'json'
+
+class MarkVersionConfig
+  attr_reader :base_folder_name
+
+  def initialize(base_folder_name = '.mark_version')
+    @base_folder_name = base_folder_name
+  end
+  
+  def init
+    f1 = open(project_config_file, 'w')
+    f1.puts('{ }')
+    f1.close
+    f2 = open(local_config_file, 'w')
+    f2.puts('{ }')
+    f2.close
+  end
+
+  def project_config_file
+    "#{base_folder_name}/CONFIG"
+  end
+
+  def local_config_file
+    "#{base_folder_name}/LOCAL_CONFIG"
+  end
+
+  def release_branches
+    project_configs['release_branches'] || []
+  end
+
+  def add_release_branch(branch)
+    configs = project_configs
+
+    configs['release_branches'] = [] if configs['release_branches'].nil?
+
+    configs['release_branches'] << branch
+
+    write_project(configs)
+  end
+
+  def remove_release_branch(branch)
+    configs = project_configs
+
+    return false if configs['release_branches'].nil?
+
+    configs['release_branches'] = configs['release_branches'] - [branch]
+
+    write_project(configs)
+  end
+
+  def auto_push?
+    local_configs['auto_push']
+  end
+
+  def set_auto_push(set)
+    configs = local_configs
+
+    configs['auto_push'] = set
+
+    write_local(configs)
+  end
+
+  private
+
+  def local_configs
+    content = File.read(local_config_file) rescue ''
+    JSON.parse(content) rescue {}
+  end
+
+  def write_local(configs)
+    File.write(local_config_file, configs.to_json)
+  end
+
+  def project_configs
+    content = File.read(project_config_file) rescue ''
+    JSON.parse(content) rescue {}
+  end
+
+  def write_project(configs)
+    File.write(project_config_file, configs.to_json)
+  end
+end

data/lib/mark_version/project.rb

@@ -0,0 +1,57 @@
+class Project
+  def self.init
+    Dir.mkdir('.mark_version')
+    VersionFile.new.init
+    MarkVersionConfig.new.init
+    commit_and_tag
+  end
+
+  def self.patch
+    VersionFile.new.patch
+    commit_and_tag
+  end
+
+  def self.minor
+    VersionFile.new.minor
+    commit_and_tag
+  end
+
+  def self.major
+    VersionFile.new.major
+    commit_and_tag
+  end
+
+  def self.minor_release_candidate
+    VersionFile.new.minor_release_candidate
+    commit_and_tag
+  end
+
+  def self.major_release_candidate
+    VersionFile.new.major_release_candidate
+    commit_and_tag
+  end
+
+  def self.increment_release_candidate
+    VersionFile.new.increment_release_candidate
+    commit_and_tag
+  end
+
+  def self.release
+    VersionFile.new.release
+    commit_and_tag
+  end
+
+  def self.version
+    VersionFile.new.version
+  end
+
+  def self.dev_version
+    VersionFile.new.dev_version
+  end
+
+  def self.commit_and_tag
+    Git.commit(VersionFile.new.version)
+    Git.tag(VersionFile.new.version)
+    Git.push if MarkVersionConfig.new.auto_push?
+  end
+end

data/lib/mark_version/version_file.rb

@@ -1,8 +1,8 @@
 class VersionFile
   attr_reader :file_name
 
-  def initialize(file_name = 'VERSION')
-    @file_name = file_name
+  def initialize(file_name = "#{MarkVersionConfig.new.base_folder_name}/VERSION")
+    @file_name = "#{file_name}"
   end
 
   def init
@@ -10,7 +10,6 @@ class VersionFile
     @version_file = open(file_name, 'w')
     @version_file.rewind
     @version_file.puts('0.0.0')
-    @version_file.print(revision)
     @version_file.rewind
     @version_file.close
     version
@@ -22,9 +21,18 @@ class VersionFile
 
   def version
     fail "Version file '#{file_name}' does not exist." unless file_exists?
+
     @version_file = open(file_name, 'r+')
     version = @version_file.readline.chomp
     @version_file.close
+
+    version
+  end
+
+  def dev_version
+    return "#{version}.#{Git.branch}+#{Git.ahead_of_release_by}" unless Git.on_release_branch?
+    return "#{version}+#{Git.current_ahead_by}" if Git.current_ahead_of_version?
+
     version
   end
 
@@ -119,15 +127,10 @@ class VersionFile
     release_candidate_iteration.to_i + 1
   end
 
-  def revision
-    `git rev-parse --short HEAD`.chomp
-  end
-
   def write(version)
     fail "Version file '#{file_name}' does not exist." unless file_exists?
     @version_file = open(file_name, 'r+')
     @version_file.puts(version)
-    @version_file.print(revision)
     @version_file.close
     version
   end

data/mark_version.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'mark_version'
-  s.version = '0.1.0'
+  s.version = '0.3.0'
   s.date = '2015-05-30'
   s.summary = 'A tool for recording the version of a ruby application.'
   s.authors = ['Grayden Smith']
@@ -10,5 +10,8 @@ Gem::Specification.new do |s|
   s.homepage = 'http://graydens.ca'
   s.license = 'MIT'
 
+  s.add_dependency 'json', '~> 1.8'
+
+  s.add_development_dependency 'thor', '~> 0.19'
   s.add_development_dependency 'rspec', '~> 3.2'
 end

data/spec/fixtures/.mark_version/LOCAL_CONFIG

@@ -0,0 +1 @@
+{ "auto_push": true }

data/spec/git_spec.rb

@@ -0,0 +1,27 @@
+require 'mark_version'
+
+describe Git do
+  around(:each) do |e|
+    Dir.mkdir('spec/fixtures/dummy_project') unless Dir.exists?('spec/fixtures/dummy_project') 
+    Dir.chdir('spec/fixtures/dummy_project') do
+      `git init`
+      `touch hi`
+      `git add .`
+      `git commit -m "initial commit"`
+    end
+
+    Dir.chdir('spec/fixtures/dummy_project') do
+      e.run
+    end
+
+    FileUtils.rm_rf('spec/fixtures/dummy_project')
+  end
+
+  it 'retrieves the current git repository branch' do
+    expect(Git.branch).to eq('master')
+  end
+
+  it 'provides a short commit hash' do
+    expect(Git.short_hash).to match(/[a-f0-9]{7}/)
+  end
+end

data/spec/mark_version_config_spec.rb

@@ -0,0 +1,41 @@
+require 'mark_version'
+
+describe MarkVersionConfig do
+  let(:folder_path) { 'spec/fixtures/.mark_version' }
+  let(:config) { described_class.new('spec/fixtures/.mark_version') }
+
+  before(:each) do
+    File.write("#{folder_path}/LOCAL_CONFIG", '{ "auto_push": true }')
+  end
+
+  before(:each) do
+    File.write("#{folder_path}/CONFIG", '')
+  end
+
+  it 'retrieves that the local environment should push tags' do
+    expect(config.auto_push?).to eq(true)
+  end
+
+  it 'sets the local config to not push tags' do
+    config.set_auto_push(false)
+    expect(config.auto_push?).to eq(false)
+  end
+
+  it 'adds a release branch' do
+    config.add_release_branch('master')
+    expect(config.release_branches).to eq ['master']
+  end
+
+  it 'removes a release branch' do
+    config.add_release_branch('master')
+    config.add_release_branch('stable')
+
+    config.remove_release_branch('master')
+
+    expect(config.release_branches).to eq ['stable']
+  end
+
+  it 'returns false when there are no release branches to remove' do
+    expect(config.remove_release_branch('master')).to eq(false)
+  end
+end

data/spec/project_spec.rb

@@ -0,0 +1,146 @@
+require 'mark_version'
+
+describe Project do
+  around(:each) do |e|
+    Dir.mkdir('spec/fixtures/dummy_project') unless Dir.exists?('spec/fixtures/dummy_project') 
+    Dir.chdir('spec/fixtures/dummy_project') do
+      `git init`
+      `touch hi`
+      `git add hi`
+      `git commit -m "initial commit"`
+    end
+
+    Dir.chdir('spec/fixtures/dummy_project') do
+      e.run
+    end
+
+    FileUtils.rm_rf('spec/fixtures/dummy_project')
+  end
+
+  it 'initializes a project with version 0.0.0' do
+    described_class.init
+
+    expect(described_class.version).to eq('0.0.0')
+  end
+
+  context 'initialized project' do
+    before(:each) do
+      described_class.init
+      MarkVersionConfig.new.add_release_branch('master')
+    end
+
+    context 'on a release branch' do
+      it 'shows a project version' do
+        expect(described_class.version).to be
+      end
+
+      context 'when creating a patch' do
+        before(:each) do
+          described_class.patch
+        end
+
+        it 'increments the project patch number' do
+          expect(described_class.version).to eq('0.0.1')
+        end
+      end
+
+      context 'when adding a minor version' do
+        before(:each) do
+          described_class.minor
+        end
+
+        it 'increments the project minor number' do
+          expect(described_class.version).to eq('0.1.0')
+        end
+      end
+
+      context 'when adding a major version' do
+        before(:each) do
+          described_class.major
+        end
+
+        it 'increments the project major number' do
+          expect(described_class.version).to eq('1.0.0')
+        end
+      end
+
+      context 'creating a minor release candidate' do
+        before(:each) do
+          described_class.minor_release_candidate
+        end
+
+        it 'increments the project minor number and marks it as a release candidate' do
+          expect(described_class.version).to eq('0.1.0-RC1')
+        end
+
+        context 'then incrementing a release candidate' do
+          before(:each) do
+            described_class.increment_release_candidate
+          end
+
+          it 'increments the release candidate number' do
+            expect(described_class.version).to eq('0.1.0-RC2')
+          end
+        end
+
+        context 'then releasing the project' do
+          before(:each) do
+            described_class.release
+          end
+
+          it 'changes the version to released' do
+            expect(described_class.version).to eq('0.1.0')
+          end
+        end
+      end
+
+      context 'creating a major release candidate' do
+        before(:each) do
+          described_class.major_release_candidate
+        end
+
+        it 'increments the project major number and marks it as a release candidate' do
+          expect(described_class.version).to eq('1.0.0-RC1')
+        end
+      end
+
+      context 'then adding a commit' do
+        before(:each) do
+          `touch hello`
+          `git add .`
+          `git commit -m "second commit"`
+        end
+
+        it 'keeps the same default version' do
+          expect(described_class.version).to eq('0.0.0')
+        end
+
+        it 'shows details in the dev version' do
+          expect(described_class.dev_version).to eq('0.0.0+1')
+        end
+      end
+    end
+
+    context 'off of a release branch' do
+      before(:each) do
+        `git checkout -b feature1 2> /dev/null`
+      end
+
+      it 'provides a dev version that shows the current branch plus 0' do
+        expect(described_class.dev_version).to eq('0.0.0.feature1+0')
+      end
+
+      context 'then adding a commit' do
+        before(:each) do
+          `touch hello`
+          `git add .`
+          `git commit -m "second commit"`
+        end
+
+        it 'provides a dev version that shows progress down the release branch' do
+          expect(described_class.dev_version).to eq('0.0.0.feature1+1')
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+RSpec.configure do |c|
+end

data/spec/version_file_spec.rb

@@ -5,21 +5,61 @@ describe VersionFile do
 
   before(:each) do
     File.write(file_path, "0.9.12\n42324b")
+    allow(Git).to receive(:current_ahead_of_version?).and_return(false)
+    allow(Git).to receive(:on_release_branch?).and_return(true)
   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
 
+  describe 'the current version' do
+    context 'when at the current version' do
+      it 'gets the current dev version from the file' do
+        expect(version_file.dev_version).to eq('0.9.12')
+      end
+
+      it 'gets the current version from the file' do
+        expect(version_file.version).to eq('0.9.12')
+      end
+    end
+
+    context 'when ahead of the current version' do
+      before(:each) do
+        allow(Git).to receive(:current_ahead_of_version?).and_return(true)
+        allow(Git).to receive(:current_ahead_by).and_return(4)
+      end
+
+      it 'the dev version shows the number of commits that have been added since the last version' do
+        expect(version_file.dev_version).to eq('0.9.12+4')
+      end
+
+      it 'the version shows the basic semantic version number' do
+        expect(version_file.version).to eq('0.9.12')
+      end
+    end
+
+    context 'when on a feature branch' do
+      before(:each) do
+        allow(Git).to receive(:on_release_branch?).and_return(false)
+        allow(Git).to receive(:ahead_of_release_by).and_return(7)
+        allow(Git).to receive(:branch).and_return('feature_in_dev')
+      end
+
+      it 'shows the current feature branch and the number of commits that have been added to it' do
+        expect(version_file.dev_version).to eq('0.9.12.feature_in_dev+7')
+      end
+
+      it 'the version shows the basic semantic version number' do
+        expect(version_file.version).to eq('0.9.12')
+      end
+    end
+  end
+
   context 'incrementing the patch version' do
     before(:each) do
       version_file.patch

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mark_version
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Grayden Smith
@@ -10,6 +10,34 @@ bindir: bin
 cert_chain: []
 date: 2015-05-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -32,15 +60,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".mark_version/VERSION"
 - ".rspec"
 - LICENSE
 - README.md
 - bin/version
 - lib/mark_version.rb
+- lib/mark_version/git.rb
 - lib/mark_version/mark_version_cli.rb
+- lib/mark_version/mark_version_config.rb
+- lib/mark_version/project.rb
 - lib/mark_version/version_file.rb
 - mark_version.gemspec
+- spec/fixtures/.mark_version/CONFIG
+- spec/fixtures/.mark_version/LOCAL_CONFIG
 - spec/fixtures/version_file.txt
+- spec/git_spec.rb
+- spec/mark_version_config_spec.rb
+- spec/project_spec.rb
+- spec/spec_helper.rb
 - spec/version_file_spec.rb
 homepage: http://graydens.ca
 licenses: