app_version 0.1.1

data/README.rdoc

@@ -0,0 +1,97 @@
+= App Version
+
+This is a simple plugin that makes it easy to manage the version number of your
+Rails application. The version numbers supported by this plugin look like
+'2.0.1 M4 (600) of branch by coder on 2008-10-27'.
+
+The components of the version number are:
+
+  2          => major
+  0          => minor
+  1          => patch
+  M4         => milestone
+  (600)      => build number (usually Subversion revision)
+  branch     => the name of the branch this version is from.
+  coder      => the name of the user that made the release
+  2008-10-27 => the date of the release
+
+Only the major and minor numbers are required. The rest can be omitted and the
+plugin will attempt to do the right thing.
+
+== Install
+
+To install this plugin from gitHub run the following command:
+
+./script/plugin install git://github.com/toland/app_version.git
+
+== Usage
+
+To use, simply place a file in RAILS_ROOT/config called version.yml with the
+following format:
+
+  major:     2
+  minor:     0
+  patch:     1
+  milestone: 4
+  build:     git-revcount
+  branch:    master
+  committer: coder
+  build_date: 2008-10-27
+
+If the milestone or patch fields are less than 0 then they will not show up
+in the version string. The build field can be a build number or one of the
+following strings: svn, git-hash or git-revcount. If it is a number then that
+number will be used as the build number, if it is one of the special strings
+then the plugin will attempt to query the source control system for the build
+number. The build date field can be a date or the following string: git-revdate.
+If you use the special string it will query the source control system and output 
+in YYYY-MM-DD format the commit date of the last revision.
+
+Using 'svn' for the build number will cause the plugin to query Subversion for
+the current revision number. Since Git doesn't have a numbered revision we have
+to fake it. 'git-revcount' will count the number of commits to the repository
+and use that as the build number whereas 'git-hash' will use the first 6 digits
+of the current HEAD's hash.
+
+The plugin creates a constant APP_VERSION that contains the version number of
+the application. Calling the +to_s+ method on APP_VERSION will result in a
+properly formatted version number. APP_VERSION also has +major+, +minor+,
++patch+, +milestone+, +build+, +branch+, +committer+, and +build_date+
+methods to retrieve the individual components of the version number.
+
+== Capistrano Usage
+
+When the app_version plugin is installed, it copies a templated edition of the
+version.yml file into /lib/templates/version.yml.erb, the initial file shows a
+tag for retrieving the revision count with git. It also shows displaying the
+branch as specified with "set :branch" in your capistrano deploy.rb, see the
+comments in the erb file for more nifty tricks.
+
+When you do a cap deploy, there is a capistrano recipe built-in to the app_version
+plugin, which will render the templated version.yml into the standard location as
+mentioned above. This happens automatically after the deploy is done.
+
+Both the standard and extended capistrano usage can co-exist in the same project
+the dynamic rendering of the version.yml only happens when using capistrano to
+deploy your app.
+
+== Rake tasks
+
+This plugin includes 4 new rake tasks:
+
+rake app:install    - will copy the version.yml and version.yml.erb into more user
+                      accessible locations (/config, and /lib/templates)
+
+rake app:uninstall  - will remove the files copied in the install task
+
+rake app:render     - will render the erb template into /config/version.yml
+                      in case you want to have dynamic values updated via a rake task.
+                      Note: certain examples expect the app to be in a git working directory.
+
+rake app:version    - will output the version number of the current rails
+                      application.
+
+= License
+
+This plugin is released under the terms of the Ruby license. See
+http://www.ruby-lang.org/en/LICENSE.txt.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the app_version plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the app_version plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'App-version'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/app_version.rb

@@ -0,0 +1,5 @@
+module App
+  require 'app_version/railtie' if defined?(Rails)
+end
+
+require 'app_version/app_version'

data/lib/app_version/app_version.rb

