schacon-grit 0.9.1

data/lib/grit/git.rb

@@ -0,0 +1,130 @@
+trap("CHLD") do
+  begin
+    Process.wait(-1, Process::WNOHANG)
+  rescue Object
+  end
+end
+
+module Grit
+  
+  class Git
+    class GitTimeout < RuntimeError
+      attr_reader :command, :bytes_read
+
+      def initialize(command = nil, bytes_read = nil)
+        @command = command
+        @bytes_read = bytes_read
+      end
+    end
+
+    undef_method :clone
+    
+    include GitRuby
+    
+    class << self
+      attr_accessor :git_binary, :git_timeout
+    end
+  
+    self.git_binary  = "/usr/bin/env git"
+    self.git_timeout = 5
+    
+    attr_accessor :git_dir, :bytes_read
+    
+    def initialize(git_dir)
+      self.git_dir    = git_dir
+      self.bytes_read = 0
+    end
+    
+    # Run the given git command with the specified arguments and return
+    # the result as a String
+    #   +cmd+ is the command
+    #   +options+ is a hash of Ruby style options
+    #   +args+ is the list of arguments (to be joined by spaces)
+    #
+    # Examples
+    #   git.rev_list({:max_count => 10, :header => true}, "master")
+    #
+    # Returns String
+    def method_missing(cmd, options = {}, *args)
+      run('', cmd, '', options, args)
+    end
+
+    def run(prefix, cmd, postfix, options, args)
+      timeout  = options.delete(:timeout)
+      timeout  = true if timeout.nil?
+
+      opt_args = transform_options(options)
+      ext_args = args.map { |a| a == '--' ? a : "'#{a}'" }
+      
+      call = "#{prefix}#{Git.git_binary} --git-dir='#{self.git_dir}' #{cmd.to_s.gsub(/_/, '-')} #{(opt_args + ext_args).join(' ')}#{postfix}"
+      Grit.log(call) if Grit.debug
+      response, err = timeout ? sh(call) : wild_sh(call)
+      Grit.log(response) if Grit.debug
+      Grit.log(err) if Grit.debug
+      response
+    end
+
+    def sh(command)
+      ret, pid, err = nil, nil, nil
+      Open4.popen4(command) do |id, _, stdout, stderr|
+        pid = id
+        ret = Timeout.timeout(self.class.git_timeout) { stdout.read }
+        err = stderr.read
+        @bytes_read += ret.size
+
+        if @bytes_read > 5242880 # 5.megabytes
+          bytes = @bytes_read
+          @bytes_read = 0
+          raise GitTimeout.new(command, bytes) 
+        end
+      end
+      [ret, err]
+    rescue Errno::ECHILD
+      [ret, err]
+    rescue Object => e
+      Process.kill('KILL', pid) rescue nil
+      bytes = @bytes_read
+      @bytes_read = 0
+      raise GitTimeout.new(command, bytes)
+    end
+
+    def wild_sh(command)
+      ret, err = nil, nil
+      Open4.popen4(command) {|pid, _, stdout, stderr|
+        ret = stdout.read
+        err = stderr.read
+      }
+      [ret, err]
+    rescue Errno::ECHILD
+      [ret, err]
+    end
+
+    # Transform Ruby style options into git command line options
+    #   +options+ is a hash of Ruby style options
+    #
+    # Returns String[]
+    #   e.g. ["--max-count=10", "--header"]
+    def transform_options(options)
+      args = []
+      options.keys.each do |opt|
+        if opt.to_s.size == 1
+          if options[opt] == true
+            args << "-#{opt}"
+          else
+            val = options.delete(opt)
+            args << "-#{opt.to_s} '#{val}'"
+          end
+        else
+          if options[opt] == true
+            args << "--#{opt.to_s.gsub(/_/, '-')}"
+          else
+            val = options.delete(opt)
+            args << "--#{opt.to_s.gsub(/_/, '-')}='#{val}'"
+          end
+        end
+      end
+      args
+    end
+  end # Git
+  
+end # Grit

data/lib/grit/head.rb

