jacaetevha-growthspurt 1.0.6

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2009-07-10
+
+* 1 major enhancement
+
+  * Released it to GitHub
+

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+VERSION
+bin/growthspurt
+example.rb
+growth-spurt.gemspec
+lib/growthspurt.rb
+lib/update_version_when_branching.rb
+test/test_growthspurt.rb

data/README.txt

@@ -0,0 +1,60 @@
+= growthspurt
+
+* http://github.com/jacaetevha/growth-spurt
+
+== DESCRIPTION:
+
+=== What is GrowthSpurt?
+
+It's a utility for creating branches in Git and automatically creating/updating change files based on commit messages.
+
+=== Why GrowthSpurt?
+
+I originally wrote this in order help automate builds of our Ruby code into a Java/Maven-centric company build process. Most of the company dealt with Subversion, but I wanted to use Git. Most of the company coded in Java and managed builds/deployments with Maven, but I wanted to use Ruby and Capistrano. I lost on the Capistrano-vs-Maven front, but I was able to continue using Ruby and Git. So, this script was built to automate branching in Git in a standard Major.Minor.Micro format (eg. 1.0.1, 1.0.2, 1.0.3) and pushing those branches to a remote repository, and then using Git to create a CHANGES file and a changes.xml file. The latter is used by Maven's Changes plugin (http://maven.apache.org/plugins/maven-changes-plugin/).
+
+== FEATURES/PROBLEMS:
+
+* create CHANGES and changes.xml files based on commit messages from Git for any digit.digit.digit branch, as well as the master branch
+* can create a new remote and local tracking branch for the new "growth" (branch)
+* doesn't handle Nano format branches (eg. 1.2.3.45)
+* once on the branch the check-in of the change files isn't happening properly because they aren't being added
+* when creating a new version of this project the gemspec file needs to be updated
+
+== SYNOPSIS:
+
+  To get a synopsis, run growthspurt -h
+
+== REQUIREMENTS:
+
+* grit 1.1.1
+* facets 2.5.2 (in particular, dictionary & enumerable
+
+== INSTALL:
+
+* sudo gem install grit facets 
+* sudo gem install jacaetevha-growth-spurt
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Jason Rogers
+
+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:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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.

data/VERSION

@@ -0,0 +1 @@
+1.0.6

data/bin/growthspurt

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby -wKU
+require 'rubygems'
+require 'lib/growthspurt.rb'
+
+GrowthSpurt.new(ARGV, STDIN).run

data/lib/growthspurt.rb

@@ -0,0 +1,393 @@
+#!/usr/bin/env ruby -wKU
+
+# == Synopsis
+#   This script will create a new branch of the CRM application and check that into Git.
+#
+# == Examples
+#   This command does will create a branch called 1.0.5 and will update the CHANGES and changes.xml
+#   files with differences between 1.0.5 and 1.0.2
+#     growthspurt -p 1.0.2 -c 1.0.5
+#
+#   Other examples:
+#     growthspurt -q -p 1.0.4 -c 1.0.5
+#     growthspurt --verbose -p testing_branch -c qa_branch_1
+#     growthspurt -n
+#
+# == Usage
+#   growthspurt [options]
+#
+#   For help use: growthspurt -h
+#
+# == Options
+#   -h, --help          Displays help message
+#
+#   -v, --version       Display the version, then exit
+#
+#   -q, --quiet         Output as little as possible, overrides verbose
+#
+#   -V, --verbose       Verbose output
+#
+#   -t, --title         The value of the title attribute in the changes.xml file
+#
+#   -P, --changes-path  The path to changes.xml file (defaults to src/changes)
+#
+#   -N, --no-branch     Don't create a new branch, just update the CHANGES and changes.xml files
+#
+#   -n, --next          Create a new branch with this tag as its name (required, unless -n is specified)
+#
+#   -m, --message       Message when creating new branch (defaults to "created version <value of -n argument>")
+#
+#   -p, --prev          Previous version (optional), used in conjunction with -c. Specifying this option
+#                       will create the CHANGES and changes.xml files in the "next" branch with the changes
+#                       between the current branch and the "previous" branch.
+#
+#                       Eg. While running this script within the master branch the following command will create
+#                           a 1.0.5 branch based off of master with a CHANGES file that contains the differences
+#                           between the master branch and the 1.0.4 branch:
+#
+#                           growthspurt -p 1.0.4 -n 1.0.5
+#
+# == Author
+#   Jason Rogers
+#
+# == Copyright
+#   Copyright (c) 2009 Jason Rogers
+
+require 'optparse'
+require 'rdoc/usage'
+require 'ostruct'
+require 'rexml/document'
+require 'time'
+require 'fileutils'
+require 'grit'
+require 'facets/dictionary'
+require 'facets/enumerable'
+
+class GrowthSpurt
+  include REXML
+  include Grit
+
+  VERSION = File.readlines(File.expand_path(File.join(File.dirname(__FILE__), '..', 'VERSION'))).first.chomp
+  
+  def self.pre_commit_hooks
+    @@pre_commit_hooks ||= []
+  end
+
+  attr_reader :options, :diffs, :repo
+
+  def initialize(arguments, stdin)
+    @arguments = arguments
+    @stdin = stdin
+
+    # Set defaults
+    @options = OpenStruct.new
+    @options.verbose = false
+    @options.quiet = false
+    @options.create_branch = true
+    @options.changes_dot_xml_directory = File.join('src', 'changes')
+    @repo = Repo.new('.')
+    @diffs = []
+  end
+
+  # Parse options, check arguments, then process the command
+  def run
+
+    if parsed_options? && arguments_valid?
+
+      puts "Start at #{DateTime.now}\n\n" if @options.verbose
+
+      output_options if @options.verbose # [Optional]
+
+      process_arguments
+      process_command
+
+      puts "\nFinished at #{DateTime.now}" if @options.verbose
+
+    else
+      output_usage
+    end
+
+  end
+
+  protected
+    def parsed_options?
+      # Specify options
+      opts = OptionParser.new
+      opts.on('-v', '--version')               { output_version ; exit 0 }
+      opts.on('-h', '--help')                  { output_help }
+      opts.on('-V', '--verbose')               { @options.verbose = true }
+      opts.on('-q', '--quiet')                 { @options.quiet = true }
+      opts.on('-p', '--prev=name')             { |v| @options.previous_version = v }
+      opts.on('-n', '--next=name')             { |v| @options.new_version = v }
+      opts.on('-N', '--no-branch')             { @options.create_branch = false }
+      opts.on('-m', '--message=msg')           { |v| @options.message = v }
+      opts.on('-t', '--title=title')           { |v| @options.title = v }
+      opts.on('-c', '--changes-path=path')     { |v| @options.changes_dot_xml_directory = v }
+      opts.on('-P', '--pre-commit-hooks=file') { |v| load File.expand_path(v) }
+
+      opts.parse!(@arguments) rescue return false
+
+      process_options
+      true
+    end
+
+    # Performs post-parse processing on options
+    def process_options
+      @options.verbose = false if @options.quiet
+    end
+
+    def output_options
+      puts "Options:\n"
+
+      @options.marshal_dump.each do |name, val|
+        puts "  #{name} = #{val}"
+      end
+    end
+
+    # True if required arguments were provided
+    def arguments_valid?
+      #
+      # Not sure if the following makes sense. Could be that we want
+      # to specify a (non-existent) branch to see what the changes.xml
+      # file would look like.
+      #
+      if @options.new_version
+        unless @options.create_branch
+          puts "\n\nWARNING: you specified a new branch name, but you did not specify to create it.\nThe changes.xml file will reference this new branch, but it won't be created.\n\n"
+        end
+      end
+
+      if @options.create_branch
+        return false if @options.new_version.nil? || @options.new_version.empty?
+        unless git_remote_branch_installed?
+          puts "cannot create new branch, either install git-remote-branch (sudo gem install git-remote-branch) or make sure it's in your PATH"
+          return false
+        end
+      end
+
+      true
+    end
+
+    # Setup the arguments
+    def process_arguments
+    end
+
+    def output_help
+      output_version
+      RDoc::usage() #exits app
+    end
+
+    def output_usage
+      RDoc::usage('usage') # gets usage from comments above
+    end
+
+    def output_version
+      puts "#{File.basename(__FILE__)} version #{VERSION}"
+    end
+
+    def process_command
+      @options.message = "created version #{@options.new_version}"
+
+      if !@options.new_version && @options.create_branch
+        raise 'must specify a version in order to create a branch (eg. 1.0.1)'
+        exit 1
+      end
+
+      @diffs = load_diffs
+
+      update_changes_files
+
+      if @options.create_branch
+        puts "creating initial branch #{@options.new_version}"
+        `#{grb_location} create #{@options.new_version}`
+
+        update_pom_dot_xml
+        update_dot_gitignore
+        
+        run_pre_commit_hooks
+
+        puts "committing to #{@options.new_version}"
+        `git commit -v -a -m"#{@options.message}"`
+
+        puts "pushing to main repository"
+        `git push`
+      end
+    end
+
+  private
+    def run_pre_commit_hooks
+      self.class.pre_commit_hooks.each do | hook |
+        hook.run(self)
+      end
+    end
+    
+    def load_diffs(opts={})
+      options = {:last => @options.previous_version, :current => current_branch, :diff_collection => self.diffs}.merge(opts)
+      commits = options[:last] ? 
+        repo.commits_between(options[:last], options[:current]) :
+        repo.commits_since(options[:current]) #2nd arg could be a date string
+      commits.reverse.each do |commit|
+        options[:diff_collection] << CommitSnapshot.new(commit)
+      end
+      options[:diff_collection]
+    end
+  
+    def git_remote_branch_installed?
+      grb_location.nil? == false && grb_location.empty? == false
+    end
+
+    def grb_location
+      @grb ||= `which grb`.chomp
+    end
+
+    def current_branch
+      Head.current(repo).name
+    end
+  
+    def release_branches
+      branches = repo.branches.select {|e| e.name =~ /[\d]+\.[\d]+\.[\d]+/ || e.name == 'master'}.collect{|e| e.name}.sensible_sort
+      commits_per_branch = Dictionary.alpha
+      branches.each_with_index do | branch, index |
+        if branch == "master"
+          commits_per_branch[branch] = repo.commits_between(branches[index - 1], branch)
+        else
+          commits_per_branch[branch] = repo.commits(branch).sort{|a, b| b.date <=> a.date}
+        end
+      end
+      commits_per_branch
+    end
+
+    def update_changes_files
+      rest_of_message = "between #{@options.previous_version} and #{@options.new_version}" if @options.new_version && @options.previous_version
+      rest_of_message = "between #{current_branch} and #{@options.new_version}" if @options.new_version && !@options.previous_version
+      rest_of_message = "" unless @options.new_version && @options.create_branch
+      unless self.diffs.empty?
+        File.open('CHANGES', 'w') do | f |
+          self.diffs.each do | diff |
+            f << diff.formatted_for_changes_file
+          end
+        end
+        puts "created/updated CHANGES for differences #{rest_of_message}"
+        repo.add('CHANGES') if @options.create_branch
+      end
+
+      FileUtils.mkdir_p(@options.changes_dot_xml_directory) unless File.exists?(@options.changes_dot_xml_directory)
+      changes_dot_xml_file = File.join(@options.changes_dot_xml_directory, 'changes.xml')
+      File.open(changes_dot_xml_file, 'w') do | f |
+        write_to_file = lambda {|s| f << s}
+        changes_dot_xml_header( &write_to_file )
+        release_branches.each_pair do | branch_name, commits |
+          next if commits.nil? || commits.empty?
+          f << "    <release version='#{branch_name == 'master' ? @options.new_version : branch_name}' date='#{commits.last.date}' description='#{commits.last.message.chomp[0..10]}'>\n"
+          commits.each do | commit |
+            CommitSnapshot.new(commit).formatted_for_changes_dot_xml_file( &write_to_file )
+          end
+          f << "    </release>\n"
+        end
+      
+        changes_dot_xml_footer( &write_to_file )
+        puts "created/updated changes.xml for differences #{rest_of_message}"
+        repo.add(changes_dot_xml_file) if @options.create_branch
+      end
+    end
+  
+    def update_dot_gitignore
+      lines = (File.exists?('.gitignore') ? File.readlines('.gitignore') : []).collect{|line| line.chomp}
+      lines.delete_if {|line| line == 'CHANGES' || line.include?('changes.xml')}
+      File.open('.gitignore', 'w') do | f |
+        lines.each do | line |
+          f << "#{line}\n"
+        end
+      end
+    end
+
+    def update_pom_dot_xml
+      return unless File.exists?('pom.xml')
+      xml = File.read('pom.xml')
+      doc = Document.new(xml)
+      doc.root.elements["version"].text = @options.new_version
+      File.open('pom.xml', 'w') do | f |
+        f << doc.to_s
+      end
+    end
+
+    def changes_dot_xml_header
+      v = %Q{<document>\n  <properties>\n    <title>#{@options.title}</title>\n  </properties>\n  <body>\n}
+      yield v if block_given?
+      v
+    end
+
+    def changes_dot_xml_footer
+      v = %Q{\n  </body>\n</document>}
+      yield v if block_given?
+      v
+    end
+end
+
+class CommitSnapshot
+  ATTRIBUTES = [:commit_ref, :author, :email, :date, :messages]
+  attr_accessor(*ATTRIBUTES)
+
+  def initialize(*args)
+    if args[0].kind_of? Hash
+      ATTRIBUTES.each do | sym |
+        self.instance_variable_set "@#{sym}", args[0][sym]
+      end
+      if self.messages
+        self.messages = (self.messages.kind_of?(String) ? self.messages.split(/[;\n]/) : self.messages).delete_if{|e| e.empty?}
+      end
+      self.date = Time.parse( self.date ) if self.date && !self.date.kind_of?(Time)
+    else
+      commit = args[0]
+      initialize(:commit_ref => commit.id_abbrev, :author => commit.author.name, :email => commit.author.email, :date => commit.date, :messages => commit.message)
+    end
+  end
+
+  def formatted_date
+    self.date.strftime('%Y-%m-%d')
+  end
+
+  def formatted_for_changes_file
+    separator = ('-' * self.author.length) + '---------------------------'
+    each_message = self.messages.join("\n")
+    each_message.gsub!(/(.{1,80}|\S{81,})(?: +|$\n?)/, "    \\1\n")
+    v = "#{separator}\n  %s on %s, %s\n#{separator}\n%s\n\n" % [self.author, formatted_date, self.commit_ref[0...7], each_message]
+    yield v if block_given?
+    v
+  end
+
+  def formatted_for_changes_dot_xml_file
+    # <action dev=.. due-to=.. due-to-email=.. issue=.. type=.. system=.. date=.. >
+    template = "      <action dev='%s' type='%s' date='%s'><![CDATA[%s: %s]]></action>\n"
+    reference = self.commit_ref[0...7]
+    v = self.messages.collect { | message_within_commit |
+      msg = message_within_commit.downcase
+      action_type = if !!(msg =~ /bug|fix/)
+        'fix'
+      elsif !!(msg =~ /update/)
+        'update'
+      elsif !!(msg =~ /remove/)
+        'remove'
+      else
+        'add'
+      end
+
+      template % [self.author, action_type, formatted_date, reference, message_within_commit]
+    }.join('')
+    yield v if block_given?
+    v
+  end
+end
+
+module Enumerable
+  # kudos to Piers Cawley: http://www.bofh.org.uk/2007/12/16/comprehensible-sorting-in-ruby 
+  def sensible_sort
+    sort_by {|k| k.to_s.split(/((?:(?:^|\s)[-+])?(?:\.\d+|\d+(?:\.\d+?(?:[eE]\d+)?(?:$|(?![eE\.])))?))/ms).map {|v| Float(v) rescue v.downcase}}
+  end
+end
+
+if __FILE__ == $0
+  # Create and run the application
+  app = GrowthSpurt.new(ARGV, STDIN)
+  app.run
+end

data/test/test_growthspurt.rb

@@ -0,0 +1,2 @@
+puts "tests??? later..."
+true

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: jacaetevha-growthspurt
+version: !ruby/object:Gem::Version 
+  version: 1.0.6
+platform: ruby
+authors: 
+- Jason Rogers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-13 00:00:00 -07:00
+default_executable: growthspurt
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: facets
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.5.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: grit
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.1
+    version: 
+description: ""
+email: jacaetevha@gmail.com
+executables: 
+- growthspurt
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- VERSION
+- bin/growthspurt
+- lib/growthspurt.rb
+has_rdoc: true
+homepage: http://github.com/jacaetevha/growth-spurt
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: ""
+test_files: 
+- test/test_growthspurt.rb