git 1.19.1 → 3.1.1

data/lib/git/log.rb

@@ -1,15 +1,78 @@
+# frozen_string_literal: true
+
 module Git
 
-  # object that holds the last X commits on given branch
+  # Return the last n commits that match the specified criteria
+  #
+  # @example The last (default number) of commits
+  #   git = Git.open('.')
+  #   Git::Log.new(git) #=> Enumerable of the last 30 commits
+  #
+  # @example The last n commits
+  #   Git::Log.new(git).max_commits(50) #=> Enumerable of last 50 commits
+  #
+  # @example All commits returned by `git log`
+  #   Git::Log.new(git).max_count(:all) #=> Enumerable of all commits
+  #
+  # @example All commits that match complex criteria
+  #   Git::Log.new(git)
+  #     .max_count(:all)
+  #     .object('README.md')
+  #     .since('10 years ago')
+  #     .between('v1.0.7', 'HEAD')
+  #
+  # @api public
+  #
   class Log
     include Enumerable
 
-    def initialize(base, count = 30)
+    # Create a new Git::Log object
+    #
+    # @example
+    #   git = Git.open('.')
+    #   Git::Log.new(git)
+    #
+    # @param base [Git::Base] the git repository object
+    # @param max_count [Integer, Symbol, nil] the number of commits to return, or
+    #   `:all` or `nil` to return all
+    #
+    #   Passing max_count to {#initialize} is equivalent to calling {#max_count} on the object.
+    #
+    def initialize(base, max_count = 30)
       dirty_log
       @base = base
-      @count = count
+      max_count(max_count)
+    end
+
+    # The maximum number of commits to return
+    #
+    # @example All commits returned by `git log`
+    #   git = Git.open('.')
+    #   Git::Log.new(git).max_count(:all)
+    #
+    # @param num_or_all [Integer, Symbol, nil] the number of commits to return, or
+    #   `:all` or `nil` to return all
+    #
+    # @return [self]
+    #
+    def max_count(num_or_all)
+      dirty_log
+      @max_count = (num_or_all == :all) ? nil : num_or_all
+      self
     end
 
+    # Adds the --all flag to the git log command
+    #
+    # This asks for the logs of all refs (basically all commits reachable by HEAD,
+    # branches, and tags). This does not control the maximum number of commits
+    # returned. To control how many commits are returned, call {#max_count}.
+    #
+    # @example Return the last 50 commits reachable by all refs
+    #   git = Git.open('.')
+    #   Git::Log.new(git).max_count(50).all
+    #
+    # @return [self]
+    #
     def all
       dirty_log
       @all = true
@@ -70,11 +133,16 @@ module Git
       return self
     end
 
+    def merges
+      dirty_log
+      @merges = true
+      return self
+    end
+
     def to_s
       self.map { |c| c.to_s }.join("\n")
     end
 
-
     # forces git log to run
 
     def size
@@ -119,9 +187,9 @@ module Git
       # actually run the 'git log' command
       def run_log
         log = @base.lib.full_log_commits(
-          count: @count, all: @all, object: @object, path_limiter: @path, since: @since,
+          count: @max_count, all: @all, object: @object, path_limiter: @path, since: @since,
           author: @author, grep: @grep, skip: @skip, until: @until, between: @between,
-          cherry: @cherry
+          cherry: @cherry, merges: @merges
         )
         @commits = log.map { |c| Git::Object::Commit.new(@base, c['sha'], c) }
       end

data/lib/git/object.rb

@@ -1,16 +1,20 @@
+# frozen_string_literal: true
+
+require 'git/author'
+require 'git/diff'
+require 'git/errors'
+require 'git/log'
+
 module Git
-  
-  class GitTagNameDoesNotExist< StandardError 
-  end
-  
+
   # represents a git object
   class Object
-    
+
     class AbstractObject
       attr_accessor :objectish, :type, :mode
 
       attr_writer :size
-      
+
       def initialize(base, objectish)
         @base = base
         @objectish = objectish.to_s
@@ -21,13 +25,13 @@ module Git
       end
 
       def sha
-        @sha ||= @base.lib.revparse(@objectish)
+        @sha ||= @base.lib.rev_parse(@objectish)
       end
-      
+
       def size
-        @size ||= @base.lib.object_size(@objectish)
+        @size ||= @base.lib.cat_file_size(@objectish)
       end