@@ -0,0 +1,149 @@
+require 'active_support/core_ext/object'  
+
+require 'yaml'
+
+module App
+  class Version
+    include Comparable
+
+    attr_accessor :major, :minor, :patch, :milestone, :build, :branch, :committer, :build_date, :format
+
+    [:major, :minor, :patch, :milestone, :build, :branch, :committer, :format].each do |attr|
+      define_method "#{attr}=".to_sym do |value|
+        instance_variable_set("@#{attr}".to_sym, value.blank? ? nil : value.to_s)
+      end
+    end
+
+    # Creates a new instance of the Version class using information in the passed
+    # Hash to construct the version number.
+    #
+    #   Version.new(:major => 1, :minor => 0) #=> "1.0"
+    def initialize(args = nil)
+      if args && args.is_a?(Hash)
+        args.keys.reject {|key| key.is_a?(Symbol) }.each {|key| args[key.to_sym] = args.delete(key) }
+
+        [:major, :minor].each do |param|
+          raise ArgumentError.new("The #{param.to_s} parameter is required") if args[param].blank?
+        end
+
+        @major      = args[:major].to_s
+        @minor      = args[:minor].to_s
+        @patch      = args[:patch].to_s     unless args[:patch].blank?
+        @milestone  = args[:milestone].to_s unless args[:milestone].blank?
+        @build      = args[:build].to_s     unless args[:build].blank?
+        @branch     = args[:branch].to_s    unless args[:branch].blank?
+        @committer  = args[:committer].to_s unless args[:committer].blank?
+        @format     = args[:format].to_s    unless args[:format].blank?
+
+        unless args[:build_date].blank?
+          b_date = case args[:build_date]
+               when 'git-revdate'
+                 get_revdate_from_git
+               else
+                 args[:build_date].to_s
+               end
+          @build_date = Date.parse(b_date)
+        end
+
+        @build = case args[:build]
+                 when 'svn'
+                   get_build_from_subversion
+                 when 'git-revcount'
+                   get_revcount_from_git
+                 when 'git-hash'
+                   get_hash_from_git
+                 when nil, ''
+                   nil
+                 else
+                   args[:build].to_s
+                 end
+      end
+    end
+
+    # Parses a version string to create an instance of the Version class.
+    def self.parse(version)
+      m = version.match(/(\d+)\.(\d+)(?:\.(\d+))?(?:\sM(\d+))?(?:\s\((\d+)\))?(?:\sof\s(\w+))?(?:\sby\s(\w+))?(?:\son\s(\S+))?/)
+
+      raise ArgumentError.new("The version '#{version}' is unparsable") if m.nil?
+
+      version = App::Version.new :major     => m[1],
+                               :minor     => m[2],
+                               :patch     => m[3],
+                               :milestone => m[4],
+                               :build     => m[5],
+                               :branch    => m[6],
+                               :committer => m[7]
+
+      if (m[8] && m[8] != '')
+        date = Date.parse(m[8])
+        version.build_date = date
+      end
+
+      return version
+    end
+
+    # Loads the version information from a YAML file.
+    def self.load(path)
+      App::Version.new YAML::load(File.open(path))
+    end
+
+    def <=>(other)
+      # if !self.build.nil? && !other.build.nil?
+      #   return self.build <=> other.build
+      # end
+
+      %w(build major minor patch milestone branch committer build_date).each do |meth|
+        rhs = self.send(meth) || -1
+        lhs = other.send(meth) || -1
+
+        ret = lhs <=> rhs
+        return ret unless ret == 0
+      end
+
+      return 0
+    end
+
+    def to_s
+      if @format
+        str = eval(@format.to_s.inspect)
+      else
+        str = "#{major}.#{minor}"
+        str << ".#{patch}" unless patch.blank?
+        str << " M#{milestone}" unless milestone.blank?
+        str << " (#{build})" unless build.blank?
+        str << " of #{branch}" unless branch.blank?
+        str << " by #{committer}" unless committer.blank?
+        str << " on #{build_date}" unless build_date.blank?
+      end
+      str
+    end
+
+  private
+
+    def get_build_from_subversion
+      if File.exists?(".svn")
+        #YAML.parse(`svn info`)['Revision'].value
+        match = /(?:\d+:)?(\d+)M?S?/.match(`svnversion . -c`)
+        match && match[1]
+      end
+    end
+
+    def get_revcount_from_git
+      if File.exists?(".git")
+        `git rev-list --count HEAD`.strip
+      end
+    end
+  
+    def get_revdate_from_git
+      if File.exists?(".git")
+        `git show --date=short --pretty=format:%cd|head -n1`.strip
+      end
+    end
+  
+    def get_hash_from_git
+      if File.exists?(".git")
+        `git show --pretty=format:%H|head -n1|cut -c 1-6`.strip
+      end
+    end
+  end
+end

