rake-version 0.0.0 → 0.1.0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format doc

data/Gemfile

@@ -16,3 +16,7 @@ group :development do
   gem 'yard', '~> 0.7.5'
   gem 'rdiscount', '~> 1.6.8'
 end
+
+group :test do
+  gem 'active_support', '>= 2'
+end

data/Gemfile.lock

@@ -1,6 +1,9 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
     diff-lcs (1.1.3)
     git (1.2.5)
     jeweler (1.8.3)
@@ -33,6 +36,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  active_support (>= 2)
   bundler
   jeweler (~> 1.8.3)
   rake (~> 0.9.2)

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/lib/rake-version.rb

@@ -4,6 +4,27 @@ require 'rake/tasklib'
 module RakeVersion
   VERSION = File.open(File.join(File.dirname(__FILE__), '..', 'VERSION'), 'r').read
 
-  class Tasks < ::Rake::TaskLib
+  class Error < StandardError; end
+  class BadVersionString < Error; end
+  class MissingContext < Error; end
+  class BadArgument < Error; end
+  class BadContext < BadArgument; end
+  class BadVersion < BadArgument; end
+  class BadBumpType < BadArgument; end
+
+  def self.check_context o
+    self.check_type o, RakeVersion::Context, BadContext
+  end
+
+  def self.check_version o
+    self.check_type o, RakeVersion::Version, BadVersion
+  end
+
+  def self.check_type o, expected_type, error_class = Error, name = nil
+    name ||= expected_type.to_s.sub(/.*::/, '')
+    name = name.downcase
+    raise error_class, "Expected #{name} to be a #{expected_type}." unless o.kind_of? expected_type
   end
 end
+
+%w( context manager tasks version ).each{ |dep| require File.join(File.dirname(__FILE__), 'rake-version', dep) }

data/lib/rake-version/context.rb

@@ -0,0 +1,22 @@
+
+module RakeVersion
+
+  class Context
+  
+    def initialize task
+      @task = task
+    end
+
+    def root
+      File.expand_path @task.application.original_dir
+    end
+
+    def read file
+      File.open(file, 'r').read
+    end
+
+    def write file, contents
+      File.open(file, 'w'){ |f| f.write contents }
+    end
+  end
+end

data/lib/rake-version/manager.rb

@@ -0,0 +1,60 @@
+
+module RakeVersion
+
+  attr_accessor :namespace
+  attr_accessor :root
+  attr_accessor :version_filename
+
+  class Manager
+
+    def version
+      check_context
+      RakeVersion::Version.new.from_s read_version
+    end
+
+    def set version_string
+      check_context
+      save RakeVersion::Version.new.from_s(version_string)
+    end
+
+    def bump type
+      check_context
+      save version.bump(type)
+    end
+
+    def with_context context, &block
+      RakeVersion.check_context context
+      @context = context
+      yield self if block_given?
+      @context = nil
+      self
+    end
+
+    private
+
+    def check_context
+      raise MissingContext, "A context must be given with :with_context." unless @context
+    end
+
+    def save version
+      RakeVersion.check_version version
+      write_version version
+    end
+
+    def read_version
+      @context.read version_file
+    end
+
+    def write_version version
+      version.tap{ |v| @context.write version_file, version.to_s }
+    end
+
+    def version_file
+      File.join @context.root, version_filename
+    end
+
+    def version_filename
+      @version_filename || 'VERSION'
+    end
+  end
+end

data/lib/rake-version/tasks.rb

