app_version 0.1.11 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8a3627e88d2e9c6afa001fa2948a7cb2201efaa
-  data.tar.gz: 36fd04c5ec9f91adf8765d81f173c7562b28a9cf
+  metadata.gz: 7148181a3d6ae3e29934a56410a929dba01da205
+  data.tar.gz: e26f0e0cbaffa146e34ae7cf0c249f52103b6039
 SHA512:
-  metadata.gz: 1aaefcd51024da2c581a2447697b1032ec407b5569785f4643ea5b35ab9c8a9bf7da16a3eefd86dfd3bd9c6b13ee71c96e0cc6e5ca35091a0fea0f71382c3bd6
-  data.tar.gz: 3cf78c28951ce2d6bcf781a9f1bf7c6d7c2bf4e6a9e765c817c8afce11bc751288602a27864ff778f041335926dfcf503e43090df4cb218918169b1629dcd735
+  metadata.gz: bfbdaf8c11a5a31710c78ba142a76f2b89a68f2d44c1db2d2af5e4bc3eaf9ae4803f6f4344d2e6bd71a0899a4db102601848f425b1e6a5f69bbaee959366eb15
+  data.tar.gz: b184e039160439924996c83b504aea7920fa861cf7abe2d11ede5186ba8ed1ce4d8e7d810a4dfaf9f326ca5430d9bcb606b70409a6f4aeafe131c88eb36134a6

data/README.md

@@ -35,7 +35,7 @@ To include the version information into your running application create an initi
 This will load a constant called APP_VERSION That includes the version information. This can then be rendered within the application using
 
 	APP_VERSION.to_s
-	
+
 Use this within your application view or helper methods, more detail on other version meta data in the usage section.
 
 ### Usage
@@ -59,7 +59,7 @@ If you use the special string it will query the source control system and output
 
 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. 