data/lib/app_version/railtie.rb

@@ -0,0 +1,12 @@
+require 'app_version/app_version'
+require 'rails'   
+
+module AppVersion
+  class Railtie < Rails::Railtie
+    railtie_name :app_version
+
+    rake_tasks do
+      load "tasks/app_version_tasks.rake"
+    end
+  end
+end

data/lib/app_version/templates/version.yml

@@ -0,0 +1,21 @@
+# This is your version information.
+#
+# This is a simple plugin that makes it easy to manage the version number of your
+# Rails application. The version numbers supported by this plugin look like
+# '2.0.1 M4 (600) of branch by coder on 2008-10-27'.
+#
+# The components that produced the example about would be:
+#
+# major:        2
+# minor:        0
+# patch:        1
+# milestone:    M4
+# build:        600
+# branch:       branch
+# committer:    coder
+# build_date:   2008-10-27
+#
+# major and minor are required. All others are optional - See readme in the app_version plugin
+
+major:        1
+minor:        0

data/lib/app_version/templates/version.yml.erb

@@ -0,0 +1,20 @@
+# this version.yml was generated by app_version plugin
+# during a capistrano deployment.
+# please do not edit this file if it is in the config directory.
+# instead edit the file application/lib/templates/version.yml.erb
+
+major:        1
+minor:        0
+# patch:      1
+# milestone:  4
+build:      <%= `git rev-list HEAD|wc -l`.strip %>
+<%#branch:     <%# branch %>
+committer:  <%= `git show -s --pretty=format:"%an"` %>
+build_date: <%= Date.today.to_s %>
+
+<%# nifty tricks (note these examples are commented out in erb syntax, to use them replace the # with =)        -%>
+<%#  `git rev-list HEAD|wc -l`.strip      => will insert the count of commits to the repository (git)           -%>
+<%#  `git show -s --pretty=format:"%an"`  => will insert the name of the author of the last commit (git)        -%>
+<%#                                             many more options are available - see git show.                 -%>
+<%#  Date.today.to_s                      => will insert today's date - formatted yyyy-mm-dd                    -%>
+<%#  branch                               => will insert the branch variable used in capistrano                 -%>

data/lib/install.rb

@@ -0,0 +1,14 @@
+# copy the version.yml.erb to some user editable location for example, in lib
+
+targetTemplateDir = File.join(Rails.root.to_s, 'lib/templates')
+sourceTemplateFile = File.join(File.dirname(__FILE__), 'lib/templates/version.yml.erb')
+
+sourceSampleFile = File.join(File.dirname(__FILE__), 'lib/templates/version.yml')
+targetSampleDir = File.join(Rails.root.to_s, '/config')
+
+FileUtils.mkdir( targetTemplateDir, :verbose => true) unless File.exists?(targetTemplateDir)
+FileUtils.cp( sourceTemplateFile, targetTemplateDir,:verbose => true)
+FileUtils.cp( sourceSampleFile, targetSampleDir, :verbose => true )
+
+# Show the README text file
+# puts IO.read(File.join(File.dirname(__FILE__), 'README'))

