right_develop 2.0.2 → 2.1.0

data/VERSION

@@ -1 +1 @@
-2.0.2
+2.1.0

data/lib/right_develop/commands/git.rb

@@ -20,17 +20,24 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+require 'set'
+require 'uri'
+
 require 'right_git'
+require 'right_support'
+
 require 'right_develop'
-require "action_view"
 
 module RightDevelop::Commands
   class Git
+    include RightSupport::Log::Mixin
+
     NAME_SPLIT_CHARS = /-|_|\//
     YES              = /(ye?s?)/i
     NO               = /(no?)/i
-
-    TASKS = %w(prune)
+    TASKS            = %w(prune tickets)
+    MERGE_COMMENT    = /^Merge (?:remote[- ])?(?:tracking )?(?:branch|pull request #[0-9]+ from) ['"]?(.*)['"]?$/i
+    WORD_BOUNDARY    = %r{[_ /-]+}
 
     # Parse command-line options and create a Command object
     def self.create
@@ -48,62 +55,85 @@ Where <task> is one of:
 #{task_list}
 
 And [options] are selected from:
-EOS
+        EOS
         opt :age, "Minimum age to consider",
-              :default => "3.months"
-        opt :only, "Limit to branches matching this prefix", 
-              :type=>:string
+            :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.]+|)"
+            :type    => :string,
+            :default => "(release|ve?r?)?[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
+        opt :merged, "Limit to branches that are merged into this branch",
+            :type    => :string,
+            :default => "master"
+        opt :since, "Base branch or tag to compare against for determining 'new' commits",
+            :default => "origin/master"
+        opt :link, "Word prefix indicating a link to an external ticketing system",
+            :default => "(?:[#A-Za-z]+)([0-9]+)$"
+        opt :link_to, "URL pattern to generate ticket links, don't forget trailing slash!",
+            :type => :string
+        opt :debug, "Enable verbose debug output",
+            :default => false
       end
 
       task = ARGV.shift
 
+      repo = ::RightGit::Git::Repository.new(
+        ::Dir.pwd,
+        ::RightDevelop::Utility::Git::DEFAULT_REPO_OPTIONS)
+
       case task
       when "prune"
-        repo = ::RightGit::Git::Repository.new(
-          ::Dir.pwd,
-          ::RightDevelop::Utility::Git::DEFAULT_REPO_OPTIONS)
         self.new(repo, :prune, options)
+      when "tickets"
+        self.new(repo, :tickets, options)
       else
         Trollop.die "unknown task #{task}"
       end
     end
 
+    # @param [RightGit::Git::Repository] repo the Git repository to operate on
+    # @param [Symbol] task one of :prune or :tickets
     # @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 [Boolean] :local Consider only local branches
+    # @option options [Boolean] :remote Consider only remote branches
     # @option options [String] :merged Consider only branches that are fully merged into this branch (e.g. master)
+    # @option options [String] :since the name of a "base branch" representing the previous release
+    # @option options [String] :link word prefix connoting a link to an external ticketing system
+    # @option options [String] :link_to URL prefix to use when generating ticket links
     def initialize(repo, task, options)
+      logger                                  = Logger.new(STDERR)
+      logger.level                            = options[:debug] ? Logger::DEBUG : Logger::WARN
+      RightSupport::Log::Mixin.default_logger = logger
+
       # Post-process "age" option; transform from natural-language expression into a timestamp.
       if (age = options.delete(:age))
-        require 'ruby-debug'
-        debugger
-        age = parse_age(age)
+        age           = parse_age(age)
         options[:age] = age
       end
 
       # Post-process "except" option; transform into a Regexp.
       if (except = options.delete(:except))
-        except = Regexp.new("^(origin/)?(#{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})")
+        only           = Regexp.new("^(origin/)?(#{only})")
         options[:only] = only
       end
 
+      # Post-process "since" option; transform into a Regexp.
+      if (link = options.delete(:link))
+        link           = Regexp.new("^#{link}")
+        options[:link] = link
+      end
+
       @git     = repo
       @task    = task
       @options = options
@@ -115,6 +145,8 @@ EOS
       case @task
       when :prune
         prune(@options)
+      when :tickets
+        tickets(@options)
       else
         raise StateError, "Invalid @task; check Git.create!"
       end
@@ -127,11 +159,16 @@ EOS
     # @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 [Boolean] :local Consider only local branches
+    # @option options [Boolean] :remote Consider only 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
+      puts describe_prune(options)
+
+      puts "Fetching latest branches and tags from remotes"
+      @git.fetch_all(:prune => true)
+
+      branches = @git.branches(:all => true)
 
       #Filter by name prefix
       branches = branches.select { |x| x =~ options[:only] } if options[:only]
