rake-version 0.3.1 → 0.4.0

data/Gemfile

@@ -13,11 +13,6 @@ group :development do
   gem 'jeweler'
   gem 'gem-release'
   gem 'simplecov'
-  gem 'yard'
-  gem 'rdiscount'
   gem 'travis-lint'
-end
-
-group :test do
-  gem 'active_support'
+  gem 'fakefs', require: 'fakefs/safe'
 end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Alpha Hydrae (hydrae.alpha@gmail.com)
+Copyright (c) 2011-2013 Simon Oulevay (Alpha Hydrae)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,18 +1,92 @@
 # rake-version
 
-**Rake tasks for version management.**
+**Simple rake tasks for version management.**
 
-Tested with <a href="https://www.relishapp.com/rspec">RSpec</a>, <a href="https://github.com/thoughtbot/shoulda">shoulda</a> and <a href="http://travis-ci.org/#!/AlphaHydrae/rake-version">Travis CI</a>.
+[![Gem Version](https://badge.fury.io/rb/rake-version.png)](http://badge.fury.io/rb/rake-version)
+[![Dependency Status](https://gemnasium.com/AlphaHydrae/rake-version.png)](https://gemnasium.com/AlphaHydrae/rake-version)
+[![Build Status](https://secure.travis-ci.org/AlphaHydrae/rake-version.png?branch=master)](http://travis-ci.org/AlphaHydrae/rake-version)
 
-* master [![Build Status](https://secure.travis-ci.org/AlphaHydrae/rake-version.png?branch=master)](http://travis-ci.org/AlphaHydrae/rake-version)
-* develop [![Build Status](https://secure.travis-ci.org/AlphaHydrae/rake-version.png?branch=develop)](http://travis-ci.org/AlphaHydrae/rake-version)
+**rake-version** helps you manage your `VERSION` file according to the rules of [semantic versioning](http://semver.org).
+It does nothing more.
+It does not create tags; it does not commit; it does not push; it does not release.
 
-## License (MIT)
+## Installation
 
-Copyright (c) 2011 Alpha Hydrae
+Add to your Gemfile and `bundle install`:
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+```rb
+gem "rake-version", "~> 0.0"
+```
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+Add the tasks to your Rakefile:
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+```rb
+require 'rake-version'
+RakeVersion::Tasks.new
+```
+
+## Usage
+
+```bash
+# show current version
+rake version              #=> 1.0.0
+
+# bump version
+rake version:bump:patch   #=> 1.0.1
+rake version:bump:minor   #=> 1.1.0
+rake version:bump:major   #=> 2.0.0
+
+# set version
+rake "version:set[1.2.3]" #=> 1.2.3
+```
+
+### Auto-update other files
+
+When you add the rake version tasks in your Rakefile, you may specify additional files to update with the new version.
+
+```rb
+require 'rake-version'
+RakeVersion::Tasks.new do |v|
+  v.copy 'lib/my-gem.rb'          # update single file
+  v.copy 'lib/a.rb', 'lib/b.rb'   # update multiple files
+  v.copy 'lib/*.rb'               # update all files matching a glob pattern
+  v.copy /lib/                    # update all files whose path matches a regexp
+end
+```
+
+By default, **rake-version** will replace the first occurrence of a semantic version pattern (`number.number.number(-prerelease)(+build)`) with the new version.
+It will not modify the prerelease version or build metadata.
+For example, when bumping the minor version from 1.0.0, it will change the contents of this file:
+
+```rb
+class Thing
+  VERSION = '1.0.0'
+end
+```
+
+To this:
+
+```rb
+class Thing
+  VERSION = '1.1.0'
+end
+```
+
+You can customize this behavior as follows:
+
+```rb
+RakeVersion::Tasks.new do |v|
+  v.copy 'lib/my-gem.rb', all: true   # replace all occurrences
+end
+```
+
+### Semantic versioning
+
+**rake-version** partially supports [semantic versioning v2.0.0](http://semver.org/spec/v2.0.0.html).
+You can add prerelease (e.g. `-beta`) and build (e.g. `+20131313`) information to your versions,
+but there are currently no tasks to update them other than `version:set`.
+
+## Meta
+
+* **Author:** Simon Oulevay (Alpha Hydrae)
+* **License:** MIT (see [LICENSE.txt](https://raw.github.com/AlphaHydrae/rake-version/master/LICENSE.txt))

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/lib/rake-version.rb

@@ -7,6 +7,7 @@ module RakeVersion
   class Error < StandardError; end
   class BadVersionString < Error; end
   class MissingContext < Error; end
+  class MissingVersionFile < Error; end
   class BadArgument < Error; end
   class BadContext < BadArgument; end
   class BadVersion < BadArgument; end
@@ -14,10 +15,6 @@ module RakeVersion
   class BadFilePattern < BadArgument; end
   class BadVersionPattern < 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

data/lib/rake-version/config.rb

@@ -1,8 +1,7 @@
-require 'ostruct'
 
 module RakeVersion
 
-  class Config < OpenStruct
+  class Config
 
     attr_reader :extension
 

data/lib/rake-version/context.rb

@@ -2,21 +2,10 @@
 module RakeVersion
 
   class Context
+    attr_reader :root
   
-    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 }
+    def initialize root
+      @root = root
     end
   end
 end

data/lib/rake-version/copier.rb

@@ -5,11 +5,11 @@ module RakeVersion
   class Copier
 
     def initialize *args
-      @options = args.last.kind_of?(Hash) ? args.pop : {}
+      options = args.last.kind_of?(Hash) ? args.pop : {}
 
       @file_patterns = args.collect{ |arg| check_file_pattern arg }
-      @version_pattern = check_version_pattern(option(:version)) || /\d+\.\d+\.\d+/
-      @replace_all = !!option(:all)
+      @version_pattern = Version::REGEXP
+      @replace_all = !!options[:all]
     end
 
     def copy version, context
@@ -18,14 +18,6 @@ module RakeVersion
 
     private
 
-    def option sym
-      if @options.key? sym
-        @options[sym]
-      elsif @options.key? sym.to_s
-        @options[sym.to_s]
-      end
-    end
-
     def check_file_pattern pattern
       unless [ String, Regexp ].any?{ |klass| pattern.kind_of? klass }
         raise BadFilePattern, "Expected file pattern to be a glob string or regexp, got #{pattern.class.name}."
@@ -33,18 +25,12 @@ module RakeVersion
       pattern
     end
 
-    def check_version_pattern pattern
-      unless pattern.nil? or pattern.kind_of? Regexp
-        raise BadVersionPattern, "Expected version option to be a regexp, got #{pattern.class.name}."
-      end
-      pattern
-    end
-
     def copy_version file, version
       File.open(file, 'r+') do |f|
         contents = f.read
         return unless match? contents
         f.rewind
+        f.truncate 0
         f.write process(contents, version)
       end
     end

data/lib/rake-version/manager.rb

@@ -28,7 +28,6 @@ module RakeVersion
     end
 
     def with_context context, &block
-      RakeVersion.check_context context
       @context = context
       yield self if block_given?
       @context = nil
@@ -53,11 +52,12 @@ module RakeVersion
     end
 
     def read_version
-      @context.read version_file
+      raise MissingVersionFile, "Version file doesn't exist: #{version_file}" unless File.exists? version_file
+      File.read version_file
     end
 
     def write_version version
-      version.tap{ |v| @context.write version_file, version.to_s }
+      version.tap{ |v| File.open(version_file, 'w'){ |f| f.write version.to_s } }
     end
 
     def version_file

data/lib/rake-version/tasks.rb

@@ -2,24 +2,29 @@
 module RakeVersion
 
   class Tasks < ::Rake::TaskLib
+    NAMES = [ 'version', 'version:bump:major', 'version:bump:minor', 'version:bump:patch', 'version:set' ]
+    OTHER_NAMES = [ 'version:write' ]
 
-    def initialize &block
+    def initialize options = {}, &block
       @manager = RakeVersion::Manager.new
       @config = RakeVersion::Config.new
       yield @config if block_given?
       @manager.config = @config
-      define
+      define options
     end
 
-    def define
+    def define options = {}
+
+      clear_tasks options unless options[:clear] == false
+
       desc 'Show the current version'
       task :version do |t|
-        puts @manager.version.to_s
+        handle_missing_version{ puts @manager.version.to_s }
       end
 
       namespace :version do
 
-        desc 'Set the version (e.g. rake version:set[1.2.3])'
+        desc 'Set the version (rake "version:set[1.2.3]")'
         task :set, :value do |t, args|
           puts @manager.set(args.value.to_s)
         end
@@ -29,7 +34,7 @@ module RakeVersion
           [ :major, :minor, :patch ].each do |type|
             desc "Bump the #{type} version"
             task type do |t|
-              puts @manager.bump(type).to_s
+              handle_missing_version{ puts @manager.bump(type).to_s }
             end
           end
         end
@@ -44,10 +49,34 @@ module RakeVersion
       end
     end
 
+    def clear_tasks options = {}
+      task_names = NAMES
+      task_names += OTHER_NAMES unless options[:clear_strict]
+      task_names.each{ |task| clear task }
+    end
+
     private
 
+    def handle_missing_version
+      return yield if Rake.application.options.trace
+      begin
+        yield
+      rescue MissingVersionFile => e
+        warn %|#{e.message}\nCreate it with:\n   rake "version:set[1.0.0]"|
+        exit 1
+      end
+    end
+
+    def clear task
+      begin
+        Rake::Task[task].clear if Rake::Task[task]
+      rescue
+        false
+      end
+    end
+
     def context task
-      RakeVersion::Context.new task
+      RakeVersion::Context.new task.application.original_dir
     end
   end
 end

data/lib/rake-version/version.rb

@@ -2,21 +2,20 @@
 module RakeVersion
 
   class Version
-    REGEXP = /^(\d+)\.(\d+)\.(\d+)(?:\.(\d+))?((?:\-[A-Za-z0-9]+)*)$/
+    REGEXP = /(\d+)\.(\d+)\.(\d+)(?:\-([a-z0-9\-]+(?:\.[a-z0-9\-]+)*))?(?:\+([a-z0-9\-]+(?:\.[a-z0-9\-]+)*))?/i
 
     attr_reader :major
     attr_reader :minor
     attr_reader :patch
+    attr_reader :prerelease
     attr_reader :build
-    attr_reader :tags
 
     def initialize
       @major = 0
       @minor = 0
       @patch = 0
+      @prerelease = nil
       @build = nil
-      @tags = []
-      # TODO: create methods to list, add and remove tags
     end
 
     def bump type
@@ -38,12 +37,12 @@ module RakeVersion
 
     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?
+        raise BadVersionString, "Version '#{s}' expected to have format MAJOR.MINOR.PATCH(-PRERELEASE)(+BUILD)." 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('-') : []
+        @prerelease = m[4]
+        @build = m[5]
       end
       self
     end
@@ -51,8 +50,8 @@ module RakeVersion
     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?
+        s << "-#{@prerelease}" if @prerelease
+        s << "+#{@build}" if @build
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rake-version
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-04 00:00:00.000000000 Z
+date: 2013-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -108,23 +108,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rdiscount
+  name: travis-lint
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -140,7 +124,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: travis-lint
+  name: fakefs
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -155,7 +139,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Rake tasks for version management.
+description: Rake tasks to manage your VERSION file. No repository management (tags,
+  committing, pushing), no release management.
 email: hydrae.alpha@gmail.com
 executables: []
 extensions: []
@@ -163,16 +148,9 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- .document
-- .rspec
-- .rvmrc
-- .screenrc
-- .travis.yml
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
 - VERSION
 - lib/rake-version.rb
 - lib/rake-version/config.rb
@@ -181,15 +159,7 @@ files:
 - lib/rake-version/manager.rb
 - lib/rake-version/tasks.rb
 - lib/rake-version/version.rb
-- rake-version.gemspec
-- spec/config_spec.rb
-- spec/context_spec.rb
-- spec/copier_spec.rb
-- spec/helper.rb
-- spec/manager_spec.rb
-- spec/tasks_spec.rb
-- spec/version_spec.rb
-homepage: http://github.com/AlphaHydrae/rake-version
+homepage: https://github.com/AlphaHydrae/rake-version
 licenses:
 - MIT
 post_install_message: 
@@ -202,6 +172,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -419221732059248615
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -213,6 +186,5 @@ rubyforge_project:
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Rake tasks for version management.
+summary: Simple rake tasks for version management.
 test_files: []
-has_rdoc: