right_git 0.0.2

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+== 0.0.1
+
+Added functionality suitable for checkout, listing and general repo maintenance.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013- RightScale, Inc.
+
+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/README.rdoc

@@ -0,0 +1,13 @@
+RightGit is an assortment of git-related classes created by RightScale.
+
+Maintained by the RightScale Teal Team
+
+== What Does It Do?
+
+=== Repository Management
+
+Provides an API for managing a git repository that is suitable for
+automation. It is assumed that gestures like creating a new repository,
+branch or tag are manual tasks beyond the scope of automation so those are
+not covered here. What is provided are APIs for cloning, fetching, listing
+and grooming git-related objects.

data/Rakefile

@@ -0,0 +1,48 @@
+# -*-ruby-*-
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rake'
+require 'rdoc/task'
+require 'rubygems/package_task'
+
+require 'rake/clean'
+require 'rspec/core/rake_task'
+
+desc "Run unit tests"
+task :default => :spec
+
+desc "Run unit tests"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = Dir['**/*_spec.rb']
+end
+
+desc 'Generate documentation for the right_git gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = 'RightGit'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.exclude('spec/**/*')
+end
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification; see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = 'right_git'
+  gem.homepage = 'https://github.com/rightscale/right_git'
+  gem.license = 'MIT'
+  gem.summary = %Q{Reusable Git repository management code.}
+  gem.description = %Q{An assortment of git-related classes created by RightScale.}
+  gem.email = 'support@rightscale.com'
+  gem.authors = ['Tony Spataro', 'Scott Messier']
+  gem.rubygems_version = '1.3.7'
+  gem.files.exclude 'Gemfile*'
+  gem.files.exclude 'right_git.rconf'
+  gem.files.exclude 'spec/**/*'
+end
+
+Jeweler::RubygemsDotOrgTasks.new
+
+CLEAN.include('pkg')

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/right_git/git/branch.rb

@@ -0,0 +1,137 @@
+#
+# Copyright (c) 2013 RightScale Inc
+#
+# 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.
+
+# ancestor
+require 'right_git/git'
+
+module RightGit::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})/
+
+    DEFAULT_DISPLAY_WIDTH = 40
+
+    ELLIPSIS = '...'
+
+    class BranchError < GitError; end
+
+    attr_reader :repo, :fullname
+
+    # @param [Repository] repo hosting branch
+    # @param [String] line of git output describing branch
+    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] || fullname.index('/'))
+          @repo = repo
+        else
+          raise BranchError, 'Unreachable due to already matching name pattern'
+        end
+      else
+        raise BranchError, "Unrecognized branch info: #{line.inspect}"
+      end
+    end
+
+    # @return [String] stringized
+    def to_s
+      "#{self.class.name}: #{@fullname.inspect}"
+    end
+    alias inspect to_s
+
+    # @param [Regexp] regexp
+    # @return [Integer] match offset
+    def =~(other)
+      @fullname =~ other
+    end
+
+    # @param [Branch] other
+    # @return [TrueClass|FalseClass] true if equivalent
+    def ==(other)
+      if other.kind_of?(self.class)
+        @fullname == other.fullname
+      else
+        false
+      end
+    end
+
+    # @param [Branch] other
+    # @return [Integer] comparison value
+    def <=>(other)
+      if other.kind_of?(self.class)
+        @fullname <=> other.fullname
+      else
+        raise ::ArgumentError, 'Wrong type'
+      end
+    end
+
+    # @return [TrueClass|FalseClass] true if branch is remote
+    def remote?
+      @remote
+    end
+
+    # @return [String] name of branch sans origin (if any)
+    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
+
+    # For display in a column of given width.
+    #
+    # @param [Integer] width for columns
+    #
+    # @return [String] display string
+    def display(width = DEFAULT_DISPLAY_WIDTH)
+      if @fullname.length >= width
+        (@fullname[0..(width - ELLIPSIS.length - 1)] + ELLIPSIS).ljust(width)
+      else
+        @fullname.ljust(width)
+      end
+    end
+
+    # Deletes this (local or remote) branch.
+    #
+    # @return [TrueClass] always true
+    def delete
+      if self.remote?
+        @repo.vet_output("push origin :#{self.name}")
+      else
+        @repo.vet_output("branch -D #{@fullname}")
+      end
+      true
+    end
+
+  end # Branch
+end # RightGit