@@ -148,12 +185,13 @@ EOS
 
       #Filter by merge status
       if options[:merged]
+        puts "Checking merge status of #{branches.size} branches; please be patient"
         branches = branches.merged(options[:merged])
       end
 
       old = {}
       branches.each do |branch|
-        latest = @git.log(branch, :tail=>1).first
+        latest    = @git.log(branch, :tail => 1).first
         timestamp = latest.timestamp
         if timestamp < options[:age] &&
           old[branch] = timestamp
@@ -161,10 +199,12 @@ EOS
       end
 
       if old.empty?
-        STDERR.puts "No branches older than #{time_ago_in_words(options[:age])} found; do you need to specify --remote?"
+        STDERR.puts "No branches found; try different options"
         exit -2
       end
 
+      puts
+
       all_by_prefix = branches.group_by { |b| b.name.split(NAME_SPLIT_CHARS).first }
 
       all_by_prefix.each_pair do |prefix, branches|
@@ -185,11 +225,97 @@ EOS
 
       old.each do |branch, timestamp|
         branch.delete
+        puts "  deleted #{branch}"
+      end
+    end
+
+    # Produce a report of all the tickets that have been merged into the named branch. This works
+    # by scanning merge commit comments, recognizing words that look like a ticket reference, and
+    # extracting a matched segment as the ticket ID. The user must specify a matching Regexp using
+    # the :link option.
+    #
+    # @example Match Acunote stories
+    #   git.tickets(:link=>/acu([0-9]+)/)
+    #
+    # @option options [String] :since the name of a "base branch" representing the previous release
+    # @option options [Regexp] :merged the name of a branch (e.g. master) representing the next release
+    # @option options [Regexp] :link a word prefix that connotes links to an external ticketing system
+    # @option options [Boolean] :local Consider only local branches
+    # @option options [Boolean] :remote Consider only remote branches
+    def tickets(options={})
+      since  = options[:since]
+      merged = options[:merged]
+
+      tickets = Set.new
+      link    = options[:link]
+
+      @git.log("#{since}..#{merged}", :merges => true).each do |commit|
+        if (match = MERGE_COMMENT.match(commit.comment))
+          words = match[1].split(WORD_BOUNDARY)
+        else
+          words = commit.comment.split(WORD_BOUNDARY)
+        end
+
+        got = words.detect do |w|
+          if match = link.match(w)
+            if match[1]
+              tickets << match[1]
+            else
+              raise ArgumentError, "Regexp '#{link}' lacks capture groups; please use a () somewhere"
+            end
+          else
+            nil
+          end
+        end
+        unless got
+          logger.warn "Couldn't infer a ticket link from '#{commit.comment}'"
+        end
+      end
+
+      if (link_to = options[:link_to])
+        link_to = link_to + '/' unless link_to =~ %r{/$}
+        tickets.each { |t| puts link_to + t }
+      else
+        tickets.each { |t| puts t }
       end
     end
 
     private
 
+    # Build a plain-English description of a prune command based on the
+    # options given.
+    # @param [Hash] options
+    def describe_prune(options)
+      statement = ['Pruning']
+
+      if options[:remote]
+        statement << 'remote'
+      elsif options[:local]
+        statement << 'local'
+      end
+
+      statement << 'branches'
+
+      if options[:age]
+        statement << "older than #{time_ago_in_words(options[:age])}"
+      end
+
+      if options[:merged]
+        statement << "that are fully merged into #{options[:merged]}"
+      end
+
+      if options[:only]
+        naming = "with a name containing '#{options[:only]}'"
+        if options[:except]
+          naming << " (but not '#{options[:except]}')"
+        end
+        statement << naming
+      end
+
+      statement.join(' ')
+    end
+
+    # Ask the user a yes-or-no question
     def prompt(p, yes_no=false)
       puts #newline for newline's sake!
 
@@ -217,6 +343,16 @@ EOS
       [1, 'second'],
     ]
 
+    # Workalike for ActiveSupport date-helper method. Given a Time in the past, return
+    # a natural-language English string that describes the duration separating that time from
+    # the present. The duration is very approximate, and will be rounded down to the nearest
+    # appropriate interval (e.g. 2.5 hours becomes 2 hours).
+    #
+    # @example about three days ago
+    #    time_ago_in_words(Time.now - 86400*3.1) # => "3 days"  
+    #
+    # @param [Time] once_upon_a the long-ago time to compare to Time.now
+    # @return [String] an English time duration
     def time_ago_in_words(once_upon_a)
       dt = Time.now.to_f - once_upon_a.to_f
 