@@ -0,0 +1,83 @@
+module Grit
+  HEAD_PREFIX = 'refs/heads'
+  
+  # A Head is a named reference to a Commit. Every Head instance contains a name
+  # and a Commit object.
+  #
+  #   r = Grit::Repo.new("/path/to/repo")
+  #   h = r.heads.first
+  #   h.name       # => "master"
+  #   h.commit     # => #<Grit::Commit "1c09f116cbc2cb4100fb6935bb162daa4723f455">
+  #   h.commit.id  # => "1c09f116cbc2cb4100fb6935bb162daa4723f455"
+  class Head
+    attr_reader :name
+    attr_reader :commit
+    
+    # Instantiate a new Head
+    #   +name+ is the name of the head
+    #   +commit+ is the Commit that the head points to
+    #
+    # Returns Grit::Head (baked)
+    def initialize(name, commit)
+      @name = name
+      @commit = commit
+    end
+    
+    # Find all Heads
+    #   +repo+ is the Repo
+    #   +options+ is a Hash of options
+    #
+    # Returns Grit::Head[] (baked)
+    def self.find_all(repo, options = {})
+      default_options = {
+        :sort    => "committerdate",
+        :format  => "%(refname)%00%(objectname)",
+        :timeout => false
+      }
+                         
+      actual_options = default_options.merge(options)
+      
+      output = repo.git.for_each_ref(actual_options, HEAD_PREFIX)
+                 
+      self.list_from_string(repo, output)
+    end
+    
+    # Parse out head information into an array of baked head objects
+    #   +repo+ is the Repo
+    #   +text+ is the text output from the git command
+    #
+    # Returns Grit::Head[] (baked)
+    def self.list_from_string(repo, text)
+      heads = []
+      
+      text.split("\n").each do |line|
+        heads << self.from_string(repo, line)
+      end
+      
+      heads
+    end
+    
+    # Create a new Head instance from the given string.
+    #   +repo+ is the Repo
+    #   +line+ is the formatted head information
+    #
+    # Format
+    #   name: [a-zA-Z_/]+
+    #   <null byte>
+    #   id: [0-9A-Fa-f]{40}
+    #
+    # Returns Grit::Head (baked)
+    def self.from_string(repo, line)
+      full_name, id = line.split("\0")
+      name = full_name.sub("#{HEAD_PREFIX}/", '')
+      commit = Commit.create(repo, :id => id)
+      self.new(name, commit)
+    end
+    
+    # Pretty object inspection
+    def inspect
+      %Q{#<Grit::Head "#{@name}">}
+    end
+  end # Head
+  
+end # Grit

data/lib/grit/index.rb

@@ -0,0 +1,102 @@
+module Grit
+  
+  class Index
+    attr_accessor :repo, :tree
+    
+    def initialize(repo)
+      self.repo = repo
+      self.tree = {}
+    end
+    
+    # Add a file to the index
+    #   +path+ is the path (including filename)
+    #   +data+ is the binary contents of the file
+    #
+    # Returns nothing
+    def add(file_path, data)
+      path = file_path.split('/')
+      filename = path.pop
+      
+      current = self.tree
+      
+      path.each do |dir|
+        current[dir] ||= {}
+        node = current[dir]
+        current = node
+      end
+      
+      current[filename] = data
+    end
+        
+    # Commit the contents of the index
+    #   +message+ is the commit message
+    #
+    # Returns a String of the SHA1 of the commit
+    def commit(message, parents = nil, actor = nil, last_tree = nil)
+      tree_sha1 = write_tree(self.tree)
+      return false if tree_sha1 == last_tree # don't write identical commits
+      
+      contents = []
+      contents << ['tree', tree_sha1].join(' ')
+      parents.each do |p|
+        contents << ['parent', p].join(' ') if p        
+      end if parents
+
+      if actor
+        name = actor.name
+        email = actor.email
+      else
+        config = Config.new(self.repo)
+        name = config['user.name']
+        email = config['user.email']
+      end
+    
+      author_string = "#{name} <#{email}> #{Time.now.to_i} -0700" # !! TODO : gotta fix this
+      contents << ['author', author_string].join(' ')
+      contents << ['committer', author_string].join(' ')
+      contents << ''
+      contents << message
+      
+      commit_sha1 = self.repo.git.ruby_git.put_raw_object(contents.join("\n"), 'commit')      
+      
+      # self.repo.git.update_ref({}, 'HEAD', commit_sha1)
+      File.open(File.join(self.repo.path, 'refs', 'heads', 'master'), 'w') do |f|
+        f.write(commit_sha1)
+      end if commit_sha1
+      
+      commit_sha1
+    end
+    
+    # Recursively write a tree to the index
+    #   +tree+ is the tree
+    #
+    # Returns the SHA1 String of the tree
+    def write_tree(tree)
+      tree_contents = ''
+      tree.each do |k, v|
+        case v
+          when String:
+            sha = write_blob(v)
+            sha = [sha].pack("H*")
+            str = "%s %s\0%s" % ['100644', k, sha]
+            tree_contents += str
+          when Hash:
+            sha = write_tree(v)
+            sha = [sha].pack("H*")
+            str = "%s %s\0%s" % ['040000', k, sha]
+            tree_contents += str
+        end
+      end
+      self.repo.git.ruby_git.put_raw_object(tree_contents, 'tree')
+    end
+    
+    # Write the blob to the index
+    #   +data+ is the data to write
+    #
+    # Returns the SHA1 String of the blob
+    def write_blob(data)
+      self.repo.git.ruby_git.put_raw_object(data, 'blob')
+    end
+  end # Index
+  
+end # Grit

data/lib/grit/lazy.rb

@@ -0,0 +1,31 @@
+##
+# Allows attributes to be declared as lazy, meaning that they won't be
+# computed until they are asked for. 
+#
+# Works by delegating each lazy_reader to a cached lazy_source method.
+#
+# class Person
+#   lazy_reader :eyes
+#
+#   def lazy_source
+#     OpenStruct.new(:eyes => 2)
+#   end
+# end
+#
+# >> Person.new.eyes
+# => 2
+#
+module Lazy
+  def lazy_reader(*args)
+    args.each do |arg|
+      ivar = "@#{arg}"
+      define_method(arg) do
+        val = instance_variable_get(ivar) 
+        return val if val
+        instance_variable_set(ivar, (@lazy_source ||= lazy_source).send(arg))
+      end
+    end
+  end
+end
+
+Object.extend Lazy unless Object.ancestors.include? Lazy

data/lib/grit/ref.rb

@@ -0,0 +1,95 @@
+module Grit
+
+  class Ref
+
+    class << self
+
+      # Find all Refs
+      #   +repo+ is the Repo
+      #   +options+ is a Hash of options
+      #
+      # Returns Grit::Ref[] (baked)
+      def find_all(repo, options = {})      
+        refs = []
+
+        Dir.chdir(repo.path) do
+          if File.file?('packed-refs')
+            File.readlines('packed-refs').each do |line|
+              if m = /^(\w{40}) (.*?)$/.match(line)
+                next if !Regexp.new('^' + prefix).match(m[2])
+                name = m[2].sub("#{prefix}/", '')
+                commit = Commit.create(repo, :id => m[1])
+                refs << self.new(name, commit)
+              end
+            end
+          end
+          
+          files = Dir.glob(prefix + '/**/*')
+          files.each do |ref|
+            next if !File.file?(ref)
+            id = File.read(ref).chomp
+            name = ref.sub("#{prefix}/", '')
+            commit = Commit.create(repo, :id => id)
+            refs << self.new(name, commit)
+          end
+        end
+                
+        refs
+      end
+
+      protected
+
+        def prefix
+          "refs/#{name.to_s.gsub(/^.*::/, '').downcase}s"
+        end
+
+    end
+
+    attr_reader :name
+    attr_reader :commit
+
+    # Instantiate a new Head
+    #   +name+ is the name of the head
+    #   +commit+ is the Commit that the head points to
+    #
+    # Returns Grit::Head (baked)
+    def initialize(name, commit)
+      @name = name
+      @commit = commit
+    end
+
+    # Pretty object inspection
+    def inspect
+      %Q{#<#{self.class.name} "#{@name}">}
+    end
+  end # Ref
+
+  # A Head is a named reference to a Commit. Every Head instance contains a name
+  # and a Commit object.
+  #
+  #   r = Grit::Repo.new("/path/to/repo")
+  #   h = r.heads.first
+  #   h.name       # => "master"
+  #   h.commit     # => #<Grit::Commit "1c09f116cbc2cb4100fb6935bb162daa4723f455">
+  #   h.commit.id  # => "1c09f116cbc2cb4100fb6935bb162daa4723f455"
+  class Head < Ref
+
+    # Get the HEAD revision of the repo.
+    #   +repo+ is the Repo
+    #   +options+ is a Hash of options
+    #
+    # Returns Grit::Head (baked)
+    def self.current(repo, options = {})
+      head = File.open(File.join(repo.path, 'HEAD')).read.chomp
+      if /ref: refs\/heads\/(.*)/.match(head)
+        self.new($1, repo.git.rev_parse(options, 'HEAD'))
+      end
+    end
+
+  end # Head
+
+  class Tag < Ref ; end
+
+  class Remote < Ref; end
+  
+end # Grit

data/lib/grit/repo.rb

@@ -0,0 +1,381 @@
+module Grit
+  
+  class Repo
+    DAEMON_EXPORT_FILE = 'git-daemon-export-ok'
+    
+    # The path of the git repo as a String
+    attr_accessor :path
+    attr_reader :bare
+    
+    # The git command line interface object
+    attr_accessor :git
+    
+    # Create a new Repo instance
+    #   +path+ is the path to either the root git directory or the bare git repo
+    #
+    # Examples
+    #   g = Repo.new("/Users/tom/dev/grit")
+    #   g = Repo.new("/Users/tom/public/grit.git")
+    #
+    # Returns Grit::Repo
+    def initialize(path, options = {})
+      epath = File.expand_path(path)
+      
+      if File.exist?(File.join(epath, '.git'))
+        self.path = File.join(epath, '.git')
+        @bare = false
+      elsif File.exist?(epath) && (epath =~ /\.git$/ || options[:is_bare])
+        self.path = epath
+        @bare = true
+      elsif File.exist?(epath)
+        raise InvalidGitRepositoryError.new(epath)
+      else
+        raise NoSuchPathError.new(epath)
+      end
+      
+      self.git = Git.new(self.path)
+    end
+    
+    def self.init(path)
+      # !! TODO !!
+      # create directory
+      # generate initial git directory
+      # create new Grit::Repo on that dir, return it
+    end
+    
+    # The project's description. Taken verbatim from GIT_REPO/description
+    #
+    # Returns String
+    def description
+      File.open(File.join(self.path, 'description')).read.chomp
+    end
+    
+    # An array of Head objects representing the branch heads in
+    # this repo
+    #
+    # Returns Grit::Head[] (baked)
+    def heads
+      Head.find_all(self)
+    end
+    
+    alias_method :branches, :heads
+
+    # Object reprsenting the current repo head.
+    #
+    # Returns Grit::Head (baked)
+    def head
+      Head.current(self)
+    end
+
+
+    # Commits current index
+    #
+    # Returns true/false if commit worked
+    def commit_index(message)
+      self.git.commit({}, '-m', message)
+    end
+
+    # Commits all tracked and modified files
+    #
+    # Returns true/false if commit worked
+    def commit_all(message)
+      self.git.commit({}, '-a', '-m', message)
+    end
+
+    # Adds files to the index
+    def add(*files)
+      self.git.add({}, *files.flatten)
+    end
+
+    # Adds files to the index
+    def remove(*files)
+      self.git.rm({}, *files.flatten)
+    end
+    
+
+    def blame_tree(commit, path = nil)
+      commit_array = self.git.blame_tree(commit, path)
+      
+      final_array = {}
+      commit_array.each do |file, sha|
+        final_array[file] = commit(sha)
+      end
+      final_array
+    end
+    
+    def status
+      Status.new(self)
+    end
+
+
+    # An array of Tag objects that are available in this repo
+    #
+    # Returns Grit::Tag[] (baked)
+    def tags
+      Tag.find_all(self)
+    end
+    
+    # An array of Remote objects representing the remote branches in
+    # this repo
+    #
+    # Returns Grit::Remote[] (baked)
+    def remotes
+      Remote.find_all(self)
+    end
+
+    # An array of Ref objects representing the refs in
+    # this repo
+    #
+    # Returns Grit::Ref[] (baked)
+    def refs
+      [ Head.find_all(self), Tag.find_all(self), Remote.find_all(self) ].flatten
+    end
+
+    def commit_stats(start = 'master', max_count = 10, skip = 0)
+      options = {:max_count => max_count,
+                 :skip => skip}
+      
+      CommitStats.find_all(self, start, options)
+    end
+    
+    # An array of Commit objects representing the history of a given ref/commit
+    #   +start+ is the branch/commit name (default 'master')
+    #   +max_count+ is the maximum number of commits to return (default 10, use +false+ for all)
+    #   +skip+ is the number of commits to skip (default 0)
+    #
+    # Returns Grit::Commit[] (baked)
+    def commits(start = 'master', max_count = 10, skip = 0)
+      options = {:max_count => max_count,
+                 :skip => skip}
+      
+      Commit.find_all(self, start, options)
+    end
+    
+    # The Commits objects that are reachable via +to+ but not via +from+
+    # Commits are returned in chronological order.
+    #   +from+ is the branch/commit name of the younger item
+    #   +to+ is the branch/commit name of the older item
+    #
+    # Returns Grit::Commit[] (baked)
+    def commits_between(from, to)
+      Commit.find_all(self, "#{from}..#{to}").reverse
+    end
+    
+    # The Commits objects that are newer than the specified date.
+    # Commits are returned in chronological order.
+    #   +start+ is the branch/commit name (default 'master')
+    #   +since+ is a string represeting a date/time
+    #   +extra_options+ is a hash of extra options
+    #
+    # Returns Grit::Commit[] (baked)
+    def commits_since(start = 'master', since = '1970-01-01', extra_options = {})
+      options = {:since => since}.merge(extra_options)
+      
+      Commit.find_all(self, start, options)
+    end
+    
+    # The number of commits reachable by the given branch/commit
+    #   +start+ is the branch/commit name (default 'master')
+    #
+    # Returns Integer
+    def commit_count(start = 'master')
+      Commit.count(self, start)
+    end
+    
+    # The Commit object for the specified id
+    #   +id+ is the SHA1 identifier of the commit
+    #
+    # Returns Grit::Commit (baked)
+    def commit(id)
+      options = {:max_count => 1}
+      
+      Commit.find_all(self, id, options).first
+    end
+    
+    # The Tree object for the given treeish reference
+    #   +treeish+ is the reference (default 'master')
+    #   +paths+ is an optional Array of directory paths to restrict the tree (deafult [])
+    #
+    # Examples
+    #   repo.tree('master', ['lib/'])
+    #
+    # Returns Grit::Tree (baked)
+    def tree(treeish = 'master', paths = [])
+      Tree.construct(self, treeish, paths)
+    end
+    
+    # The Blob object for the given id
+    #   +id+ is the SHA1 id of the blob
+    #
+    # Returns Grit::Blob (unbaked)
+    def blob(id)
+      Blob.create(self, :id => id)
+    end
+
+    # The commit log for a treeish
+    #
+    # Returns Grit::Commit[]
+    def log(commit = 'master', path = nil, options = {})
+      default_options = {:pretty => "raw"}
+      actual_options  = default_options.merge(options)
+      arg = path ? [commit, '--', path] : [commit]
+      commits = self.git.log(actual_options, *arg)
+      Commit.list_from_string(self, commits)
+    end
+    
+    # The diff from commit +a+ to commit +b+, optionally restricted to the given file(s)
+    #   +a+ is the base commit
+    #   +b+ is the other commit
+    #   +paths+ is an optional list of file paths on which to restrict the diff
+    def diff(a, b, *paths)
+      self.git.diff({}, a, b, '--', *paths)
+    end
+    
+    # The commit diff for the given commit
+    #   +commit+ is the commit name/id
+    #
+    # Returns Grit::Diff[]
+    def commit_diff(commit)
+      Commit.diff(self, commit)
+    end
+    
+    # Initialize a bare git repository at the given path
+    #   +path+ is the full path to the repo (traditionally ends with /<name>.git)
+    #   +options+ is any additional options to the git init command
+    #
+    # Examples
+    #   Grit::Repo.init_bare('/var/git/myrepo.git')
+    #
+    # Returns Grit::Repo (the newly created repo)
+    def self.init_bare(path, git_options = {}, repo_options = {})
+      git = Git.new(path)
+      git.init(git_options)
+      self.new(path, repo_options)
+    end
+    
+    # Fork a bare git repository from this repo
+    #   +path+ is the full path of the new repo (traditionally ends with /<name>.git)
+    #   +options+ is any additional options to the git clone command
+    #
+    # Returns Grit::Repo (the newly forked repo)
+    def fork_bare(path, options = {})
+      default_options = {:bare => true, :shared => true}
+      real_options = default_options.merge(options)
+      self.git.clone(real_options, self.path, path)
+      Repo.new(path)
+    end
+    
+    # Archive the given treeish
+    #   +treeish+ is the treeish name/id (default 'master')
+    #   +prefix+ is the optional prefix
+    #
+    # Examples
+    #   repo.archive_tar
+    #   # => <String containing tar archive>
+    #
+    #   repo.archive_tar('a87ff14')
+    #   # => <String containing tar archive for commit a87ff14>
+    #
+    #   repo.archive_tar('master', 'myproject/')
+    #   # => <String containing tar archive and prefixed with 'myproject/'>
+    #
+    # Returns String (containing tar archive)
+    def archive_tar(treeish = 'master', prefix = nil)
+      options = {}
+      options[:prefix] = prefix if prefix
+      self.git.archive(options, treeish)
+    end
+    
+    # Archive and gzip the given treeish
+    #   +treeish+ is the treeish name/id (default 'master')
+    #   +prefix+ is the optional prefix
+    #
+    # Examples
+    #   repo.archive_tar_gz
+    #   # => <String containing tar.gz archive>
+    #
+    #   repo.archive_tar_gz('a87ff14')
+    #   # => <String containing tar.gz archive for commit a87ff14>
+    #
+    #   repo.archive_tar_gz('master', 'myproject/')
+    #   # => <String containing tar.gz archive and prefixed with 'myproject/'>
+    #
+    # Returns String (containing tar.gz archive)
+    def archive_tar_gz(treeish = 'master', prefix = nil)
+      options = {}
+      options[:prefix] = prefix if prefix
+      self.git.archive(options, treeish, "| gzip")
+    end
+
+    # run archive directly to a file
+    def archive_to_file(treeish = 'master', prefix = nil, filename = 'archive.tar.gz')
+      options = {}
+      options[:prefix] = prefix if prefix
+      self.git.archive(options, treeish, "| gzip > #{filename}")
+    end
+
+    
+    # Enable git-daemon serving of this repository by writing the
+    # git-daemon-export-ok file to its git directory
+    #
+    # Returns nothing
+    def enable_daemon_serve
+      FileUtils.touch(File.join(self.path, DAEMON_EXPORT_FILE))
+    end
+    
+    # Disable git-daemon serving of this repository by ensuring there is no
+    # git-daemon-export-ok file in its git directory
+    #
+    # Returns nothing
+    def disable_daemon_serve
+      FileUtils.rm_f(File.join(self.path, DAEMON_EXPORT_FILE))
+    end
+    
+    # The list of alternates for this repo
+    #
+    # Returns Array[String] (pathnames of alternates)
+    def alternates
+      alternates_path = File.join(self.path, *%w{objects info alternates})
+      
+      if File.exist?(alternates_path)
+        File.read(alternates_path).strip.split("\n")
+      else
+        []
+      end
+    end
+    
+    # Sets the alternates
+    #   +alts+ is the Array of String paths representing the alternates
+    #
+    # Returns nothing
+    def alternates=(alts)
+      alts.each do |alt|
+        unless File.exist?(alt)
+          raise "Could not set alternates. Alternate path #{alt} must exist"
+        end
+      end
+      
+      if alts.empty?
+        File.delete(File.join(self.path, *%w{objects info alternates}))
+      else
+        File.open(File.join(self.path, *%w{objects info alternates}), 'w') do |f|
+          f.write alts.join("\n")
+        end
+      end
+    end
+    
+    def config
+      @config ||= Config.new(self)
+    end
+    
+    def index
+      Index.new(self)
+    end
+    
+    # Pretty object inspection
+    def inspect
+      %Q{#<Grit::Repo "#{@path}">}
+    end
+  end # Repo
+  
+end # Grit