data/lib/right_git/git/branch_collection.rb

@@ -0,0 +1,107 @@
+#
+# Copyright (c) 2013 RightScale Inc
+#
+# 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.
+
+# ancestor
+require 'right_git/git'
+
+module RightGit::Git
+
+  # A collection of Git branches. Acts a bit like an Array, allowing it to be
+  # mapped, sorted and compared as such.
+  class BranchCollection
+    # @param [Repository] repo to host branch collection
+    # @param [Array] args as subset of branches or empty
+    def initialize(repo, *args)
+      @repo = repo
+      @branches = args
+    end
+
+    def to_s
+      "#{self.class.name}: #{@branches.inspect}"
+    end
+    alias inspect to_s
+
+    # Filters on local branches.
+    #
+    # @return [BranchCollection] local branches
+    def local
+      local = BranchCollection.new(@repo)
+      @branches.each do |branch|
+        local << branch unless branch.remote?
+      end
+      local
+    end
+
+    # Filters on remote branches.
+    #
+    # @return [BranchCollection] remote branches
+    def remote
+      remote = BranchCollection.new(@repo)
+      @branches.each do |branch|
+        remote << branch if branch.remote?
+      end
+      remote
+    end
+
+    # Queries and filters on branches reachable from the given revision, if any.
+    #
+    # @param [String] revision for listing reachable merged branches
+    #
+    # @return [BranchCollection] merged branches
+    def merged(revision)
+      git_args = ['branch', '-r', '--merged', revision]
+      all_merged = @repo.git_output(git_args).lines.map do |line|
+        Branch.new(@repo, line)
+      end
+
+      merged = BranchCollection.new(@repo)
+      @branches.each do |candidate|
+        # For some reason Set#include? does not play nice with our overridden comparison operators
+        # for branches, so we need to do this the hard way :(
+        merged << candidate if all_merged.detect { |b| candidate == b }
+      end
+      merged
+    end
+
+    # Accessor that acts like either a Hash or Array accessor
+    def [](argument)
+      case argument
+      when String
+        target = Branch.new(@repo, argument)
+        @branches.detect { |b| b == target }
+      else
+        @branches.__send__(:[], argument)
+      end
+    end
+
+    def method_missing(meth, *args, &block)
+      result = @branches.__send__(meth, *args, &block)
+
+      if result.is_a?(::Array)
+        BranchCollection.new(@repo, *result)
+      else
+        result
+      end
+    end
+
+  end # BranchCollection
+end # RightGit

data/lib/right_git/git/commit.rb

@@ -0,0 +1,76 @@
+#
+# Copyright (c) 2013 RightScale Inc
+#
+# 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.
+
+# ancestor
+require 'right_git/git'
+
+module RightGit::Git
+
+  # A commit within a Git repository.
+  class Commit
+    COMMIT_INFO = /^([0-9A-Fa-f]+) ([0-9]+) (.*)$/
+
+    COMMIT_SHA1_REGEX = /^[0-9a-fA-F]{40}$/
+
+    attr_reader :repo
+
+    class CommitError < GitError; end
+
+    # @param [Repository] repo hosting commit
+    # @param [String] line of git output describing commit
+    def initialize(repo, line)
+      @repo = repo
+      unless match = COMMIT_INFO.match(line)
+        raise CommitError, "Unrecognized commit summary: #{line.inspect}"
+      end
+      @info = [ match[1], Integer(match[2]), match[3] ]
+    end
+
+    # @return [String] stringized
+    def to_s
+      "#{self.class.name}: #{@info.inspect}"
+    end
+    alias inspect to_s
+
+    # @return [String] hash of commit (may be abbreviated)
+    def hash
+      # This overrides String#hash on purpose
+      @info[0]
+    end
+
+    # @return [Time] time of commit
+    def timestamp
+      ::Time.at(@info[1])
+    end
+
+    # @return [String] author of commit
+    def author
+      @info[2]
+    end
+
+    # @return [TrueClass|FalseClass] true if the given revision is a (fully qualified, not abbreviated) commit SHA
+    def self.sha?(revision)
+      !!COMMIT_SHA1_REGEX.match(revision)
+    end
+
+  end # Commit
+end # RightGit