@@ -225,7 +361,7 @@ EOS
       TIME_INTERVALS.each do |pair|
         mag, term = pair.first, pair.last
         if dt >= mag
-          units = dt / mag
+          units = Integer(dt / mag)
           words = "%d %s%s" % [units, term, units > 1 ? 's' : '']
           break
         end
@@ -238,9 +374,14 @@ EOS
       end
     end
 
+    # Given a natural-language English description of a time duration, return a Time in the past,
+    # that is the same duration from Time.now that is expressed in the string. 
+    #
+    # @param [String] str an English time duration
+    # @return [Time] a Time object in the past, as described relative to now by str
     def parse_age(str)
       ord, word = str.split(/[. ]+/, 2)
-      ord = Integer(ord)
+      ord       = Integer(ord)
       word.gsub!(/s$/, '')
 
       ago = nil

data/lib/right_develop/net.rb

@@ -21,7 +21,7 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 # Try to load RSpec 2.x - 1.x
-['rspec', 'spec'].each do |f|
+['rspec', 'rspec/mocks', 'spec'].each do |f|
   begin
     require f
   rescue LoadError

data/lib/right_develop/utility/git.rb

@@ -27,7 +27,6 @@ require 'right_git'
 module RightDevelop::Utility::Git
 
   DEFAULT_REPO_OPTIONS = {
-    :logger => ::RightDevelop::Utility::Shell.default_logger,
     :shell  => ::RightDevelop::Utility::Shell
   }.freeze
 

data/lib/right_develop/utility/shell.rb

@@ -75,9 +75,9 @@ module RightDevelop
         NullLoggerSingleton.instance
       end
 
-      # @return [Logger] default logger for STDOUT
+      # @return [Logger] RightSupport::Log::Mixin.default_logger
       def default_logger
-        @default_logger ||= ::Logger.new(STDOUT)
+        RightSupport::Log::Mixin.default_logger
       end
 
       # Overrides ::RightGit::Shell::Default#execute

data/right_develop.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{right_develop}
-  s.version = "2.0.2"
+  s.version = "2.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tony Spataro"]
-  s.date = %q{2014-01-13}
+  s.date = %q{2014-01-16}
   s.default_executable = %q{right_develop}
   s.description = %q{A toolkit of development tools created by RightScale.}
   s.email = %q{support@rightscale.com}
@@ -66,7 +66,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<rspec>, ["< 3.0", ">= 1.3"])
       s.add_runtime_dependency(%q<cucumber>, ["< 1.3.3", "~> 1.0"])
       s.add_runtime_dependency(%q<trollop>, ["< 3.0", ">= 1.0"])
-      s.add_runtime_dependency(%q<right_git>, [">= 0"])
+      s.add_runtime_dependency(%q<right_git>, ["~> 0.1.0"])
       s.add_runtime_dependency(%q<right_aws>, [">= 2.1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
       s.add_development_dependency(%q<rdoc>, [">= 2.4.2"])
@@ -77,7 +77,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rspec>, ["< 3.0", ">= 1.3"])
       s.add_dependency(%q<cucumber>, ["< 1.3.3", "~> 1.0"])
       s.add_dependency(%q<trollop>, ["< 3.0", ">= 1.0"])
-      s.add_dependency(%q<right_git>, [">= 0"])
+      s.add_dependency(%q<right_git>, ["~> 0.1.0"])
       s.add_dependency(%q<right_aws>, [">= 2.1.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
       s.add_dependency(%q<rdoc>, [">= 2.4.2"])
@@ -89,7 +89,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rspec>, ["< 3.0", ">= 1.3"])
     s.add_dependency(%q<cucumber>, ["< 1.3.3", "~> 1.0"])
     s.add_dependency(%q<trollop>, ["< 3.0", ">= 1.0"])
-    s.add_dependency(%q<right_git>, [">= 0"])
+    s.add_dependency(%q<right_git>, ["~> 0.1.0"])
     s.add_dependency(%q<right_aws>, [">= 2.1.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
     s.add_dependency(%q<rdoc>, [">= 2.4.2"])

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 2
+  - 1
   - 0
-  - 2
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors: 
 - Tony Spataro
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-01-13 00:00:00 -08:00
+date: 2014-01-16 00:00:00 -08:00
 default_executable: right_develop
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -143,12 +143,14 @@ dependencies:
   version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 27
         segments: 
         - 0
-        version: "0"
+        - 1
+        - 0
+        version: 0.1.0
   prerelease: false
   requirement: *id007
   name: right_git