sprout 0.7.201 → 0.7.203

data/lib/sprout/tasks/git_task.rb

@@ -0,0 +1,121 @@
+require 'git'
+require 'sprout/version_file'
+
+module Sprout
+  
+  class GitTaskError < StandardError; end
+  
+  # A Rake task for continous integration and automated deployment.
+  # This task will automatically load a +version_file+, increment
+  # the last digit (revision), create a new tag in Git with the full
+  # version number, and push tags to the remote Git repository.
+  #
+  # To use this task, simply add the following to your rakefile:
+  #
+  #   desc 'Increment revision, tag and push with git'
+  #   git :tag do |t|
+  #     t.version_file = 'version.txt'
+  #   end
+  #
+  
+  class GitTask < Rake::Task
+    # Path to a plain text file that contains a three-part version number.
+    # @see VersionFile
+    attr_accessor :version_file
+    # Accessor for mocking the git gem.
+    attr_accessor :scm
+    # The remote branch to use, defaults to 'origin'.
+    attr_accessor :remote
+    # The local branch to send, defaults to 'master'.
+    attr_accessor :branch
+    # Message to use when committing after incrementing revision number.
+    # Defaults to 'Incremented revision number'.
+    attr_accessor :commit_message
+    
+    def initialize(name, app)
+      super
+      @remote = 'origin'
+      @branch = 'master'
+      @commit_message = 'Incremented revision number'
+    end
+    
+    def version
+      @version.to_s
+    end
+    
+    def define
+      validate
+      @version = VersionFile.new(version_file)
+    end
+    
+    def execute(*args)
+      super
+      # Fix numeric comparison....
+      while(get_tags.index(@version.to_tag)) do
+        @version.increment_revision
+      end
+      create_tag(@version.to_tag)
+      commit
+      push
+    end
+
+    def self.define_task(args, &block)
+      t = super
+      yield t if block_given?
+      t.define
+      return t
+    end
+    
+    private
+    
+    def push
+      `git push #{remote} #{branch} --tags`
+    end
+    
+    def commit
+      `git commit -a -m "#{commit_message}"`
+    end
+    
+    def path_to_git
+      git = '.git'
+      parts = Dir.pwd.split(File::SEPARATOR)
+      
+      while(parts.size > 0) do
+        path = parts.join(File::SEPARATOR)
+        if(File.exists?(File.join(path, git)))
+          return path
+        end
+        parts.pop
+      end
+      
+      return nil
+    end
+    
+    def get_tags
+      return @scm.tags.collect do |t|
+        t.name
+      end
+    end
+    
+    def create_tag(name)
+      @scm.add_tag name
+    end
+    
+    def validate
+      raise GitTaskError.new('version_file is a required configuration for GitTask') if version_file.nil?
+      if(@scm.nil?)
+        path = path_to_git
+        raise GitTaskError.new("We don't appear to be inside of a git repository") if path.nil?
+        @scm = Git.open(path)
+        @scm.pull
+      end
+    end
+    
+  end
+
+end
+
+# Helper method for definining the git task in a rakefile
+def git(args, &block)
+  Sprout::GitTask.define_task(args, &block)
+end

data/lib/sprout/version.rb

@@ -2,7 +2,7 @@ module Sprout
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 7
-    TINY  = 201
+    TINY  = 203
 
     STRING = [MAJOR, MINOR, TINY].join('.')
     MAJOR_MINOR = [MAJOR, MINOR].join('.')

data/lib/sprout/version_file.rb

@@ -0,0 +1,89 @@
+module Sprout
+  
+  # Used by the GitTask to load, parse and persist Version information
+  # related to a project.
+  # Expects a file with a 3 digit number, separated by periods like:
+  #
+  #   3.4.2
+  #
+  # Create with a path to the file like:
+  # 
+  #   version = VersionFile.new('path/Version.txt')
+  #
+  class VersionFile
+    
+    def initialize(file_path)
+      @file_path = file_path
+      read_value
+    end
+    
+    def value=(value)
+      @value = value
+      write_value
+    end
+    
+    def value
+      @value
+    end
+    
+    def major_version
+      @value.split('.').shift.to_i
+    end
+    
+    def minor_version
+      @value.split('.')[1].to_i
+    end
+    
+    def revision
+      @value.split('.').pop.to_i
+    end
+    
+    def increment_revision
+      self.revision = self.revision + 1
+    end
+    
+    def to_s
+      @value
+    end
+    
+    def to_str
+      @value
+    end
+    
+    def to_tag
+      parts = value.split('.')
+      parts[0] = add_leading_zeros(parts[0], 2)
+      parts[1] = add_leading_zeros(parts[1], 2)
+      parts[2] = add_leading_zeros(parts[2], 3)
+      return parts.join('.')
+    end
+    
+    private
+    
+    def add_leading_zeros(str, digits)
+      (digits - str.size).times do
+        str = "0#{str}"
+      end
+      str
+    end
+    
+    def read_value
+      File.open(@file_path, 'r') do |file|
+        @value = file.read.strip
+      end
+    end
+    
+    def write_value
+      File.open(@file_path, 'r+') do |file|
+        file.write @value
+      end
+    end
+    
+    def revision=(revision)
+      parts = @value.split('.')
+      parts[2] = revision
+      @value = parts.join('.')
+      write_value
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sprout
 version: !ruby/object:Gem::Version 
-  version: 0.7.201
+  version: 0.7.203
 platform: ruby
 authors: 
 - Luke Bayes
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-13 00:00:00 -08:00
+date: 2009-01-14 00:00:00 -08:00
 default_executable: sprout
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -114,6 +114,7 @@ files:
 - lib/sprout/simple_resolver.rb
 - lib/sprout/tasks
 - lib/sprout/tasks/gem_wrap_task.rb
+- lib/sprout/tasks/git_task.rb
 - lib/sprout/tasks/library_task.rb
 - lib/sprout/tasks/sftp_task.rb
 - lib/sprout/tasks/ssh_task.rb
@@ -122,6 +123,7 @@ files:
 - lib/sprout/template_resolver.rb
 - lib/sprout/user.rb
 - lib/sprout/version.rb
+- lib/sprout/version_file.rb
 - lib/sprout/zip_util.rb
 - lib/sprout.rb
 - doc/Bundle