autoversion 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e19cd24caedde612005e57c536d6d23a3cf27c4
-  data.tar.gz: 4abca7955e686be2d91b0946f33af46b050880aa
+  metadata.gz: 9840e84b0c9f9fc1b82e69b63d0fa2b48cab6800
+  data.tar.gz: e5409566fc64257e84ee79083192a91e2b2a3592
 SHA512:
-  metadata.gz: 5af8dcd3a141bcf64ebe09e715771b1b0a860e2d2f87f53193c41585efd28b69f7995c9d68ee46bf2eb9e96a1d298a5edad3515a2aa3f48d92807fe0c87eae5c
-  data.tar.gz: 762b5bc91b6f378dabbc364e58737e7a434b2ad6113b859f7ae003114266b1a939be479ca7d6308c621830269522734a724f72bc88680e8a5cb2eed1df35edc2
+  metadata.gz: 225a4c4e02dfdf088c2a771c3f5a71e9b81843d4fbdb55476d6eee938076c2984019118a706febb7c33b89d2cae4fd0f1747a4dc2466b4dff8e789a5e643c98c
+  data.tar.gz: 03bbc50a7bf7a42c3a67f20c55db1cde4ffdf3d52feec93a7e6360a0bd0e0edc0bba4e3399b30350920de75257e62ebc73119ce6109597cea573bdbd9ccd4b62

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+ - 2.0.0
+script: bundle exec rspec spec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    autoversion (0.3.2)
+    autoversion (0.4.0)
       git (= 1.2.5)
       semantic (= 1.1.0)
       thor (= 0.17.0)

data/README.md