@@ -0,0 +1,50 @@
+
+module RakeVersion
+
+  class Tasks < ::Rake::TaskLib
+
+    def initialize &block
+      @manager = RakeVersion::Manager.new
+      yield @manager if block_given?
+      define
+    end
+
+    def define
+      desc 'Show the current version'
+      task :version do |t|
+        puts @manager.version.to_s
+      end
+
+      namespace :version do
+
+        desc 'Set the version (e.g. rake version:set[1.2.3])'
+        task :set, :value do |t, args|
+          puts @manager.set(args.value.to_s)
+        end
+
+        namespace :bump do
+
+          [ :major, :minor, :patch ].each do |type|
+            task type do |t|
+              puts @manager.bump(type).to_s
+            end
+          end
+        end
+      end
+    end
+
+    def task *args, &block
+      super *args do |t, args|
+        @manager.with_context context(t) do |m|
+          yield t, args if block_given?
+        end
+      end
+    end
+
+    private
+
+    def context task
+      RakeVersion::Context.new task
+    end
+  end
+end

data/lib/rake-version/version.rb

@@ -0,0 +1,59 @@
+
+module RakeVersion
+
+  class Version
+    REGEXP = /^(\d+)\.(\d+)\.(\d+)(?:\.(\d+))?((?:\-[A-Za-z0-9]+)*)$/
+
+    attr_reader :major
+    attr_reader :minor
+    attr_reader :patch
+    attr_reader :build
+    attr_reader :tags
+
+    def initialize
+      @major = 0
+      @minor = 0
+      @patch = 0
+      @build = nil
+      @tags = []
+      # TODO: create methods to list, add and remove tags
+    end
+
+    def bump type
+      case type
+      when :major
+        @major += 1
+        @minor = 0
+        @patch = 0
+      when :minor
+        @minor += 1
+        @patch = 0
+      when :patch
+        @patch += 1
+      else
+        raise BadBumpType, "Unknown version bump type #{type.inspect}. Expecting :major, :minor or :patch."
+      end
+      self
+    end
+
+    def from_s s
+      s.to_s.match(REGEXP).tap do |m|
+        raise BadVersionString, "Version '#{s}' expected to have format MAJOR.MINOR.PATCH(.BUILD)(-TAG)." if m.nil?
+        @major = m[1].to_i
+        @minor = m[2].to_i
+        @patch = m[3].to_i
+        @build = m[4] ? m[4].to_i : nil
+        @tags = m[5] ? m[5].sub(/^\-/, '').split('-') : []
+      end
+      self
+    end
+
+    def to_s
+      String.new.tap do |s|
+        s << "#{@major}.#{@minor}.#{@patch}"
+        s << ".#{@build}" if @build
+        s << tags.collect{ |tag| "-#{tag}" }.join('') unless tags.empty?
+      end
+    end
+  end
+end

data/rake-version.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "rake-version"
-  s.version = "0.0.0"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["AlphaHydrae"]
-  s.date = "2012-02-21"
+  s.date = "2012-02-24"
   s.description = "Rake tasks for version management."
   s.email = "hydrae.alpha@gmail.com"
   s.extra_rdoc_files = [
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    ".rspec",
     ".rvmrc",
     "Gemfile",
     "Gemfile.lock",
@@ -26,8 +27,16 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/rake-version.rb",
+    "lib/rake-version/context.rb",
+    "lib/rake-version/manager.rb",
+    "lib/rake-version/tasks.rb",
+    "lib/rake-version/version.rb",
     "rake-version.gemspec",
-    "spec/helper.rb"
+    "spec/context_spec.rb",
+    "spec/helper.rb",
+    "spec/manager_spec.rb",
+    "spec/tasks_spec.rb",
+    "spec/version_spec.rb"
   ]
   s.homepage = "http://github.com/AlphaHydrae/rake-version"
   s.licenses = ["MIT"]

data/spec/context_spec.rb

