version_info 1.0.0 → 1.1.0

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    version_info (0.7.1)
+    version_info (1.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
     diff-lcs (1.1.2)
     notifier (0.1.1)
+    rake (0.9.2)
     rspec (2.3.0)
       rspec-core (~> 2.3.0)
       rspec-expectations (~> 2.3.0)
@@ -23,6 +24,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  bundler
+  rake
   rspec
   test_notifier
   version_info!

data/README.md

@@ -2,12 +2,22 @@
 
 ### Overview
 
-  VersionIinfo is a powerful and very lightweight gem to manage version data in your Ruby projects or other gems.
+  VersionInfo is a powerful and very lightweight gem to manage version data in your Ruby projects or gems. Very user friendly thanks to rake / thor tasks
 
-  VersionIinfo can manage a serie of predefined segments to build your version tag with the tipical structure X.X.X.X.
-  Their values are stored in a yaml file, and supports custom values. 
+####  Features
+
+  * rake & thor tasks avaiables to yaml file creation, bump segments and show info
+
+  * can define custom segments to build your version tag with the tipical structure X.X.X.X.
+
+  * can use a custom tag format: do you want a tag like "1-3-1pre"?. No problem!.
+
+  * can include any custom info in your version data.
+
+  * Version data is stored in a yaml file.
+  
+  * good rspec tests
 
-  Also rake & thor tasks are avaiable to simplify yaml file creation and update.
 
   Feel free to contact me about bugs/features
 
@@ -21,9 +31,11 @@ Include VersionInfo in your main project module (or class):
       include VersionInfo
     end
 
-From here, is better to use the builtin rake/thor tasks (see it forward). Here is how VersionInfo works and their user options:
+From here, is better to use rake/thor tasks (see it forward). 
+
+Here is how VersionInfo works and their user options:
 
-After you included VersionIinfo, a new constant MyProject::VERSION is created holding an object of class VersionInfo::Data
+After you included VersionInfo, a new constant MyProject::VERSION is created holding an object of class VersionInfo::Data
 
 VersionInfo use yaml file to store version data:
 
@@ -39,21 +51,27 @@ when using Rake or Thor.
 Anyway, you can change this (recomended):
     module MyProject
       include VersionInfo
-      VERISION.file_name = '/path/to/my_file.yaml'      
+      VERSION.file_name = '/path/to/my_file.yaml'      
     end
 
-Note you can put any custom data. In order to get the version tag, VersionInfo reserve some special keys for use as the "segments" of the version tag. Here the source code:
+Note you can put any custom data. In order to get the version tag, VersionInfo define the segments of the version tag. Here the source code:
 
     module VersionInfo
 
+      # current segments or defaults
       def self.segments
-        [:major, :minor, :patch, :state, :build]
+        @segments ||= [:major, :minor, :patch] 
+      end
+
+      # define segments
+      def self.segments=(values)
+        @segments = values
       end
 
       ...
     end
 
-Usingh the previous version_info.yml:
+Using the previous version_info.yml:
 
     puts MyProject::VERSION.tag
 
@@ -66,13 +84,54 @@ Also you can bump any segment. With the same sample:
 
     => 1.0.0
 
-Note the other (lower weight) segments are reset to 0 after bump.
+Note other "lower weight" segments are reset to 0.
+
+### Bonus: Custom segments and tag format.
+
+  You can override the default segments
+
+    VersionInfo.segments = [:a, :b, :c]
+    module MyProject
+      include VersionInfo # force new VERSION value
+    end
+
+  Note this must be done **before** include VersionInfo.
+
+ Also, tag format can be redefined. VersionInfo uses simple
+sprintf in order to build the tag string. Here is the code:
+
+    def tag
+      tag_format % to_hash
+    end
+
+By default, tag_format, returns a simple sprintf format string,
+using the segment names, expecting their values are numbers:
+
+    def tag_format
+	    @tag_format ||= VersionInfo.segments.map { |k| "%<#{k}>d"}.join('.')
+    end
+
+So tag_format return some like "%<major>d.%<minor>d%<patch>d".
+
+If your VersionInfo yaml file is like:
+
+    --- 
+    major: 2
+    minor: 1
+    patch: 53
+    buildflag: pre
+
+You can change the tag format
+
+    MyProject::VERSION.buildflag = 'pre'
+    MyProject::VERSION.tag_format = MyProject::VERSION.tag_format + "--%<buildflag>s"
+    puts MyProject::VERSION.tag # => '2.1.53--pre'    
 
 ### Rake / Thor tasks
 
 Put in your rake file:
 
-    VersionInfo::RakeTasks.install(:class => MyProject) # use the thing where you included VersionInfo
+    VersionInfo::RakeTasks.install(:class => MyProject) # pass here the thing where you included VersionInfo
 
 And you get a few tasks with a namespace vinfo:
 
@@ -87,7 +146,7 @@ And you get a few tasks with a namespace vinfo:
 
 If you prefer Thor:
 
-    VersionInfo::ThorTasks.install(:class => MyProject) # use the thing where you included VersionInfo
+    VersionInfo::ThorTasks.install(:class => MyProject) # pass here the thing where you included VersionInfo
 
     thor list
     =>
@@ -100,7 +159,7 @@ If you prefer Thor:
 
 ### Install
 
- VersionInfo is [https://rubygems.org/gems/version_info](https://rubygems.org/gems/version_info) at so:
+ VersionInfo is at [https://rubygems.org/gems/version_info](https://rubygems.org/gems/version_info) :
 
     gem install version_info
 

data/lib/version_info/data.rb

@@ -9,7 +9,7 @@ module VersionInfo
       if File.exist?(file_name)
         load
       else
-        marshal_load(get_defaults)
+        reset
       end
     end
 
@@ -19,7 +19,11 @@ module VersionInfo
 
     def file_name=(value)
       @file_name = value
-      load  if File.exist?(@file_name)
+      load if File.exist?(@file_name)
+    end
+
+    def reset
+      marshal_load(get_defaults)
     end
 
     def bump(key)
@@ -44,9 +48,21 @@ module VersionInfo
     def to_s
       tag
     end
+    
+    def to_hash
+      marshal_dump
+    end
 
     def tag
-	    VersionInfo.segments.map { |k| send(k) }.compact.join('.')
+      tag_format % to_hash
+    end
+    
+    def tag_format
+	    @tag_format ||= VersionInfo.segments.map { |k| "%<#{k}>d"}.join('.')
+    end
+
+    def tag_format=(value)
+	    @tag_format = value
     end
 
   protected
@@ -56,7 +72,8 @@ module VersionInfo
    
     def load_from(io)
       values = YAML.load(io)
-	    values.keys.each{|k, v| values[k.to_sym] = values.delete(k)}
+      # force keys as symbols
+	    values.keys.each{|k| values[k.to_sym] = values.delete(k)}
       marshal_load(values)
       self
     end
@@ -66,15 +83,5 @@ module VersionInfo
       YAML.dump(values, io)
 	    self      
     end
-
-    def underscore(camel_cased_word)
-      word = camel_cased_word.to_s.dup
-      word.gsub!(/::/, '/')
-      word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-      word.tr!("-", "_")
-      word.downcase!
-      word
-    end
   end
 end

data/lib/version_info/rake_tasks.rb

@@ -1,5 +1,6 @@
 module VersionInfo 
   class RakeTasks
+    include Rake::DSL
     
     def self.install(opts = {})
       #dir = caller.find{|c| /Rakefile:/}[/^(.*?)\/Rakefile:/, 1]

data/lib/version_info/version_info.yml

@@ -1,4 +1,4 @@
 --- 
 major: 1
-minor: 0
+minor: 1
 patch: 0

data/lib/version_info.rb

@@ -2,13 +2,17 @@ require 'version_info/data'
 
 module VersionInfo
 
+  # current segments or defaults
   def self.segments
-    [:major, :minor, :patch]
+    @segments ||= [:major, :minor, :patch] 
+  end
+
+  # define segments
+  def self.segments=(values)
+    @segments = values
   end
    
   def self.included(other)
-    # data = Class.new(Data)
-    # other.const_set('Version', data)
     other.const_set('VERSION', Data.new)
   end
 

data/spec/version_info/version_info_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 require 'version_info/test_file'
 
-describe "VersionInfo" do
+describe "VersionInfo defaults" do
 
   before :each do
     module TestFile
@@ -13,7 +13,6 @@ describe "VersionInfo" do
   after :each do
     module TestFile
       remove_const :VERSION
-      # remove_const :Version
     end
   end    
 
@@ -38,6 +37,15 @@ describe "VersionInfo" do
     TestFile::VERSION.tag.should == '0.0.0'    
   end
 
+  it "tag has format" do
+    TestFile::VERSION.tag.should == '0.0.0'    
+  end
+  it "tag format can be changed" do
+    TestFile::VERSION.build_flag = 'pre'
+    TestFile::VERSION.tag_format = TestFile::VERSION.tag_format + "--%<build_flag>s"
+    TestFile::VERSION.tag.should == '0.0.0--pre'    
+  end
+
   it "can bump a segment" do
     TestFile::VERSION.bump(:patch)
     TestFile::VERSION.tag.should == '0.0.1'    
@@ -81,3 +89,32 @@ describe "VersionInfo" do
   end
 
 end
+
+describe "VersionInfo custom segments" do
+  before :each do
+    VersionInfo.segments = [:a, :b, :c]
+    module TestFile
+      include VersionInfo # force new VERSION value
+    end
+  end
+
+  after :each do
+    module TestFile
+      remove_const :VERSION
+    end
+  end    
+
+  it "can be assigned" do
+    TestFile::VERSION.marshal_dump.should == {:a => 0, :b => 0, :c => 0 }
+   end
+
+  it "segments are properties" do
+    TestFile::VERSION.a.should == 0
+   end
+
+  it "can bump a custom segment" do
+    TestFile::VERSION.bump(:c)
+    TestFile::VERSION.bump(:b)
+    TestFile::VERSION.tag.should == '0.1.0'    
+  end
+end

data/version_info.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   
+  s.add_development_dependency "bundler"  
+  s.add_development_dependency "rake"  
   s.add_development_dependency "rspec"  
   s.add_development_dependency "test_notifier"  
 end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: version_info
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors: 
 - Jorge L. Cangas
@@ -14,35 +10,52 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-07 00:00:00 +02:00
-default_executable: 
+date: 2011-07-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: bundler
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: test_notifier
+  name: rake
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: test_notifier
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: Easy way to get version label, bump the segments (major, minor, patch), and you can include custom version data
 email: 
 - jorge.cangas@gmail.com
@@ -70,7 +83,6 @@ files:
 - spec/version_info/test_file.rb
 - spec/version_info/version_info_spec.rb
 - version_info.gemspec
-has_rdoc: true
 homepage: http://github.com/jcangas/version_info
 licenses: []
 
@@ -84,21 +96,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: version_info
-rubygems_version: 1.3.7
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: A Ruby gem to manage your project version data. Rake tasks included!