@@ -1,14 +1,22 @@
+### Status
+[![Build Status](https://travis-ci.org/jpettersson/autoversion.png)](https://travis-ci.org/jpettersson/autoversion)
+
 Autoversion
 ===========
 
-Autoversion is a command line tool that can automate [semantic versioning](http://semver.org) in your application. It 
-integrates nicely with git to give you automatic & atomic commits of version increments. It also supports hooks that can be run before and after a new version has been comitted.
+Autoversion is a command line tool that can automate [semantic versioning](http://semver.org) during development. It 
+integrates nicely with git to give you automatic & atomic commits of version increments. Don't trust humans (not even yourself) to commit and tag proper versions, let autoversion do it for you.
 
-Autoversion is not finished, but it's used enough to be public. Consider it an experiment.<br />
-And yes, Autoversion uses Autoversion for versioning ;)
+Autoversion is great for library development where proper version management is important. Also, Autoversion uses Autoversion for versioning ;)
 
-Basics
----------
+Installation
+------------
+```
+gem install autoversion
+```
+
+Usage
+-----
 
 **Read current version**
 ```Bash
@@ -20,31 +28,30 @@ $ autoversion
 $ autoversion major
 $ autoversion minor
 $ autoversion patch
-$ autoversion build 'named-version'
 ```
 
 The Versionfile
 --------------------
 
-The Versionfile is a ruby script which is used by Autoversion to read and write version.
-
-**Example**
+The project you want to version needs to have a file called 'Versionfile'. Autoversion will evaluate this file as a ruby script. Autoversion provides a small DSL to allow you to read and write versions to your files. Below is an example of the DSL usage:
 
 ```Ruby
 
-# This block should return a valid Semantic object. Typically it will read a file and parse it.
+# This block should return a valid Semantic object. 
+# Example: Read a file and parse a verson from it.
 read_version do
-  # Return a valid Semantic object
+  # Should return a string representation of a semantic version
 end
 
-# This block should take a Semantic object and persist it. Usually this means rewriting some version file.
-write_version do |semver|
-  # Write a Semantic object
+# This block takes the current and next version (strings). 
+# Example: Rewriting a version file.
+write_version do |currentVersion, nextVersion|
+  # Write the new version to a file
 end
 
 after :version do
   # Run some command after any versioning action
-  # Example: Export a .crx file, copy & name it for Blackberry
+  # Example: Run a package script, trigger CI, etc.
 end
 
 after :patch do
@@ -57,7 +64,6 @@ end
 
 after :major do
   # Run some command after release
-  # Example: Copy lib/ files from Exo.js to exojs-gem
 end
 
 ```
@@ -117,9 +123,59 @@ after :version do |currentVersion|
 end
 ```
 
-**An npm module**
+**A bower module**
+
+```Ruby
+require 'json'
+
+# Automatically create an atomic commit of the version file update
+# and create a new tag.
+automate_git :actions => [:commit, :tag]
+
+file = './bower.json'
+
+read_version do
+  doc = JSON.load File.read file
+  doc['version']
+end
+
+write_version do |currentVersion, nextVersion|
+  doc = JSON.load File.read file
+  doc['version'] = nextVersion.to_s
+  File.open(file, 'w') {|f| f.write JSON.pretty_generate(doc) }
+end
+```
+
+**Advanced usage: Update several files using a pattern matcher**
+
+You can also read & update versions using a pattern matcher. The following Versionfile is from a ruby gem that has several plugins (also packaged as gems) contained in the same git repo. The VERSION_PATTERN is used for both reading and writing the version. Note that the write_version method updates several files using a glob pattern.
 
 ```Ruby
+
+# The matched files look like this:
+
+# module YourProject
+#  VERSION = "0.0.2"
+# end
+
+VERSION_PATTERN = /^\s*VERSION = \"(.+)\"$/
+
+matcher = proc do |line|
+  if m = VERSION_PATTERN.match(line)
+    m[1]
+  else
+    nil
+  end
+end
+
+read_version do
+  parse_file "lib/your-project/version.rb", matcher
+end
+
+write_version do |oldVersion, newVersion|
+  update_files Dir.glob("**/version.rb"), matcher, oldVersion, newVersion
+end
+
 ```
 
 

data/lib/autoversion/dsl.rb

@@ -1,6 +1,5 @@
 module Autoversion
   class DSL
-
     class MissingReadBlock < Exception
     end
 
@@ -25,6 +24,52 @@ module Autoversion
       }
     end
 
+    # Parse the specified file with the provided matcher.
+    #
+    # The first returned match will be used as the version.
+    def parse_file path, matcher
+      File.open(path) do |f|
+        f.each do |line|
+          if m = matcher.call(line)
+            return m
+          end
+        end
+      end
+
+      raise "#{path}: found no matching lines."
+    end
+
+    # Update a file naively matching the specified matcher and replace any
+    # matching lines with the new version.
+    def update_file path, matcher, currentVersion, nextVersion
+      temp_path = "#{path}.autoversion"
+
+      begin
+        File.open(path) do |source|
+          File.open(temp_path, 'w') do |target|
+            source.each do |line|
+              if matcher.call(line)
+                target.write line.gsub currentVersion.to_s, nextVersion.to_s
+              else
+                target.write line
+              end
+            end
+          end
+        end
+
+        File.rename temp_path, path
+      ensure
+        File.unlink temp_path if File.file? temp_path
+      end
+    end
+
+    # Convenience function for update_file to apply to multiple files.
+    def update_files paths, matcher, currentVersion, nextVersion
+      paths.each do |path|
+        update_file path, matcher, currentVersion, nextVersion
+      end
+    end
+
     def validate!
       # A read_version block is required
       raise MissingReadBlock unless @read_blk
@@ -85,4 +130,4 @@ module Autoversion
       end
     end
   end
-end
+end

data/lib/autoversion/version.rb

@@ -1,3 +1,3 @@
 module Autoversion
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/spec/cli_spec.rb

@@ -1,20 +1,9 @@
 require 'spec_helper'
 require 'git'
+require_relative 'fixtures/versionfiles'
 
 describe Autoversion::CLI do
 
-  BASE_VERSIONFILE = <<-eos
-      read_version do
-        File.read File.join(File.dirname(__FILE__), 'spec', 'tmp', 'cli', 'version.txt')
-      end
-
-      write_version do |currentVersion, nextVersion|
-        File.open(File.join(File.dirname(__FILE__), 'spec', 'tmp', 'cli', 'version.txt'), 'w') do |file| 
-          file.write currentVersion.to_s
-        end
-      end
-    eos
-
   # Borrowing capture_io from minitest until I have 
   # time to move over to minitest fully.
   def capture_io
@@ -57,14 +46,14 @@ describe Autoversion::CLI do
   end
 
   it "should be able to read a version" do
-    ::Autoversion::CLI.version_file_contents = BASE_VERSIONFILE
+    ::Autoversion::CLI.version_file_contents = Versionfiles::BASE_VERSIONFILE
 
     out = capture_io{ Autoversion::CLI.start %w{} }.join ''
     out.should == "\e[36m0.0.1\e[0m\n"
   end
 
   it "should be able to write versions" do
-    ::Autoversion::CLI.version_file_contents = BASE_VERSIONFILE
+    ::Autoversion::CLI.version_file_contents = Versionfiles::BASE_VERSIONFILE
 
     out = capture_io{ Autoversion::CLI.start %w{patch -f} }.join ''
     out.should == "\e[32mVersion changed to 0.0.2\e[0m\n"
@@ -76,22 +65,37 @@ describe Autoversion::CLI do
     out.should == "\e[32mVersion changed to 1.0.0\e[0m\n"
   end
 
+  it "should be able to read/write versions using a pattern matcher" do
+    ::Autoversion::CLI.version_file_contents = Versionfiles::PATTERN_VERSIONFILE
+    out = capture_io{ Autoversion::CLI.start %w{patch -f} }.join ''
+    out.should == "\e[32mVersion changed to 0.0.2\e[0m\n"
+
+    plugin_file = `cd #{@path} && cat lib/your-project/plugins/your-plugin/version.rb`
+    ref_file = <<-eof
+module YourProject
+ VERSION = "0.0.2"
+end
+eof
+
+    plugin_file.should == ref_file.chop
+  end
+
   it "should be able to write, commit and tag patch" do
-    ::Autoversion::CLI.version_file_contents = "automate_git\n\n" + BASE_VERSIONFILE
+    ::Autoversion::CLI.version_file_contents = "automate_git\n\n" + Versionfiles::BASE_VERSIONFILE
     
     out = capture_io{ Autoversion::CLI.start %w{patch -f} }.join ''
     out.should == "\e[32mVersion changed to 0.0.2\e[0m\n"
   end
 
   it "should be able to write, commit and tag minor" do
-    ::Autoversion::CLI.version_file_contents = "automate_git\n\n" + BASE_VERSIONFILE
+    ::Autoversion::CLI.version_file_contents = "automate_git\n\n" + Versionfiles::BASE_VERSIONFILE
 
     out = capture_io{ Autoversion::CLI.start %w{minor -f} }.join ''
     out.should == "\e[32mVersion changed to 0.1.0\e[0m\n"
   end
 
   it "should be able to write, commit and tag major" do
-    ::Autoversion::CLI.version_file_contents = "automate_git\n\n" + BASE_VERSIONFILE
+    ::Autoversion::CLI.version_file_contents = "automate_git\n\n" + Versionfiles::BASE_VERSIONFILE
 
     out = capture_io{ Autoversion::CLI.start %w{major -f} }.join ''
     out.should == "\e[32mVersion changed to 1.0.0\e[0m\n"

data/spec/fixtures/versionfiles.rb

@@ -1,4 +1,37 @@
 module Versionfiles
+
+  BASE_VERSIONFILE = <<-eos
+    read_version do
+      File.read File.join(File.dirname(__FILE__), 'spec', 'tmp', 'cli', 'version.txt')
+    end
+
+    write_version do |currentVersion, nextVersion|
+      File.open(File.join(File.dirname(__FILE__), 'spec', 'tmp', 'cli', 'version.txt'), 'w') do |file| 
+        file.write currentVersion.to_s
+      end
+    end
+  eos
+
+  PATTERN_VERSIONFILE = <<-eof
+    VERSION_PATTERN = /^\s*VERSION = \"(.+)\"$/
+
+    matcher = proc do |line|
+      if m = VERSION_PATTERN.match(line)
+        m[1]
+      else
+        nil
+      end
+    end
+
+    read_version do
+      parse_file "spec/tmp/cli/lib/your-project/version.rb", matcher
+    end
+
+    write_version do |oldVersion, newVersion|
+      update_files Dir.glob("spec/tmp/cli/**/version.rb"), matcher, oldVersion, newVersion
+    end
+  eof
+
   VALID_BASIC = <<-eof
     read_version do
       '1.2.3'
@@ -12,4 +45,5 @@ module Versionfiles
   INVALID = <<-eof
 
   eof
+
 end

data/spec/gitter_spec.rb

@@ -13,6 +13,11 @@ describe Autoversion::Gitter do
     system("mkdir #{@gitter_path}")
     system("tar -xf spec/fixtures/bare_repo.tar --strip 1 -C #{@gitter_path}")
     
+    # Fix to make specs run on travis-ci which has no
+    # default git user config.
+    # system("cd #{@gitter_path} && git config user.email 'you@example.com'")
+    # system("cd #{@gitter_path} && git config user.name 'Your Name'")
+
     system("echo 'test' > #{@gitter_path}/test.txt")
     system("cd #{@gitter_path} && git add .")
     system("cd #{@gitter_path} && git commit -m 'test'")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: autoversion
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jonathan Pettersson
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE