Adding Git::show support

robertodecurnex · robertodecurnex · commit d6c06bdccadb · 2015-01-06T12:23:09.000-03:00
closes ruby-git#164
diff --git a/README.md b/README.md
@@ -149,6 +149,10 @@ Here are the operations that need read permission only.
     g.config # returns whole config hash
 
     g.tags # returns array of Git::Tag objects
+    
+    g.show()
+    g.show('HEAD')
+    g.show('v2.8', 'README.md')
 ```
 
 And here are the operations that will need to write to your git repository.
diff --git a/lib/git/base.rb b/lib/git/base.rb
@@ -421,6 +421,15 @@ def apply(file)
     def apply_mail(file)
       self.lib.apply_mail(file) if File.exist?(file)
     end
+
+    # Shows objects
+    #
+    # @param [String|NilClass] objectish the target object reference (nil == HEAD)
+    # @param [String|NilClass] path the path of the file to be shown
+    # @return [String] the object information
+    def show(objectish=nil, path=nil)
+      self.lib.show(objectish, path)
+    end
     
     ## LOWER LEVEL INDEX OPERATIONS ##
     
diff --git a/lib/git/lib.rb b/lib/git/lib.rb
@@ -61,12 +61,12 @@ def clone(repository, name, opts = {})
       clone_dir = opts[:path] ? File.join(@path, name) : name
       
       arr_opts = []
-      arr_opts << "--bare" if opts[:bare]
-      arr_opts << "--branch" << opts[:branch] if opts[:branch]
-      arr_opts << "--depth" << opts[:depth].to_i if opts[:depth] && opts[:depth].to_i > 0
-      arr_opts << "--config" << opts[:config] if opts[:config]
-      arr_opts << "--origin" << opts[:remote] || opts[:origin] if opts[:remote] || opts[:origin]
-      arr_opts << "--recursive" if opts[:recursive]
+      arr_opts << '--bare' if opts[:bare]
+      arr_opts << '--branch' << opts[:branch] if opts[:branch]
+      arr_opts << '--depth' << opts[:depth].to_i if opts[:depth] && opts[:depth].to_i > 0
+      arr_opts << '--config' << opts[:config] if opts[:config]
+      arr_opts << '--origin' << opts[:remote] || opts[:origin] if opts[:remote] || opts[:origin]
+      arr_opts << '--recursive' if opts[:recursive]
 
       arr_opts << '--'
 
@@ -439,6 +439,19 @@ def parse_config_list(lines)
     def parse_config(file)
       parse_config_list command_lines('config', ['--list', '--file', file], false)
     end
+
+    # Shows objects
+    #
+    # @param [String|NilClass] objectish the target object reference (nil == HEAD)
+    # @param [String|NilClass] path the path of the file to be shown
+    # @return [String] the object information
+    def show(objectish=nil, path=nil)
+      arr_opts = []
+
+      arr_opts << (path ? "#{objectish}:#{path}" : objectish)
+      
+      command('show', arr_opts.compact)
+    end
     
     ## WRITE COMMANDS ##
         
diff --git a/tests/units/test_lib.rb b/tests/units/test_lib.rb
@@ -199,4 +199,10 @@ def test_grep
     assert_equal(2, match.size)
   end
   
+  def test_show
+    assert(/^commit 5e53019b3238362144c2766f02a2c00d91fcc023.+\+replace with new text - diff test$/m.match(@lib.show))
+    assert(/^commit 935badc874edd62a8629aaf103418092c73f0a56.+\+nothing!$/m.match(@lib.show('gitsearch1')))
+    assert(/^hello.+nothing!$/m.match(@lib.show('gitsearch1', 'scott/text.txt')))
+  end
+  
 end
