Refactor Git::config

Michal Papis · Michal Papis · commit dad56fca24e9 · 2019-01-21T15:21:51.000+01:00
The Git module has config and global_config methods that are available
only when Git module is included. Refactored the code to remove
duplication and to make it more explicit we are managing `git config`
not the library setup.

Signed-off-by: Michal Papis &lt;michal.papis@toptal.com&gt;
diff --git a/README.md b/README.md
@@ -295,6 +295,20 @@ Some examples of more low-level index and tree operations
      end
 ```
 
+Managing git configuration
+
+```ruby
+    # current git project config
+    Git::GitConfig.config # returns whole config hash
+    Git::GitConfig.config('user.name')  # returns 'Scott Chacon'
+    Git::GitConfig.config('user.name', 'Scott Chacon')  # sets new user.name
+
+    # global config
+    Git::GitConfig.global_config # returns whole global config hash
+    Git::GitConfig.global_config('user.name')  # returns 'Scott Chacon'
+    Git::GitConfig.global_config('user.name', 'Scott Chacon')  # sets new user.name
+```
+
 ## License
 
 licensed under MIT License Copyright (c) 2008  Scott Chacon. See LICENSE for further details.
diff --git a/lib/git.rb b/lib/git.rb
@@ -9,6 +9,7 @@
 require 'git/branches'
 require 'git/config'
 require 'git/diff'
+require 'git/git_config'
 require 'git/index'
 require 'git/lib'
 require 'git/log'
@@ -42,24 +43,6 @@
 # Author::    Scott Chacon (mailto:schacon@gmail.com)
 # License::   MIT License
 module Git
-  
-  #g.config('user.name', 'Scott Chacon') # sets value
-  #g.config('user.email', 'email@email.com')  # sets value
-  #g.config('user.name')  # returns 'Scott Chacon'
-  #g.config # returns whole config hash
-  def config(name = nil, value = nil)
-    lib = Git::Lib.new
-    if(name && value)
-      # set value
-      lib.config_set(name, value)
-    elsif (name)
-      # return value
-      lib.config_get(name)
-    else
-      # return hash
-      lib.config_list
-    end
-  end
 
   def self.configure
     yield Base.config
@@ -69,10 +52,6 @@ def self.config
     return Base.config
   end
 
-  def global_config(name = nil, value = nil)
-    self.class.global_config(name, value)
-  end
-
   # open a bare repository
   #
   # this takes the path to a bare git repo
diff --git a/lib/git/base.rb b/lib/git/base.rb
@@ -1,10 +1,12 @@
 require 'git/base/factory'
+require 'git/git_config'
 
 module Git
   
   class Base
 
     include Git::Base::Factory
+    include Git::GitConfig
 
     # opens a bare Git Repository - no working directory options
     def self.bare(git_dir, opts = {})
@@ -106,24 +108,7 @@ def chdir # :yields: the Git::Path
         yield dir.path
       end
     end
-    
-    #g.config('user.name', 'Scott Chacon') # sets value
-    #g.config('user.email', 'email@email.com')  # sets value
-    #g.config('user.name')  # returns 'Scott Chacon'
-    #g.config # returns whole config hash
-    def config(name = nil, value = nil)
-      if(name && value)
-        # set value
-        lib.config_set(name, value)
-      elsif (name)
-        # return value
-        lib.config_get(name)
-      else
-        # return hash
-        lib.config_list
-      end
-    end
-  
+
     # returns a reference to the working directory
     #  @git.dir.path
     #  @git.dir.writeable?
diff --git a/lib/git/git_config.rb b/lib/git/git_config.rb
@@ -0,0 +1,36 @@
+module Git
+  module GitConfig
+    extend self
+
+    #g.config('user.name', 'Scott Chacon') # sets value
+    #g.config('user.email', 'email@email.com')  # sets value
+    #g.config('user.name')  # returns 'Scott Chacon'
+    #g.config # returns whole config hash
+    def config(name = nil, value = nil)
+      if(name && value)
+        # set value
+        lib.config_set(name, value)
+      elsif (name)
+        # return value
+        lib.config_get(name)
+      else
+        # return hash
+        lib.config_list
+      end
+    end
+
+    def global_config(name = nil, value = nil)
+      Git.global_config(name, value)
+    end
+
+    class << self
+      private
+
+      def lib
+        @lib ||= Git::Lib.new
+      end
+    end
+  end
+end
+
+# Git::GitConfig.config
diff --git a/tests/units/test_git_config.rb b/tests/units/test_git_config.rb
@@ -2,13 +2,10 @@
 
 require File.dirname(__FILE__) + '/../test_helper'
 
-class TestConfigModule < Test::Unit::TestCase
+class TestGitConfig < Test::Unit::TestCase
   def setup
     set_file_paths
-    git_class = Class.new do
-      include Git
-    end
-    @git = git_class.new
+    @git = Git::GitConfig
     @old_dir = Dir.pwd
     Dir.chdir(@wdir)
   end