-      
+
       # Get the object's contents.
       # If no block is given, the contents are cached in memory and returned as a string.
       # If a block is given, it yields an IO object (via IO::popen) which could be used to
@@ -36,113 +40,113 @@ module Git
       # Use this for large files so that they are not held in memory.
       def contents(&block)
         if block_given?
-          @base.lib.object_contents(@objectish, &block)
+          @base.lib.cat_file_contents(@objectish, &block)
         else
-          @contents ||= @base.lib.object_contents(@objectish)
+          @contents ||= @base.lib.cat_file_contents(@objectish)
         end
       end
-      
+
       def contents_array
         self.contents.split("\n")
       end
-      
+
       def to_s
         @objectish
       end
-      
+
       def grep(string, path_limiter = nil, opts = {})
         opts = {:object => sha, :path_limiter => path_limiter}.merge(opts)
         @base.lib.grep(string, opts)
       end
-      
+
       def diff(objectish)
         Git::Diff.new(@base, @objectish, objectish)
       end
-      
+
       def log(count = 30)
         Git::Log.new(@base, count).object(@objectish)
       end
-      
+
       # creates an archive of this object (tree)
       def archive(file = nil, opts = {})
         @base.lib.archive(@objectish, file, opts)
       end
-      
+
       def tree?; false; end
-      
+
       def blob?; false; end
-      
+
       def commit?; false; end
 
       def tag?; false; end
-     
+
     end
-  
-    
+
+
     class Blob < AbstractObject
-      
+
       def initialize(base, sha, mode = nil)
         super(base, sha)
         @mode = mode
       end
-      
+
       def blob?
         true
       end
 
     end
-  
+
     class Tree < AbstractObject
-      
+
       def initialize(base, sha, mode = nil)
         super(base, sha)
         @mode = mode
         @trees = nil
         @blobs = nil
       end
-            
+
       def children
         blobs.merge(subtrees)
       end
-      
+
       def blobs
         @blobs ||= check_tree[:blobs]
       end
       alias_method :files, :blobs
-      
+
       def trees
         @trees ||= check_tree[:trees]
       end
       alias_method :subtrees, :trees
       alias_method :subdirectories, :trees
-       
+
       def full_tree
         @base.lib.full_tree(@objectish)
       end
-                  
+
       def depth
         @base.lib.tree_depth(@objectish)
       end
-      
+
       def tree?
         true
       end
-       
+
       private
 
         # actually run the git command
         def check_tree
           @trees = {}
           @blobs = {}
-          
+
           data = @base.lib.ls_tree(@objectish)
 
-          data['tree'].each do |key, tree| 
-            @trees[key] = Git::Object::Tree.new(@base, tree[:sha], tree[:mode]) 
+          data['tree'].each do |key, tree|
+            @trees[key] = Git::Object::Tree.new(@base, tree[:sha], tree[:mode])
           end
-          
-          data['blob'].each do |key, blob| 
-            @blobs[key] = Git::Object::Blob.new(@base, blob[:sha], blob[:mode]) 
+
+          data['blob'].each do |key, blob|
+            @blobs[key] = Git::Object::Blob.new(@base, blob[:sha], blob[:mode])
           end
 
           {
@@ -150,11 +154,11 @@ module Git
             :blobs => @blobs
           }
         end
-      
+
     end
-  
+
     class Commit < AbstractObject
-      
+
       def initialize(base, sha, init = nil)
         super(base, sha)
         @tree = nil
@@ -166,48 +170,48 @@ module Git
           set_commit(init)
         end
       end
-      
+
       def message
         check_commit
         @message
       end
-      
+
       def name
-        @base.lib.namerev(sha)
+        @base.lib.name_rev(sha)
       end
-      
+
       def gtree
         check_commit
         Tree.new(@base, @tree)
       end
-      
+
       def parent
         parents.first
       end
-      
+
       # array of all parent commits
       def parents
         check_commit
-        @parents        
+        @parents
       end
-      
+
       # git author
-      def author     
+      def author
         check_commit
         @author
       end
-      
+
       def author_date
         author.date
       end
-      
+
       # git author
       def committer
         check_commit
         @committer
       end
-      
-      def committer_date 
+
+      def committer_date
         committer.date
       end
       alias_method :date, :committer_date
@@ -215,7 +219,7 @@ module Git
       def diff_parent
         diff(parent)
       end
-      
+
       def set_commit(data)
         @sha ||= data['sha']
         @committer = Git::Author.new(data['committer'])