+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`, `meta`, `milestone`, `build`,`branch`, `committer`, and `build_date` methods to retrieve the individual components of the version number.
 

data/Rakefile

@@ -7,6 +7,7 @@ task :default => :test
 
 desc 'Test the app_version plugin.'
 Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
   t.libs << 'lib'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true

data/lib/app_version.rb

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

data/lib/app_version/app_version.rb

@@ -1,12 +1,30 @@
-require 'active_support/core_ext/object'  
+require 'active_support/core_ext/object'
 
 require 'yaml'
 
+#
+# App::Version Namespace
+#
 module App
+  #
+  # Application Version main class
+  #
+  # @attr [String] major Major Version number
+  # @attr [String] minor Minor Version number
+  # @attr [String] patch Patch number
+  # @attr [String] milestone Milestone information
+  # @attr [String] build Build number
+  # @attr [String] branch Git Branch information
+  # @attr [String] meta Semantic version meta info
+  # @attr [String] commiter Git Commiter information
+  # @attr [String] build_date Build Date
+  # @attr [String] format Format information
+  #
   class Version
     include Comparable
 
-    attr_accessor :major, :minor, :patch, :milestone, :build, :branch, :meta, :committer, :build_date, :format
+    attr_accessor :major, :minor, :patch, :milestone, :build
+    attr_accessor :branch, :meta, :committer, :build_date, :format
 
     [:major, :minor, :patch, :milestone, :build, :branch, :committer, :meta, :format].each do |attr|
       define_method "#{attr}=".to_sym do |value|
@@ -20,10 +38,10 @@ module App
     #   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) }
+        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?
+          fail ArgumentError.new("The #{param} parameter is required") if args[param].blank?
         end
 
         @major      = args[:major].to_s
@@ -38,11 +56,11 @@ module App
 
         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
+                   when 'git-revdate'
+                     get_revdate_from_git
+                   else
+                     args[:build_date].to_s
+                   end
           @build_date = Date.parse(b_date)
         end
 
@@ -62,49 +80,66 @@ module App
     end
 
     # Parses a version string to create an instance of the Version class.
+    #
+    # @param version [String] Version Number String to parse and initialize object with
+    # @raise [ArguementError] In the event string not parsable
+    # @return [App:Version] Returns populated Version object
     def self.parse(version)
       m = version.match(/(\d+)\.(\d+)(?:\.(\d+))?(?:-([\w.\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?
+      fail ArgumentError.new("The version '#{version}' is unparsable") if m.nil?
 
-      version = App::Version.new :major     => m[1],
-                               :minor     => m[2],
-                               :patch     => m[3],
-                               :meta      => m[4],
-                               :milestone => m[5],
-                               :build     => m[6],
-                               :branch    => m[7],
-                               :committer => m[8]
+      version = App::Version.new major: m[1],
+                                 minor: m[2],
+                                 patch: m[3],
+                                 meta: m[4],
+                                 milestone: m[5],
+                                 build: m[6],
+                                 branch: m[7],
+                                 committer: m[8]
 
-      if (m[9] && m[9] != '')
+      if m[9] && m[9] != ''
         date = Date.parse(m[9])
         version.build_date = date
       end
 
-      return version
+      version
     end
 
     # Loads the version information from a YAML file.
+    #
+    # @param path [String] Yaml file name to load
     def self.load(path)
-      App::Version.new YAML::load(File.open(path))
+      App::Version.new YAML.load(File.open(path))
     end
 
+    #
+    # Combined Compare operator for version
+    #
+    # @param other [App::Version] Version object to compare against
+    # @return [Integer] returns -1 if (a <=> b)
+    #
     def <=>(other)
       # if !self.build.nil? && !other.build.nil?
       #   return self.build <=> other.build
       # end
 
       %w(build major minor patch milestone branch meta committer build_date).each do |meth|
-        rhs = self.send(meth) || -1
+        rhs = send(meth) || -1
         lhs = other.send(meth) || -1
 
         ret = lhs <=> rhs
         return ret unless ret == 0
       end
 
-      return 0
+      0
     end
 
+    #
+    # Generate version string
+    #
+    # @return [String] Returns App Version string
+    #
     def to_s
       if @format
         str = eval(@format.to_s.inspect)
@@ -121,30 +156,28 @@ module App
       str
     end
 
-  private
+    private
 
     def get_build_from_subversion
-      if File.exists?(".svn")
-        #YAML.parse(`svn info`)['Revision'].value
+      if File.exist?('.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
+      `git rev-list --count HEAD`.strip if File.exist?('.git')
     end
-  
+
     def get_revdate_from_git
-      if File.exists?(".git")
+      if File.exist?('.git')
         `git show --date=short --pretty=format:%cd|head -n1`.strip
       end
     end
-  
+
     def get_hash_from_git
-      if File.exists?(".git")
+      if File.exist?('.git')
         `git show --pretty=format:%H|head -n1|cut -c 1-6`.strip
       end
     end

data/lib/app_version/railtie.rb

@@ -1,7 +1,13 @@
 require 'app_version/app_version'
-require 'rails'   
+require 'rails'
 
+#
+# Add App::Version Rake tasks
+#
 module AppVersion
+  #
+  # Add App::Version Rake tasks
+  # 
   class Railtie < Rails::Railtie
     railtie_name :app_version
 
@@ -9,4 +15,4 @@ module AppVersion
       load "tasks/app_version_tasks.rake"
     end
   end
-end
+end

data/test/app_version_test.rb

@@ -1,8 +1,6 @@
-require 'minitest/autorun'
-require 'active_support'
-require 'app_version'
+require 'test_helper'
 
-class AppVersionTest < MiniTest::Unit::TestCase
+class AppVersionTest < MiniTest::Test
 
   def setup
     @version = App::Version.new

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'minitest/autorun'
+require 'active_support'
+require 'app_version'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_version
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.13
 platform: ruby
 authors:
 - Stephen Kapp
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-26 00:00:00.000000000 Z
+date: 2016-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,16 +17,16 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.5
+        version: 4.2.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.5
+        version: 4.2.5.2
 description: App Version Gem originally App Version Rails Plugin from https://github.com/toland/app_version,
-  updated to work within Rails 3.2+ and Rails 4.x as a gem.
+  updated to run with later rails versions as a gem, currently supports Rails 4.2.x.
 email:
 - mort666@virus.org
 - phil.toland@gmail.com
@@ -45,6 +45,7 @@ files:
 - lib/tasks/app_version_tasks.rake
 - lib/uninstall.rb
 - test/app_version_test.rb
+- test/test_helper.rb
 - test/version.yml
 homepage: https://github.com/mort666/app_version
 licenses: []
@@ -65,11 +66,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Rails App Version Gem
 test_files:
 - test/app_version_test.rb
+- test/test_helper.rb
 - test/version.yml
-has_rdoc: