right_develop 1.1.0 → 1.2.0

data/Gemfile

@@ -1,12 +1,18 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Runtime dependencies of RightDevelop
+
+# Gems used by the CI harness
 gem "rake", [">= 0.8.7", "< 0.10"]
 gem "right_support", "~> 2.0"
 gem "builder", "~> 3.0"
 gem "rspec", [">= 1.3", "< 3.0"]
 gem "cucumber", "~> 1.0"
 
+# Gems used by the command-line Git tools
+gem "trollop", [">= 1.0", "< 3.0"]
+gem "actionpack", [">= 2.3.0", "< 4.0"]
+
 # Gems used during RightDevelop development that should be called out in the gemspec
 group :development do
   gem "jeweler", "~> 1.8.3"

data/Gemfile.lock

@@ -1,59 +1,62 @@
 PATH
   remote: .
   specs:
-    right_develop (1.1.0)
+    right_develop (1.2.0)
+      actionpack (>= 2.3.0, < 4.0)
       builder (~> 3.0)
       cucumber (~> 1.0)
       rake (>= 0.8.7, < 0.10)
       right_support (~> 2.0)
       rspec (>= 1.3, < 3.0)
+      trollop (>= 1.0, < 3.0)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    activesupport (3.2.11)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
+    actionpack (2.3.17)
+      activesupport (= 2.3.17)
+      rack (~> 1.1.0)
+    activesupport (2.3.17)
     archive-tar-minitar (0.5.2)
-    builder (3.1.4)
+    builder (3.2.0)
     columnize (0.3.6)
-    cucumber (1.2.1)
+    cucumber (1.2.3)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.3)
-      gherkin (~> 2.11.0)
-      json (>= 1.4.6)
-    diff-lcs (1.1.3)
+      gherkin (~> 2.11.6)
+      multi_json (~> 1.3)
+    diff-lcs (1.2.1)
     flexmock (0.8.11)
     gherkin (2.11.6)
       json (>= 1.7.6)
     git (1.2.5)
-    i18n (0.6.1)
     jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
       rdoc
-    json (1.7.6)
+    json (1.7.7)
     libxml-ruby (2.4.0)
     linecache (0.46)
       rbx-require-relative (> 0.0.4)
     linecache19 (0.5.12)
       ruby_core_source (>= 0.1.4)
-    multi_json (1.5.0)
+    multi_json (1.6.1)
     nokogiri (1.5.6)
+    rack (1.1.6)
     rake (0.9.6)
     rbx-require-relative (0.0.9)
-    rdoc (3.12.1)
+    rdoc (4.0.0)
       json (~> 1.4)
     right_support (2.6.17)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.2)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
     ruby-debug (0.10.4)
       columnize (>= 0.1)
       ruby-debug-base (~> 0.10.4.0)
@@ -70,11 +73,13 @@ GEM
     ruby_core_source (0.1.5)
       archive-tar-minitar (>= 0.5.2)
     syntax (1.0.0)