@@ -224,26 +228,26 @@ module Git
         @parents = data['parent'].map{ |sha| Git::Object::Commit.new(@base, sha) }
         @message = data['message'].chomp
       end
-      
+
       def commit?
         true
       end
 
       private
-  
+
         # see if this object has been initialized and do so if not
         def check_commit
           return if @tree
-          
-          data = @base.lib.commit_data(@objectish)
+
+          data = @base.lib.cat_file_commit(@objectish)
           set_commit(data)
         end
-      
+
     end
-  
+
     class Tag < AbstractObject
       attr_accessor :name
-      
+
       def initialize(base, sha, name)
         super(base, sha)
         @name = name
@@ -252,14 +256,14 @@ module Git
       end
 
       def annotated?
-        @annotated ||= (@base.lib.object_type(self.name) == 'tag')
+        @annotated ||= (@base.lib.cat_file_type(self.name) == 'tag')
       end
 
       def message
         check_tag()
         return @message
       end
-      
+
       def tag?
         true
       end
@@ -274,39 +278,39 @@ module Git
       def check_tag
         return if @loaded
 
-        if !self.annotated? 
+        if !self.annotated?
           @message = @tagger = nil
         else
-          tdata = @base.lib.tag_data(@name)
+          tdata = @base.lib.cat_file_tag(@name)
           @message = tdata['message'].chomp
           @tagger = Git::Author.new(tdata['tagger'])
         end
 
         @loaded = true
       end
-        
+
     end
-    
+
     # if we're calling this, we don't know what type it is yet
     # so this is our little factory method
     def self.new(base, objectish, type = nil, is_tag = false)
       if is_tag
         sha = base.lib.tag_sha(objectish)
         if sha == ''
-          raise Git::GitTagNameDoesNotExist.new(objectish)
+          raise Git::UnexpectedResultError.new("Tag '#{objectish}' does not exist.")
         end
         return Git::Object::Tag.new(base, sha, objectish)
       end
-      
-      type ||= base.lib.object_type(objectish)
+
+      type ||= base.lib.cat_file_type(objectish)
       klass =
         case type
-        when /blob/   then Blob   
+        when /blob/   then Blob
         when /commit/ then Commit
         when /tree/   then Tree
         end
       klass.new(base, objectish)
     end
-    
+
   end
 end

data/lib/git/path.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 module Git
- 
+
  class Path
-    
+
     attr_accessor :path
-    
+
     def initialize(path, check_path=true)
       path = File.expand_path(path)
-      
+
       if check_path && !File.exist?(path)
         raise ArgumentError, 'path does not exist', [path]
       end
-      
+
       @path = path
     end
-    
+
     def readable?
       File.readable?(@path)
     end
@@ -21,11 +23,10 @@ module Git
     def writable?
       File.writable?(@path)
     end
-    
+
     def to_s
       @path
     end
-    
  end
 
 end

data/lib/git/remote.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Git
   class Remote < Path
 

data/lib/git/repository.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Git
 
   class Repository < Path

data/lib/git/stash.rb

@@ -1,27 +1,28 @@
+# frozen_string_literal: true
+
 module Git
   class Stash
-    
+
     def initialize(base, message, existing=false)
       @base = base
       @message = message
       save unless existing
     end
-    
+
     def save
       @saved = @base.lib.stash_save(@message)
     end
-    
+
     def saved?
       @saved
     end
-    
+
     def message
       @message
     end
-    
+
     def to_s
       message
     end
-    
   end
 end

data/lib/git/stashes.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 module Git
-  
+
   # object that holds all the available stashes
   class Stashes
     include Enumerable
-    
+
     def initialize(base)
       @stashes = []
-      
+
       @base = base
-            
+
       @base.lib.stashes_all.each do |id, message|
         @stashes.unshift(Git::Stash.new(@base, message, true))
       end
@@ -24,16 +26,16 @@ module Git
     def all
       @base.lib.stashes_all
     end
-    
+
     def save(message)
       s = Git::Stash.new(@base, message)
       @stashes.unshift(s) if s.saved?
     end
-    
+
     def apply(index=nil)
       @base.lib.stash_apply(index)
     end
-    
+
     def clear
       @base.lib.stash_clear
       @stashes = []
@@ -42,14 +44,13 @@ module Git
     def size
       @stashes.size
     end
-    
+
     def each(&block)
       @stashes.each(&block)
     end
-    
+
     def [](index)
       @stashes[index.to_i]
     end
-    
   end
 end