data/lib/tasks/app_version_tasks.rake

@@ -0,0 +1,26 @@
+namespace :app do
+  require 'erb'
+
+  desc 'Report the application version.'
+  task :version do
+    require File.join(File.dirname(__FILE__), "../app_version.rb")
+    puts "Application version: " << App::Version.load("#{Rails.root.to_s}/config/version.yml").to_s
+  end
+
+  desc 'Configure for initial install.'
+  task :install do
+    require File.join(File.dirname(__FILE__), "../../install.rb")
+  end
+
+  desc 'Clean up prior to removal.'
+  task :uninstall do
+    require File.join(File.dirname(__FILE__), "../../uninstall.rb")
+  end
+
+  desc 'Render the version.yml from its template.'
+  task :render do
+    template = File.read(Rails.root.to_s+ "/lib/templates/version.yml.erb")
+    result   = ERB.new(template).result(binding)
+    File.open(Rails.root.to_s+ "/config/version.yml", 'w') { |f| f.write(result)}
+  end
+end

data/lib/uninstall.rb

@@ -0,0 +1,11 @@
+targetTemplateDir = File.join(RAILS_ROOT, 'lib/templates')
+
+targetTemplateFile = File.join(RAILS_ROOT, 'lib/templates/version.yml.erb')
+targetConfigSampleFile = File.join(RAILS_ROOT, '/config/version.yml')
+targetTemplateSampleFile = File.join(RAILS_ROOT, 'lib/templates/version.yml')
+
+if File.exist?(targetTemplateFile)          then FileUtils.rm( targetTemplateFile, :verbose => true) end
+if File.exist?(targetConfigSampleFile)      then FileUtils.rm( targetConfigSampleFile, :verbose => true) end
+if File.exist?(targetTemplateSampleFile)    then FileUtils.rm( targetTemplateSampleFile, :verbose => true) end
+
+if Dir.entries( targetTemplateDir ).entries.length == 2 then FileUtils.rmdir( targetTemplateDir, :verbose => true ) end

data/test/app_version_test.rb