@@ -0,0 +1,50 @@
+require 'helper'
+
+describe RakeVersion::Context do
+  CONTEXT_SAMPLE_ROOT = '/tmp'
+
+  before :each do
+    
+    @application = double('application')
+    @application.stub(:original_dir){ CONTEXT_SAMPLE_ROOT }
+
+    @task = double('task')
+    @task.stub(:application){ @application }
+  end
+
+  it "should return the application directory for the given rake task" do
+    RakeVersion::Context.new(@task).root.should == CONTEXT_SAMPLE_ROOT
+  end
+
+  it "should successfully read file contents" do
+
+    filename = 'foo'
+    contents = 'bar'
+
+    File.stub(:open) do |file,mode|
+      if mode == 'r' and file == filename
+        double('file').tap{ |f| f.stub(:read){ contents } }
+      else
+        nil
+      end
+    end
+
+    RakeVersion::Context.new(@task).read(filename).should == contents
+  end
+
+  it "should ask File to write file contents" do
+
+    filename = 'foo'
+    contents = 'bar'
+
+    file = double('file')
+    file.stub(:write)
+
+    File.stub(:open) do |f,mode|
+      raise 'bug' unless f == filename and mode == 'w'
+    end.and_yield file
+
+    file.should_receive(:write).with(contents)
+    RakeVersion::Context.new(@task).write(filename, contents)
+  end
+end

data/spec/manager_spec.rb

@@ -0,0 +1,92 @@
+require 'helper'
+
+describe RakeVersion::Manager do
+  MANAGER_SAMPLE_ROOT = '/tmp'
+  MANAGER_SAMPLE_VERSION = '1.2.3.456-beta-custom'
+  MANAGER_VERSION_FILE = File.join MANAGER_SAMPLE_ROOT, 'VERSION'
+
+  before :each do
+    @manager = RakeVersion::Manager.new
+
+    @context = double('context')
+    @context.stub(:root){ MANAGER_SAMPLE_ROOT }
+    @context.stub(:read){ MANAGER_SAMPLE_VERSION }
+    @context.stub(:write){}
+    @context.stub(:kind_of?){ |type| type == RakeVersion::Context }
+
+    @version = double('version')
+    @version.stub(:to_s){ MANAGER_SAMPLE_VERSION }
+    @version.stub(:bump){ @version }
+    @version.stub(:kind_of?){ |type| type == RakeVersion::Version }
+  end
+
+  def with_context &block
+    @manager.with_context @context do |m|
+      yield m if block_given?
+    end
+  end
+
+  it "should return a version object" do
+    with_context do |m|
+      m.version.tap do |v|
+        v.should be_a_kind_of(RakeVersion::Version)
+        v.major.should == 1
+        v.minor.should == 2
+        v.patch.should == 3
+        v.build.should == 456
+        v.tags.should be_a_kind_of(Array)
+        v.tags.length.should == 2
+        v.tags[0].should == 'beta'
+        v.tags[1].should == 'custom'
+      end
+    end
+  end
+
+  it "should require a context for all operations" do
+    lambda{ @manager.version }.should raise_error(RakeVersion::MissingContext)
+    lambda{ @manager.set '1.2.3' }.should raise_error(RakeVersion::MissingContext)
+    lambda{ @manager.bump :minor }.should raise_error(RakeVersion::MissingContext)
+  end
+
+  it "should return the correct version" do
+    with_context{ |m| m.version.to_s.should == MANAGER_SAMPLE_VERSION }
+  end
+
+  it "should set the correct version" do
+    with_context{ |m| m.set('1.2.3').to_s.should == '1.2.3' }
+  end
+
+  it "should ask for the context root" do
+    @context.should_receive :root
+    with_context{ |m| m.version }
+  end
+
+  it "should ask the version to bump itself" do
+    @manager.stub(:version){ @version }
+    [ :major, :minor, :patch ].each do |type|
+      @version.should_receive(:bump).with(type)
+      with_context{ |m| m.bump type }
+    end
+  end
+
+  it "should ask the context to read the version file" do
+    @context.should_receive(:read).with(MANAGER_VERSION_FILE)
+    with_context{ |m| m.version }
+  end
+
+  it "should ask the context to write the version file when bumping the version" do
+    @context.should_receive(:write).with(MANAGER_VERSION_FILE, '1.3.0.456-beta-custom')
+    with_context{ |m| m.bump :minor }
+  end
+
+  it "should ask the context to write the version file when setting the version" do
+    @context.should_receive(:write).with(MANAGER_VERSION_FILE, MANAGER_SAMPLE_VERSION)
+    with_context{ |m| m.set MANAGER_SAMPLE_VERSION }
+  end
+
+  it "should only accept the right type of context" do
+    [ nil, true, false, 2, 'bad', :bad, [], {}, @version ].each do |invalid|
+      lambda{ @manager.with_context invalid }.should raise_error(RakeVersion::BadContext)
+    end
+  end
+end