+    trollop (2.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  actionpack (>= 2.3.0, < 4.0)
   activesupport
   builder (~> 3.0)
   cucumber (~> 1.0)
@@ -90,3 +95,4 @@ DEPENDENCIES
   ruby-debug (>= 0.10)
   ruby-debug19 (>= 0.11.6)
   syntax (~> 1.0.0)
+  trollop (>= 1.0, < 3.0)

data/README.rdoc

@@ -1,5 +1,7 @@
 RightDevelop is a library of reusable, unit- and functional-tested Ruby code that RightScale has found broadly useful.
 
+Maintained by the RightScale Teal Team
+
 == What Does It Do?
 
 === Continuous Integration

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/bin/right_develop

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+require "trollop"
+
+require "right_develop"
+
+gemspec = Gem.latest_spec_for("right_develop")
+
+commands = {}
+RightDevelop::Commands.constants.each do |konst|
+  name = konst.to_s.downcase
+  commands[name] = RightDevelop::Commands.const_get(konst.to_sym)
+end
+
+# Use a Trollop parser for help/banner display, but do not actually parse anything
+# just yet.
+command_list = commands.keys.map { |c| "       * #{c}" }.join("\n")
+p = Trollop::Parser.new do
+  version "right_develop #{gemspec.version} (c) 2013- RightScale, Inc."
+  banner <<-EOS
+A command-line interface to various tools offered by the right_develop gem.
+
+Usage:
+       right_develop <command> [options]
+
+Where <command> is one of:
+#{command_list}
+
+To get help on a command:
+       right_develop <command> --help
+EOS
+
+  stop_on commands.keys
+end
+
+opts = Trollop::with_standard_exception_handling p do
+  raise Trollop::HelpNeeded if ARGV.empty?
+  p.parse ARGV
+  cmd = ARGV.shift
+  commands[cmd].create.run
+end

data/lib/right_develop.rb

@@ -24,8 +24,10 @@ require 'right_support'
 
 # Autoload everything possible
 module RightDevelop
-  autoload :CI, 'right_develop/ci'
-  autoload :Parsers, 'right_develop/parsers'
+  autoload :CI,       'right_develop/ci'
+  autoload :Commands, 'right_develop/commands'
+  autoload :Git,      'right_develop/git'
+  autoload :Parsers,  'right_develop/parsers'
 end
 
 # Automatically include RightSupport networking extensions

data/lib/right_develop/ci/java_spec_formatter.rb

@@ -25,7 +25,7 @@ require 'time'
 require 'builder'
 
 # Try to load RSpec 2.x - 1.x formatters
-['rspec/core/formatters', 'spec/runner/formatter/base_text_formatter'].each do |f|
+['rspec/core', 'spec', 'rspec/core/formatters/base_text_formatter', 'spec/runner/formatter/base_text_formatter'].each do |f|
   begin
     require f
   rescue LoadError

data/lib/right_develop/commands.rb

@@ -0,0 +1,6 @@
+module RightDevelop
+  module Commands
+  end
+end
+
+require "right_develop/commands/git"

data/lib/right_develop/commands/git.rb

@@ -0,0 +1,190 @@
+require "action_view"
+
+module RightDevelop::Commands
+  class Git
+    include ActionView::Helpers::DateHelper
+
+    NAME_SPLIT_CHARS = /-|_|\//
+    YES              = /(ye?s?)/i
+    NO               = /(no?)/i
+
+    TASKS = %w(prune)
+
+    # Parse command-line options and create a Command object
+    def self.create
+      task_list = TASKS.map { |c| "       * #{c}" }.join("\n")
+
+      options = Trollop.options do
+        banner <<-EOS
+The 'git' command automates various repository management tasks. All tasks
+accept the same options, although not every option applies to every command.
+
+Usage:
+       right_develop git <task> [options]
+
+Where <task> is one of:
+#{task_list}
+
+And [options] are selected from:
+EOS
+        opt :age, "Minimum age to consider",
+              :default => "3.months"
+        opt :only, "Limit to branches matching this prefix", 
+              :type=>:string
+        opt :except, "Ignore branches matching this prefix",
+              :type=>:string,
+              :default => "^(release|v?[0-9.]+|)"
+        opt :local, "Limit to local branches"
+        opt :remote, "Limit to remote branches"
+        opt :merged, "Limit to branches that are fully merged into the named branch",
+              :type=>:string,
+              :default => "master"
+        stop_on TASKS
+      end
+
+      task = ARGV.shift
+
+      case task
+      when "prune"
+        git = RightDevelop::Git::Repository.new(Dir.pwd)
+        self.new(git, :prune, options)
+      else
+        Trollop.die "unknown task #{task}"
+      end
+    end
+
+    # @option options [String] :age Ignore branches newer than this time-ago-in-words e.g. "3 months"; default unit is months
+    # @option options [String] :except Ignore branches matching this regular expression
+    # @option options [String] :only Consider only branches matching this regular expression
+    # @option options [true|false] :local Consider local branches
+    # @option options [true|false] :remote Consider remote branches
+    # @option options [String] :merged Consider only branches that are fully merged into this branch (e.g. master)
+    def initialize(repo, task, options)
+      # Post-process "age" option; transform from natural-language expression into a timestamp.
+      if (age = options.delete(:age))
+        age = age.gsub(/\s+/, ".")
+
+        if age =~ /^[0-9]+\.?(hours|days|weeks|months|years)$/
+          age = eval(age).ago
+        elsif age =~ /^[0-9]+$/
+          age = age.to_i.months.ago
+        else
+          raise ArgumentError, "Can't parse age of '#{age}'"
+        end
+        options[:age] = age
+      end
+
+      # Post-process "except" option; transform into a Regexp.
+      if (except = options.delete(:except))
+        except = Regexp.new("^(origin/)?(#{except})")
+        options[:except] = except
+      end
+
+      # Post-process "only" option; transform into a Regexp.
+      if (only = options.delete(:only))
+        only = Regexp.new("^(origin/)?(#{only})")
+        options[:only] = only
+      end
+
+      @git     = repo
+      @task    = task
+      @options = options
+    end
+
+    # Run the task that was specified when this object was instantiated. This
+    # method does no work; it just delegates to a task method.
+    def run
+      case @task
+      when :prune
+        prune(@options)
+      else
+        raise StateError, "Invalid @task; check Git.create!"
+      end
+    end
+
+    protected
+
+    # Prune dead branches from the repository.
+    #
+    # @option options [Time] :age Ignore branches whose HEAD commit is newer than this timestamp
+    # @option options [Regexp] :except Ignore branches matching this pattern
+    # @option options [Regexp] :only Consider only branches matching this pattern
+    # @option options [true|false] :local Consider local branches
+    # @option options [true|false] :remote Consider remote branches
+    # @option options [String] :merged Consider only branches that are fully merged into this branch (e.g. master)
+    def prune(options={})
+      branches = @git.branches
+
+      #Filter by name prefix
+      branches = branches.select { |x| x =~ options[:only] } if options[:only]
+      branches = branches.reject { |x| x =~ options[:except] } if options[:except]
+
+      #Filter by location (local/remote)
+      if options[:local] && !options[:remote]
+        branches = branches.local
+      elsif options[:remote] && !options[:local]
+        branches = branches.remote
+      elsif options[:remote] && options[:local]
+        raise ArgumentError, "Cannot specify both --local and --remote!"
+      end
+
+      #Filter by merge status
+      if options[:merged]
+        branches = branches.merged(options[:merged])
+      end
+
+      old = {}
+      branches.each do |branch|
+        latest = @git.log(branch, :tail=>1).first
+        timestamp = latest.timestamp
+        if timestamp < options[:age] &&
+          old[branch] = timestamp
+        end
+      end
+
+      if old.empty?
+        STDERR.puts "No branches older than #{time_ago_in_words(options[:age])} found; do you need to specify --remote?"
+        exit -2
+      end
+
+      all_by_prefix = branches.group_by { |b| b.name.split(NAME_SPLIT_CHARS).first }
+
+      all_by_prefix.each_pair do |prefix, branches|
+        old_in_group = branches.select { |b| old.key?(b) }
+        next if old_in_group.empty?
+        old_in_group = old_in_group.sort { |a, b| old[a] <=> old[b] }
+        puts prefix
+        puts '-' * prefix.length
+        old_in_group.each do |b|
+          puts "\t" + b.display(40) + "\t" + time_ago_in_words(old[b])
+        end
+        puts
+      end
+
+      unless options[:force]
+        return unless prompt("Delete all #{old.size} branches above?", true)
+      end
+
+      old.each do |branch, timestamp|
+        branch.delete
+      end
+    end
+
+    private
+
+    def prompt(p, yes_no=false)
+      puts #newline for newline's sake!
+
+      loop do
+        print p, ' '
+        line = STDIN.readline.strip
+        if yes_no
+          return true if line =~ YES
+          return false if line =~ NO
+        else
+          return line
+        end
+      end
+    end
+  end
+end

data/lib/right_develop/git.rb

@@ -0,0 +1,22 @@
+module RightDevelop
+  module Git
+    # A Git command failed unexpectedly.
+    class CommandError < StandardError
+      attr_reader :output
+
+      def initialize(message)
+        @output = message
+        lines = message.split("\n").map { |l| l.strip }.reject { |l| l.empty? }
+        super(lines.last || @output)
+      end
+    end
+
+    # A Git command's output did not match with expected output.
+    class FormatError < StandardError; end
+  end
+
+  require "right_develop/git/branch"
+  require "right_develop/git/branch_collection"
+  require "right_develop/git/commit"
+  require "right_develop/git/repository"
+end

data/lib/right_develop/git/branch.rb

@@ -0,0 +1,74 @@
+module RightDevelop::Git
+  # A branch in a Git repository. Has some proxy methods that make it act a bit like
+  # a string, whose value is the name of the branch. This allows branches to be sorted,
+  # matched against Regexp, and certain other string-y operations.
+  class Branch
+    BRANCH_NAME     = '[#A-Za-z0-9._\/-]+'
+    BRANCH_INFO     = /(\* |  )?(#{BRANCH_NAME})( -> )?(#{BRANCH_NAME})?/
+    BRANCH_FULLNAME = /(remotes\/)?(#{BRANCH_NAME})/
+
+    def initialize(repo, line)
+      match = BRANCH_INFO.match(line)
+      if match && (fullname = match[2])
+        match = BRANCH_FULLNAME.match(fullname)
+        if match
+          @fullname = match[2]
+          @remote = !!match[1]
+          @repo = repo
+        else
+          raise FormatError, "Unrecognized branch name '#{line}'"
+        end
+      else
+        raise FormatError, "Unrecognized branch info '#{line}'"
+      end
+    end
+
+    def to_s
+      @fullname
+    end
+    alias inspect to_s
+
+    def =~(other)
+      @fullname =~ other
+    end
+
+    def ==(other)
+      self.to_s == other.to_s
+    end
+
+    def <=>(other)
+      self.to_s <=> other.to_s
+    end
+
+    def remote?
+      @remote
+    end
+
+    def name
+      if remote?
+        #remove the initial remote-name in the branch (origin/master --> master)
+        bits = @fullname.split('/')
+        bits.shift
+        bits.join('/')
+      else
+        @fullname
+      end
+    end
+
+    def display(width=40)
+      if @fullname.length >= width
+        (@fullname[0..(width-5)] + "...").ljust(width)
+      else
+        @fullname.ljust(width)
+      end
+    end
+
+    def delete
+      if self.remote?
+        @repo.shell("git push origin :#{self.name}")
+      else
+        @repo.shell("git branch -D #{@fullname}")
+      end
+    end
+  end
+end