version_info 0.2.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in version_info.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    version_info (0.2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    notifier (0.1.1)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    test_notifier (0.3.6)
+      notifier
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  test_notifier
+  version_info!

data/README.md

@@ -0,0 +1,48 @@
+## Usage:
+
+
+Include VersionInfo in your main project module (or class):
+
+    require 'version_info'
+
+    module MyProject
+      include VersionInfo
+
+    end
+
+Create a file to store your version data. By default the file is named version_info.yml:
+
+    --- 
+    major: 0
+    minor: 1
+    patch: 0
+    author: jcangas
+
+
+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:
+
+    module VersionInfo
+
+      def self.segments
+        [:major, :minor, :patch, :state, :build]
+      end
+
+      ...
+    end
+
+Usingh the previous version_info.yml:
+
+    puts MyProject::VERSION.tag
+
+    => 0.1.0
+
+Also you can bump any segment. With the same sample:
+
+    MyProject::VERSION.bump(:major)
+    puts MyProject::VERSION.tag
+
+    => 1.0.0
+
+Note the other segments are reset to 0 after bump.
+    

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/lib/version_info/data.rb

@@ -0,0 +1,60 @@
+require 'ostruct'
+module VersionInfo
+  class Data < OpenStruct
+    attr_accessor :file_name	
+
+    def initialize
+      super
+      if File.exist?(file_name)
+        load
+      else
+        marshal_load(get_defaults)
+      end
+    end
+
+    def file_name
+      @file_name ||= 'version_info.yml'
+    end
+
+    def bump(key)
+      idx = VersionInfo.segments.index(key.to_sym) + 1
+      return unless idx
+      VersionInfo.segments[idx..-1].each do |sgm| 
+	      send("#{sgm}=", 0) if send(sgm)
+      end
+      send("#{key}=", 1 + send(key))
+    end
+    
+    def load
+      load_from(File.read(file_name))
+	    self
+    end
+
+    def save      
+	    File.open( file_name, 'w' ) {|out| save_to(out)}
+	    self
+    end
+
+    def tag
+	    VersionInfo.segments.map { |k| send(k) }.compact.join('.')
+    end
+
+  protected
+    def get_defaults
+      VersionInfo.segments[0..2].inject({}){|h, k| h[k] = 0; h}
+    end
+   
+    def load_from(io)
+      values = YAML.load(io)
+	    values.keys.each{|k, v| values[k.to_sym] = values.delete(k)}
+      marshal_load(values)
+      self
+    end
+
+    def save_to(io)
+	    values = self.marshal_dump.keys.compact.inject({}){|r, k| r[k.to_s] = send(k); r }
+      YAML.dump(values, io )
+	    self      
+    end
+  end
+end

data/lib/version_info/tasks.rb

@@ -0,0 +1,18 @@
+module VersionInfo
+  class Tasks
+    def self.install(opts = nil)
+      dir = caller.find{|c| /Rakefile:/}[/^(.*?)\/Rakefile:/, 1]
+      self.new(dir, opts && opts[:name]).install
+    end
+    
+    def install
+      namespace :vinfo do
+        desc "bump SEGMENT , Bumps a version info segment ('major','minor','patch','state','build')"
+        task 'bump' do
+          puts "Wow!"
+        end
+      end
+    end
+
+  end
+end

data/lib/version_info/version.rb

@@ -0,0 +1,3 @@
+module VersionInfo
+  VERSION = "0.2.0"
+end

data/lib/version_info.rb

@@ -0,0 +1,17 @@
+require 'version_info/data'
+
+module VersionInfo
+
+  autoload :Tasks, 'version_info/tasks'
+
+  def self.segments
+    [:major, :minor, :patch, :state, :build]
+  end
+   
+  def self.included(other)         
+    other.const_set('VERSION', Data.new)
+  end
+
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'test_notifier/runner/rspec'
+require 'version_info'
+

data/spec/version_info/test_file.rb

@@ -0,0 +1,7 @@
+require 'version_info'
+
+module TestFile
+  include VersionInfo
+
+end
+

data/spec/version_info/version_info_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+require 'version_info/test_file'
+
+describe "VersionInfo" do
+  before :each do
+    module TestFile
+      include VersionInfo # force new VERSION data
+    end
+  end
+
+  it "is initalized" do
+    TestFile::VERSION.marshal_dump.should == {:major => 0, :minor => 0, :patch => 0 }
+  end
+
+  it "has default filename" do
+    TestFile::VERSION.file_name.should == 'version_info.yml'
+  end
+
+  it "can assign filename" do
+    TestFile::VERSION.file_name = 'test_file.vinfo'
+    TestFile::VERSION.file_name.should == 'test_file.vinfo'
+  end
+
+  it "has a minor property" do
+    TestFile::VERSION.minor.should == 0
+  end
+
+  it "has a tag property" do
+    TestFile::VERSION.tag.should == '0.0.0'    
+  end
+
+  it "can bump a segment" do
+    TestFile::VERSION.bump(:patch)
+    TestFile::VERSION.tag.should == '0.0.1'    
+  end
+
+  it "bump a segment reset sublevels " do
+    TestFile::VERSION.bump(:patch)
+    TestFile::VERSION.bump(:minor)
+    TestFile::VERSION.tag.should == '0.1.0'   
+  end
+
+  it "can save " do
+    io = StringIO.new
+    File.stub!(:open).and_yield(io)
+    TestFile::VERSION.bump(:minor)
+    TestFile::VERSION.save
+    io.string.should == "--- \nmajor: 0\nminor: 1\npatch: 0\n"
+  end
+
+  it "can save custom data " do
+    io = StringIO.new
+    File.stub!(:open).and_yield(io)
+    TestFile::VERSION.bump(:minor)
+    TestFile::VERSION.author = 'jcangas'
+    TestFile::VERSION.save
+    io.string.should == "--- \nmajor: 0\nminor: 1\npatch: 0\nauthor: jcangas\n"
+  end
+
+  it "can load " do
+    io = StringIO.new("--- \nmajor: 1\nminor: 2\npatch: 3\n")
+    File.should_receive(:read).and_return{io}
+    TestFile::VERSION.load
+    TestFile::VERSION.marshal_dump.should == {:major => 1, :minor => 2, :patch => 3 }  
+  end
+
+  it "can load custom data " do
+    io = StringIO.new("--- \nmajor: 1\nminor: 2\npatch: 3\nauthor: jcangas\n")
+    File.should_receive(:read).and_return{io}
+    TestFile::VERSION.load
+    TestFile::VERSION.marshal_dump.should == {:major => 1, :minor => 2, :patch => 3, :author => 'jcangas' }  
+  end
+
+end

data/version_info.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "version_info/version"
+
+Gem::Specification.new do |s|
+  s.name        = "version_info"
+  s.version     = VersionInfo::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jorge L. Cangas"]
+  s.email       = ["jorge.cangas@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/version_info"
+  s.summary     = %q{A Ruby gem to manage your project version data}
+  s.description = %q{Easy way to get version label, bump the segments (major, minor, patch), and you can include custom version data}
+
+  s.rubyforge_project = "version_info"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_development_dependency "rspec"  
+  s.add_development_dependency "test_notifier"  
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: version_info
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Jorge L. Cangas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-31 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  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
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+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
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- autotest/discover.rb
+- lib/version_info.rb
+- lib/version_info/data.rb
+- lib/version_info/tasks.rb
+- lib/version_info/version.rb
+- spec/spec_helper.rb
+- spec/version_info/test_file.rb
+- spec/version_info/version_info_spec.rb
+- version_info.gemspec
+has_rdoc: true
+homepage: http://rubygems.org/gems/version_info
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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
+signing_key: 
+specification_version: 3
+summary: A Ruby gem to manage your project version data
+test_files: []
+