data/spec/tasks_spec.rb

@@ -0,0 +1,56 @@
+require 'helper'
+require 'active_support/core_ext/kernel/reporting'
+
+describe RakeVersion::Tasks do
+  TASKS_SAMPLE_VERSION = '1.2.3'
+
+  before :each do
+
+    @version = double('version')
+    @version.stub(:to_s){ TASKS_SAMPLE_VERSION }
+
+    @manager = double('manager')
+    @manager.stub(:version){ @version }
+    @manager.stub(:set){ @version }
+    @manager.stub(:bump){ @version }
+    @manager.stub(:with_context).and_yield(@manager)
+
+    RakeVersion::Manager.stub(:new){ @manager }
+    RakeVersion::Tasks.new
+  end
+
+  after :each do
+    Rake::Task.clear
+  end
+
+  def silence &block
+    silence_stream(STDOUT) do
+      silence_stream(STDERR) do
+        yield if block_given?
+      end
+    end
+  end
+
+  it "should define all tasks" do
+    %w( version version:set version:bump:major version:bump:minor version:bump:patch ).each do |name|
+      Rake::Task[name].should be_a_kind_of(Rake::Task)
+    end
+  end
+
+  it "should ask the manager to return the current version" do
+    @manager.should_receive(:version)
+    silence{ Rake::Task['version'].execute }
+  end
+
+  it "should ask the manager to set the version" do
+    @manager.should_receive(:set).with(kind_of(String))
+    silence{ Rake::Task['version:set'].invoke TASKS_SAMPLE_VERSION }
+  end
+
+  [ :major, :minor, :patch ].each do |type|
+    it "should ask the manager to bump the #{type} version" do
+      @manager.should_receive(:bump).with(type)
+      silence{ Rake::Task["version:bump:#{type}"].execute }
+    end
+  end
+end

data/spec/version_spec.rb

