pjhyett-grit 0.9.11

data/lib/grit/actor.rb

@@ -0,0 +1,36 @@
+module Grit
+  
+  class Actor
+    attr_reader :name
+    attr_reader :email
+    
+    def initialize(name, email)
+      @name = name
+      @email = email
+    end
+    alias_method :to_s, :name
+    
+    # Create an Actor from a string.
+    #   +str+ is the string, which is expected to be in regular git format
+    #
+    # Format
+    #   John Doe <jdoe@example.com>
+    #
+    # Returns Actor
+    def self.from_string(str)
+      case str
+        when /<.+>/
+          m, name, email = *str.match(/(.*) <(.+?)>/)
+          return self.new(name, email)
+        else
+          return self.new(str, nil)
+      end
+    end
+    
+    # Pretty object inspection
+    def inspect
+      %Q{#<Grit::Actor "#{@name} <#{@email}>">}
+    end
+  end # Actor
+  
+end # Grit

data/lib/grit/blob.rb

@@ -0,0 +1,117 @@
+module Grit
+  
+  class Blob
+    DEFAULT_MIME_TYPE = "text/plain"
+    
+    attr_reader :id
+    attr_reader :mode
+    attr_reader :name
+    
+    # Create an unbaked Blob containing just the specified attributes
+    #   +repo+ is the Repo
+    #   +atts+ is a Hash of instance variable data
+    #
+    # Returns Grit::Blob (unbaked)
+    def self.create(repo, atts)
+      self.allocate.create_initialize(repo, atts)
+    end
+    
+    # Initializer for Blob.create
+    #   +repo+ is the Repo
+    #   +atts+ is a Hash of instance variable data
+    #
+    # Returns Grit::Blob (unbaked)
+    def create_initialize(repo, atts)
+      @repo = repo
+      atts.each do |k, v|
+        instance_variable_set("@#{k}".to_sym, v)
+      end
+      self
+    end
+    
+    # The size of this blob in bytes
+    #
+    # Returns Integer
+    def size
+      @size ||= @repo.git.cat_file({:s => true}, id).chomp.to_i
+    end
+    
+    # The binary contents of this blob.
+    #
+    # Returns String
+    def data
+      @data ||= @repo.git.cat_file({:p => true}, id)
+    end
+    
+    # The mime type of this file (based on the filename)
+    #
+    # Returns String
+    def mime_type
+      guesses = MIME::Types.type_for(self.name) rescue []
+      guesses.first ? guesses.first.simplified : DEFAULT_MIME_TYPE
+    end
+    
+    # The blame information for the given file at the given commit
+    #
+    # Returns Array: [Grit::Commit, Array: [<line>]]
+    def self.blame(repo, commit, file)
+      data = repo.git.blame({:p => true}, commit, '--', file)
+      
+      commits = {}
+      blames = []
+      info = nil
+      
+      data.split("\n").each do |line|
+        parts = line.split(/\s+/, 2)
+        case parts.first
+          when /^[0-9A-Fa-f]{40}$/
+            case line
+              when /^([0-9A-Fa-f]{40}) (\d+) (\d+) (\d+)$/
+                _, id, origin_line, final_line, group_lines = *line.match(/^([0-9A-Fa-f]{40}) (\d+) (\d+) (\d+)$/)
+                info = {:id => id}
+                blames << [nil, []]
+              when /^([0-9A-Fa-f]{40}) (\d+) (\d+)$/
+                _, id, origin_line, final_line = *line.match(/^([0-9A-Fa-f]{40}) (\d+) (\d+)$/)
+                info = {:id => id}
+            end
+          when /^(author|committer)/
+            case parts.first
+              when /^(.+)-mail$/
+                info["#{$1}_email".intern] = parts.last
+              when /^(.+)-time$/
+                info["#{$1}_date".intern] = Time.at(parts.last.to_i)
+              when /^(author|committer)$/
+                info[$1.intern] = parts.last
+            end
+          when /^filename/
+            info[:filename] = parts.last
+          when /^summary/
+            info[:summary] = parts.last
+          when ''
+            c = commits[info[:id]]
+            unless c
+              c = Commit.create(repo, :id => info[:id],
+                                      :author => Actor.from_string(info[:author] + ' ' + info[:author_email]),
+                                      :authored_date => info[:author_date],
+                                      :committer => Actor.from_string(info[:committer] + ' ' + info[:committer_email]),
+                                      :committed_date => info[:committer_date],
+                                      :message => info[:summary])
+              commits[info[:id]] = c
+            end
+            _, text = *line.match(/^\t(.*)$/)
+            blames.last[0] = c
+            blames.last[1] << text
+            info = nil
+        end
+      end
+      
+      blames
+    end
+    
+    # Pretty object inspection
+    def inspect
+      %Q{#<Grit::Blob "#{@id}">}
+    end
+  end # Blob
+  
+end # Grit

data/lib/grit/commit.rb

@@ -0,0 +1,229 @@
+module Grit
+  
+  class Commit
+    attr_reader :id
+    lazy_reader :parents
+    lazy_reader :tree
+    lazy_reader :author
+    lazy_reader :authored_date
+    lazy_reader :committer
+    lazy_reader :committed_date
+    lazy_reader :message
+    lazy_reader :short_message
+    
+    # Instantiate a new Commit
+    #   +id+ is the id of the commit
+    #   +parents+ is an array of commit ids (will be converted into Commit instances)
+    #   +tree+ is the correspdonding tree id (will be converted into a Tree object)
+    #   +author+ is the author string
+    #   +authored_date+ is the authored Time
+    #   +committer+ is the committer string
+    #   +committed_date+ is the committed Time
+    #   +message+ is an array of commit message lines
+    #
+    # Returns Grit::Commit (baked)
+    def initialize(repo, id, parents, tree, author, authored_date, committer, committed_date, message)
+      @repo = repo
+      @id = id
+      @parents = parents.map { |p| Commit.create(repo, :id => p) }
+      @tree = Tree.create(repo, :id => tree)
+      @author = author
+      @authored_date = authored_date
+      @committer = committer
+      @committed_date = committed_date
+      @message = message.join("\n")
+      @short_message = message[0] || ''
+    end
+    
+    def id_abbrev
+      @id_abbrev ||= @repo.git.rev_parse({}, self.id).chomp[0, 7]
+    end
+    
+    # Create an unbaked Commit containing just the specified attributes
+    #   +repo+ is the Repo
+    #   +atts+ is a Hash of instance variable data
+    #
+    # Returns Grit::Commit (unbaked)
+    def self.create(repo, atts)
+      self.allocate.create_initialize(repo, atts)
+    end
+    
+    # Initializer for Commit.create
+    #   +repo+ is the Repo
+    #   +atts+ is a Hash of instance variable data
+    #
+    # Returns Grit::Commit (unbaked)
+    def create_initialize(repo, atts)
+      @repo = repo
+      atts.each do |k, v|
+        instance_variable_set("@#{k}", v)
+      end
+      self
+    end
+    
+    def lazy_source
+      self.class.find_all(@repo, @id, {:max_count => 1}).first
+    end
+    
+    # Count the number of commits reachable from this ref
+    #   +repo+ is the Repo
+    #   +ref+ is the ref from which to begin (SHA1 or name)
+    #
+    # Returns Integer
+    def self.count(repo, ref)
+      repo.git.rev_list({}, ref).strip.split("\n").size
+    end
+    
+    # Find all commits matching the given criteria.
+    #   +repo+ is the Repo
+    #   +ref+ is the ref from which to begin (SHA1 or name) or nil for --all
+    #   +options+ is a Hash of optional arguments to git
+    #     :max_count is the maximum number of commits to fetch
+    #     :skip is the number of commits to skip
+    #
+    # Returns Grit::Commit[] (baked)
+    def self.find_all(repo, ref, options = {})
+      allowed_options = [:max_count, :skip, :since]
+          
+      default_options = {:pretty => "raw"}
+      actual_options = default_options.merge(options)
+      
+      if ref
+        output = repo.git.rev_list(actual_options, ref)
+      else
+        output = repo.git.rev_list(actual_options.merge(:all => true))
+      end
+            
+      self.list_from_string(repo, output)
+    rescue Grit::GitRuby::Repository::NoSuchShaFound
+      []
+    end
+    
+    # Parse out commit information into an array of baked Commit objects
+    #   +repo+ is the Repo
+    #   +text+ is the text output from the git command (raw format)
+    #
+    # Returns Grit::Commit[] (baked)
+    #
+    # really should re-write this to be more accepting of non-standard commit messages
+    # - it broke when 'encoding' was introduced - not sure what else might show up
+    #
+    def self.list_from_string(repo, text)
+      lines = text.split("\n")
+      
+      commits = []
+            
+      while !lines.empty?
+        id = lines.shift.split.last
+        tree = lines.shift.split.last
+        
+        parents = []
+        parents << lines.shift.split.last while lines.first =~ /^parent/
+        
+        author, authored_date = self.actor(lines.shift)
+        committer, committed_date = self.actor(lines.shift)
+        
+        # not doing anything with this yet, but it's sometimes there
+        encoding = lines.shift.split.last if lines.first =~ /^encoding/
+        
+        lines.shift
+        
+        message_lines = []
+        message_lines << lines.shift[4..-1] while lines.first =~ /^ {4}/
+        
+        lines.shift while lines.first && lines.first.empty?
+        
+        commits << Commit.new(repo, id, parents, tree, author, authored_date, committer, committed_date, message_lines)
+      end
+      
+      commits
+    end
+    
+    # Show diffs between two trees:
+    #   +repo+ is the Repo
+    #   +a+ is a named commit
+    #   +b+ is an optional named commit.  Passing an array assumes you 
+    #     wish to omit the second named commit and limit the diff to the 
+    #     given paths.
+    #   +paths* is an array of paths to limit the diff.
+    #
+    # Returns Grit::Diff[] (baked)
+    def self.diff(repo, a, b = nil, paths = [])
+      if b.is_a?(Array)
+        paths = b
+        b     = nil
+      end
+      paths.unshift("--") unless paths.empty?
+      paths.unshift(b)    unless b.nil?
+      paths.unshift(a)
+      text = repo.git.diff({:full_index => true}, *paths)
+      Diff.list_from_string(repo, text)
+    end
+
+    def show
+      diff = @repo.git.show({:full_index => true, :pretty => 'raw'}, @id)
+      if diff =~ /diff --git a/
+        diff = diff.sub(/.+?(diff --git a)/m, '\1')
+      else
+        diff = ''
+      end
+      Diff.list_from_string(@repo, diff)
+    end
+
+    def diffs
+      if parents.empty?
+        show
+      else
+        self.class.diff(@repo, parents.first.id, @id) 
+      end
+    end
+    
+    # Convert this Commit to a String which is just the SHA1 id
+    def to_s
+      @id
+    end
+
+    def sha
+      @id
+    end
+    
+    def date
+      @committed_date
+    end
+    
+    # Pretty object inspection
+    def inspect
+      %Q{#<Grit::Commit "#{@id}">}
+    end
+    
+    # private
+    
+    # Parse out the actor (author or committer) info
+    #
+    # Returns [String (actor name and email), Time (acted at time)]
+    def self.actor(line)
+      m, actor, epoch = *line.match(/^.+? (.*) (\d+) .*$/)
+      [Actor.from_string(actor), Time.at(epoch.to_i)]
+    end
+
+    def to_hash
+      {
+        'id'       => id,
+        'parents'  => parents.map { |p| { 'id' => p.id } },
+        'tree'     => tree.id,
+        'message'  => message,
+        'author'   => {
+          'name'  => author.name,
+          'email' => author.email
+        },
+        'committer' => {
+          'name'  => committer.name,
+          'email' => committer.email
+        },
+        'authored_date'  => authored_date.xmlschema,
+        'committed_date' => committed_date.xmlschema,
+      }
+    end
+  end # Commit
+  
+end # Grit

data/lib/grit/commit_stats.rb

@@ -0,0 +1,104 @@
+module Grit
+  
+  class CommitStats
+    
+    attr_reader :id, :files, :additions, :deletions, :total
+    
+    # Instantiate a new CommitStats
+    #   +id+ is the id of the commit
+    #   +files+ is an array of :
+    #     [ [filename, adds, deletes, total],
+    #       [filename, adds, deletes, total],
+    #       [filename, adds, deletes, total] ]
+    #
+    # Returns Grit::CommitStats (baked)
+    def initialize(repo, id, files)
+      @repo = repo
+      @id = id
+      @files = files
+      @additions  = files.inject(0) { |total, a| total += a[1] } 
+      @deletions  = files.inject(0) { |total, a| total += a[2] } 
+      @total  = files.inject(0) { |total, a| total += a[3] } 
+    end
+    
+    # Find all commit stats matching the given criteria.
+    #   +repo+ is the Repo
+    #   +ref+ is the ref from which to begin (SHA1 or name) or nil for --all
+    #   +options+ is a Hash of optional arguments to git
+    #     :max_count is the maximum number of commits to fetch
+    #     :skip is the number of commits to skip
+    #
+    # Returns assoc array [sha, Grit::Commit[] (baked)]
+    def self.find_all(repo, ref, options = {})
+      allowed_options = [:max_count, :skip, :since]
+            
+      default_options = {:numstat => true}
+      actual_options = default_options.merge(options)
+      
+      if ref
+        output = repo.git.log(actual_options, ref)
+      else
+        output = repo.git.log(actual_options.merge(:all => true))
+      end
+      
+      self.list_from_string(repo, output)
+    end
+    
+    # Parse out commit information into an array of baked Commit objects
+    #   +repo+ is the Repo
+    #   +text+ is the text output from the git command (raw format)
+    #
+    # Returns assoc array [sha, Grit::Commit[] (baked)]
+    def self.list_from_string(repo, text)
+      lines = text.split("\n")
+      
+      commits = []
+
+      while !lines.empty?
+        id = lines.shift.split.last
+        
+        lines.shift
+        lines.shift
+        lines.shift
+        
+        message_lines = []
+        message_lines << lines.shift[4..-1] while lines.first =~ /^ {4}/
+        
+        lines.shift while lines.first && lines.first.empty?
+
+        files = []
+        while lines.first =~ /^(\d+)\s+(\d+)\s+(.+)/
+          (additions, deletions, filename) = lines.shift.split
+          additions = additions.to_i
+          deletions = deletions.to_i
+          total = additions + deletions
+          files << [filename, additions, deletions, total]
+        end
+        
+        lines.shift while lines.first && lines.first.empty?
+        
+        commits << [id, CommitStats.new(repo, id, files)]
+      end
+      
+      commits
+    end
+    
+    # Pretty object inspection
+    def inspect
+      %Q{#<Grit::CommitStats "#{@id}">}
+    end
+    
+    # private
+    
+    def to_hash
+      {
+        'id'        => id,
+        'files'     => files,
+        'additions' => additions,
+        'deletions' => deletions,
+        'total'     => total
+      }
+    end
+  end # CommitStats
+  
+end # Grit