@@ -0,0 +1,275 @@
+require 'test/unit'
+require 'active_support'
+require 'app_version'
+
+class AppVersionTest < Test::Unit::TestCase
+
+  def setup
+    @version = App::Version.new
+    @version.major = '1'
+    @version.minor = '2'
+    @version.patch = '3'
+    @version.milestone = '4'
+    @version.build = '500'
+    @version.branch = 'master'
+    @version.committer = 'coder'
+    @version.build_date = Date.civil(2008, 10, 27)
+  end
+
+  def test_load_from_file
+    version = App::Version.load 'test/version.yml'
+    assert_equal @version, version
+  end
+
+  def test_create_from_string
+    version = App::Version.parse '1.2.3 M4 (500) of master by coder on 2008-10-27'
+    assert_equal @version, version
+
+    version = App::Version.parse '1.2.3 M4 (500)'
+    @version.branch = nil
+    @version.committer = nil
+    @version.build_date = nil
+    assert_equal @version, version
+
+    version = App::Version.parse '1.2.3 (500)'
+    @version.milestone = nil
+    @version.branch = nil
+    @version.committer = nil
+    @version.build_date = nil
+    assert_equal @version, version
+
+    version = App::Version.parse '1.2 (500)'
+    @version.patch = nil
+    @version.branch = nil
+    @version.committer = nil
+    @version.build_date = nil
+    assert_equal @version, version
+
+    version = App::Version.parse '1.2'
+    @version.milestone = nil
+    @version.build = nil
+    @version.branch = nil
+    @version.committer = nil
+    @version.build_date = nil
+    assert_equal @version, version
+
+    version = App::Version.parse '1.2.1'
+    @version.patch = 1
+    @version.branch = nil
+    @version.committer = nil
+    @version.build_date = nil
+    assert_equal @version, version
+
+    version = App::Version.parse '2007.200.10 M9 (6) of branch by coder on 2008-10-27'
+    @version.major = 2007
+    @version.minor = 200
+    @version.patch = 10
+    @version.milestone = 9
+    @version.build = 6
+    @version.branch = 'branch'
+    @version.committer = 'coder'
+    @version.build_date = Date.civil(2008, 10, 31)
+    assert_raises(ArgumentError) { App::Version.parse 'This is not a valid version' }
+  end
+
+  def test_create_from_int_hash_with_symbol_keys
+    version = App::Version.new  :major => 1,
+                              :minor => 2,
+                              :patch => 3,
+                              :milestone => 4,
+                              :build => 500,
+                              :branch => 'master',
+                              :committer => 'coder',
+                              :build_date => Date.civil(2008, 10, 27)
+    assert_equal @version, version
+  end
+
+  def test_create_from_int_hash_with_string_keys
+    version = App::Version.new  'major' => 1,
+                              'minor' => 2,
+                              'patch' => 3,
+                              'milestone' => 4,
+                              'build' => 500,
+                              'branch' => 'master',
+                              'committer' => 'coder',
+                              'build_date' => '2008-10-27'
+    assert_equal @version, version
+  end
+
+  def test_create_from_string_hash_with_symbol_keys
+    version = App::Version.new  :major => '1',
+                              :minor => '2',
+                              :patch => '3',
+                              :milestone => '4',
+                              :build => '500',
+                              :branch => 'master',
+                              :committer => 'coder',
+                              :build_date => '2008-10-27'
+    assert_equal @version, version
+  end
+
+  def test_create_from_string_hash_with_string_keys
+    version = App::Version.new  'major' => '1',
+                              'minor' => '2',
+                              'patch' => '3',
+                              'milestone' => '4',
+                              'build' => '500',
+                              'branch' => 'master',
+                              'committer' => 'coder',
+                              'build_date' => '2008-10-27'
+    assert_equal @version, version
+  end
+
+  def test_create_from_hash_with_invalid_date
+    # note - Date.parse will make heroic efforts to understand the date text.
+    version = App::Version.new  :major => '1',
+                              :minor => '2',
+                              :patch => '3',
+                              :milestone => '4',
+                              :build => '500',
+                              :branch => 'master',
+                              :committer => 'coder',
+                              :build_date => '12wtf34'
+    assert_not_equal @version, version
+  end
+
+  def test_should_raise_when_major_is_missing
+    assert_raises(ArgumentError) {
+      App::Version.new :minor => 2, :milestone => 3, :build => 400
+    }
+  end
+
+  def test_should_raise_when_minor_is_missing
+    assert_raises(ArgumentError) {
+      App::Version.new :major => 1, :milestone => 3, :build => 400
+    }
+  end
+
+  def test_create_without_optional_parameters
+    version = App::Version.new :major => 1, :minor => 2
+
+    @version.patch = nil
+    @version.milestone = nil
+    @version.build = nil
+    @version.branch = nil
+    @version.committer = nil
+    @version.build_date = nil
+    assert_equal @version, version
+  end
+
+  def test_create_with_0
+    version = App::Version.new  :major => 1,
+                              :minor => 2,
+                              :patch => 0,
+                              :milestone => 0,
+                              :build => 100
+
+    assert_equal '0', version.patch
+    assert_equal '0', version.milestone
+  end
+
+  def test_create_with_nil
+    version = App::Version.new  :major => 1,
+                              :minor => 2,
+                              :patch => nil,
+                              :milestone => nil,
+                              :build => 100,
+                              :branch => nil,
+                              :committer => nil,
+                              :build_date => nil
+
+    assert_equal nil, version.patch
+    assert_equal nil, version.milestone
+    assert_equal nil, version.branch
+    assert_equal nil, version.committer
+    assert_equal nil, version.build_date
+  end
+
+  def test_create_with_empty_string
+    version = App::Version.new  :major => 1,
+                              :minor => 2,
+                              :patch => '',
+                              :milestone => '',
+                              :build => 100,
+                              :branch => '',
+                              :committer => '',
+                              :build_date => ''
+
+    assert_equal nil, version.patch
+    assert_equal nil, version.milestone
+    assert_equal nil, version.branch
+    assert_equal nil, version.committer
+    assert_equal nil, version.build_date
+  end
+
+  def test_to_s
+    assert_equal '1.2.3 M4 (500) of master by coder on 2008-10-27', @version.to_s
+  end
+
+  def test_to_s_with_no_milestone
+    @version.milestone = nil
+    assert_equal '1.2.3 (500) of master by coder on 2008-10-27', @version.to_s
+  end
+
+  def test_to_s_with_no_build
+    @version.build = nil
+    assert_equal '1.2.3 M4 of master by coder on 2008-10-27', @version.to_s
+  end
+
+  def test_to_s_with_no_patch
+    @version.patch = nil
+    assert_equal '1.2 M4 (500) of master by coder on 2008-10-27', @version.to_s
+  end
+
+  def test_to_s_with_no_build_or_milestone
+    @version.milestone = nil
+    @version.build = nil
+    assert_equal '1.2.3 of master by coder on 2008-10-27', @version.to_s
+  end
+
+  def test_to_s_with_no_branch
+    @version.branch = nil
+    assert_equal '1.2.3 M4 (500) by coder on 2008-10-27', @version.to_s
+  end
+
+  def test_to_s_with_no_committer
+    @version.committer = nil
+    assert_equal '1.2.3 M4 (500) of master on 2008-10-27', @version.to_s
+  end
+
+  def test_to_s_with_no_build_date
+    @version.build_date = nil
+    assert_equal '1.2.3 M4 (500) of master by coder', @version.to_s
+  end
+
+  def test_to_s_with_no_branch_or_committer
+    @version.branch = nil
+    @version.committer = nil
+    assert_equal '1.2.3 M4 (500) on 2008-10-27', @version.to_s
+  end
+
+  def test_to_s_with_no_committer_or_build_date
+    @version.committer = nil
+    @version.build_date = nil
+    assert_equal '1.2.3 M4 (500) of master', @version.to_s
+  end
+
+  def test_to_s_with_no_build_date_or_committer_or_build_date
+    @version.branch = nil
+    @version.committer = nil
+    @version.build_date = nil
+    assert_equal '1.2.3 M4 (500)', @version.to_s
+  end
+
+  def test_version_with_leading_zeros
+    version = App::Version.new :major => '2010', :minor => '04'
+    assert_equal '04', version.minor
+    assert_equal '2010.04', version.to_s
+  end
+
+  def test_version_with_alpha_characters
+    version = App::Version.new :major => '2010', :minor => '4a'
+    assert_equal '4a', version.minor
+    assert_equal '2010.4a', version.to_s
+  end
+end

data/test/version.yml

@@ -0,0 +1,9 @@
+## Application version
+major:      1
+minor:      2
+patch:      3
+milestone:  4
+build:      500
+branch:     master
+committer:  coder
+build_date: 2008-10-27

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: app_version
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Stephen Kapp
+- Phillip Toland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+description: App Version Gem originally App Version Rails Plugin from https://github.com/toland/app_version
+email:
+- mort666@virus.org
+- phil.toland@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/app_version/app_version.rb
+- lib/app_version/railtie.rb
+- lib/app_version/templates/version.yml
+- lib/app_version/templates/version.yml.erb
+- lib/app_version.rb
+- lib/install.rb
+- lib/tasks/app_version_tasks.rake
+- lib/uninstall.rb
+- Rakefile
+- README.rdoc
+- test/app_version_test.rb
+- test/version.yml
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: APP Version Gem
+test_files:
+- test/app_version_test.rb
+- test/version.yml