@@ -0,0 +1,73 @@
+require 'helper'
+
+describe RakeVersion::Version do
+
+  it "should build a correct version object when initialized" do
+    RakeVersion::Version.new.tap do |v|
+      v.major.should == 0
+      v.minor.should == 0
+      v.patch.should == 0
+      v.build.should be_nil
+      v.tags.should be_a_kind_of(Array)
+      v.tags.length.should == 0
+    end
+  end
+
+  it "should build a correct version object when built from a string" do
+    RakeVersion::Version.new.from_s('1.2.3.456-beta-custom').tap do |v|
+      v.major.should == 1
+      v.minor.should == 2
+      v.patch.should == 3
+      v.build.should == 456
+      v.tags.should be_a_kind_of(Array)
+      v.tags.length.should == 2
+      v.tags[0].should == 'beta'
+      v.tags[1].should == 'custom'
+    end
+  end
+
+  it "should build the correct version string when built from a string" do
+    [ '1.2.3', '2.3.4.567', '3.4.5.678-beta', '5.6.7.890-beta-custom' ].each do |v|
+      RakeVersion::Version.new.from_s(v).to_s.should == v
+    end
+  end
+
+  it "should raise an error when built from invalid version strings" do
+    [ '1', '2.3', '4.5.6.7.8', 'asd', nil, true, false, [], {}, '' ].each do |invalid|
+      lambda{ RakeVersion::Version.new.from_s invalid }.should raise_error(RakeVersion::BadVersionString)
+    end
+  end
+
+  describe 'Bumping' do
+
+    before :each do
+      @version1 = RakeVersion::Version.new.from_s '1.2.3.456-beta-custom'
+      @version2 = RakeVersion::Version.new.from_s '2.3.4.567-alpha-customer'
+      @version3 = RakeVersion::Version.new.from_s '3.4.5.678-gamma-prod'
+    end
+
+    it "should correctly bump the major version" do
+      @version1.bump(:major).to_s.should == '2.0.0.456-beta-custom'
+      @version2.bump(:major).to_s.should == '3.0.0.567-alpha-customer'
+      @version3.bump(:major).to_s.should == '4.0.0.678-gamma-prod'
+    end
+
+    it "should correctly bump the minor version" do
+      @version1.bump(:minor).to_s.should == '1.3.0.456-beta-custom'
+      @version2.bump(:minor).to_s.should == '2.4.0.567-alpha-customer'
+      @version3.bump(:minor).to_s.should == '3.5.0.678-gamma-prod'
+    end
+
+    it "should correctly bump the patch version" do
+      @version1.bump(:patch).to_s.should == '1.2.4.456-beta-custom'
+      @version2.bump(:patch).to_s.should == '2.3.5.567-alpha-customer'
+      @version3.bump(:patch).to_s.should == '3.4.6.678-gamma-prod'
+    end
+
+    it "should not accept unknown bump types" do
+      [ nil, true, false, '', 'asd', :build, :unknown, :Major, [], {} ].each do |invalid|
+        lambda{ @version1.bump invalid }.should raise_error(RakeVersion::BadBumpType)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rake-version
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-21 00:00:00.000000000Z
+date: 2012-02-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2153297860 !ruby/object:Gem::Requirement
+  requirement: &2156595400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.2
   type: :runtime
   prerelease: false
-  version_requirements: *2153297860
+  version_requirements: *2156595400
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153297380 !ruby/object:Gem::Requirement
+  requirement: &2156593880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *2153297380
+  version_requirements: *2156593880
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &2153296900 !ruby/object:Gem::Requirement
+  requirement: &2156591640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.11.3
   type: :development
   prerelease: false
-  version_requirements: *2153296900
+  version_requirements: *2156591640
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2153296420 !ruby/object:Gem::Requirement
+  requirement: &2156455200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153296420
+  version_requirements: *2156455200
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2153290380 !ruby/object:Gem::Requirement
+  requirement: &2156453720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *2153290380
+  version_requirements: *2156453720
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2153289160 !ruby/object:Gem::Requirement
+  requirement: &2156452260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.5.4
   type: :development
   prerelease: false
-  version_requirements: *2153289160
+  version_requirements: *2156452260
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2153286860 !ruby/object:Gem::Requirement
+  requirement: &2156450160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 0.7.5
   type: :development
   prerelease: false
-  version_requirements: *2153286860
+  version_requirements: *2156450160
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &2153285300 !ruby/object:Gem::Requirement
+  requirement: &2156447840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +98,7 @@ dependencies:
         version: 1.6.8
   type: :development
   prerelease: false
-  version_requirements: *2153285300
+  version_requirements: *2156447840
 description: Rake tasks for version management.
 email: hydrae.alpha@gmail.com
 executables: []
@@ -108,6 +108,7 @@ extra_rdoc_files:
 - README.md
 files:
 - .document
+- .rspec
 - .rvmrc
 - Gemfile
 - Gemfile.lock
@@ -116,8 +117,16 @@ files:
 - Rakefile
 - VERSION
 - lib/rake-version.rb
+- lib/rake-version/context.rb
+- lib/rake-version/manager.rb
+- lib/rake-version/tasks.rb
+- lib/rake-version/version.rb
 - rake-version.gemspec
+- spec/context_spec.rb
 - spec/helper.rb
+- spec/manager_spec.rb
+- spec/tasks_spec.rb
+- spec/version_spec.rb
 homepage: http://github.com/AlphaHydrae/rake-version
 licenses:
 - MIT
@@ -133,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1674827796091654310
+      hash: 992759185416645503
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: