Introduce Configuration.BuildFrom()

nulltoken · nulltoken · commit 6edfe448b04c · 2015-05-30T16:58:30.000+02:00
diff --git a/LibGit2Sharp.Tests/ConfigurationFixture.cs b/LibGit2Sharp.Tests/ConfigurationFixture.cs
@@ -227,7 +227,7 @@ public void CanSetBooleanValue()
         [Fact]
         public void SettingLocalConfigurationOutsideAReposThrows()
         {
-            using (var config = new Configuration(null, null, null))
+            using (var config = Configuration.BuildFrom(null, null, null, null))
             {
                 Assert.Throws<LibGit2SharpException>(() => config.Set("unittests.intsetting", 3));
             }
@@ -366,5 +366,25 @@ public void CanTellIfASpecificStoreContainsAKey()
                 Assert.Null(repo.Config.Get<string>("MCHammer.You-cant-touch-this", ConfigurationLevel.System));
             }
         }
+
+        [Fact]
+        public void CanAccessConfigurationWithoutARepository()
+        {
+            var path = SandboxStandardTestRepoGitDir();
+
+            string globalConfigPath = CreateConfigurationWithDummyUser(Constants.Signature);
+            var options = new RepositoryOptions { GlobalConfigurationLocation = globalConfigPath };
+
+            using (var repo = new Repository(path, options))
+            {
+                repo.Config.Set("my.key", "local");
+                repo.Config.Set("my.key", "mouse", ConfigurationLevel.Global);
+            }
+
+            var config = Configuration.BuildFrom(Path.Combine(path, ".git", "config"), globalConfigPath);
+
+            Assert.Equal("local", config.Get<string>("my.key").Value);
+            Assert.Equal("mouse", config.Get<string>("my.key", ConfigurationLevel.Global).Value);
+        }
     }
 }
diff --git a/LibGit2Sharp.Tests/TestHelpers/BaseFixture.cs b/LibGit2Sharp.Tests/TestHelpers/BaseFixture.cs
@@ -337,18 +337,18 @@ protected string CreateConfigurationWithDummyUser(string name, string email)
         {
             SelfCleaningDirectory scd = BuildSelfCleaningDirectory();
             Directory.CreateDirectory(scd.DirectoryPath);
-            string configFilePath = Path.Combine(scd.DirectoryPath, "global-config");
+            string configFilePath = Path.Combine(scd.DirectoryPath, "fake-config");
 
-            using (Configuration config = new Configuration(configFilePath))
+            using (Configuration config = Configuration.BuildFrom(configFilePath))
             {
                 if (name != null)
                 {
-                    config.Set("user.name", name, ConfigurationLevel.Global);
+                    config.Set("user.name", name);
                 }
 
                 if (email != null)
                 {
-                    config.Set("user.email", email, ConfigurationLevel.Global);
+                    config.Set("user.email", email);
                 }
             }
 
diff --git a/LibGit2Sharp/Configuration.cs b/LibGit2Sharp/Configuration.cs
@@ -15,6 +15,7 @@ namespace LibGit2Sharp
     public class Configuration : IDisposable,
         IEnumerable<ConfigurationEntry<string>>
     {
+        private readonly FilePath repoConfigPath;
         private readonly FilePath globalConfigPath;
         private readonly FilePath xdgConfigPath;
         private readonly FilePath systemConfigPath;
@@ -29,11 +30,12 @@ public class Configuration : IDisposable,
         protected Configuration()
         { }
 
-        internal Configuration(Repository repository, string globalConfigurationFileLocation,
+        internal Configuration(Repository repository, string repositoryConfigurationFileLocation, string globalConfigurationFileLocation,
             string xdgConfigurationFileLocation, string systemConfigurationFileLocation)
         {
             this.repository = repository;
 
+            repoConfigPath = repositoryConfigurationFileLocation;
             globalConfigPath = globalConfigurationFileLocation ?? Proxy.git_config_find_global();
             xdgConfigPath = xdgConfigurationFileLocation ?? Proxy.git_config_find_xdg();
             systemConfigPath = systemConfigurationFileLocation ?? Proxy.git_config_find_system();
@@ -56,6 +58,10 @@ private void Init()
 
                 Proxy.git_repository_set_config(repository.Handle, configHandle);
             }
+            else if (repoConfigPath != null)
+            {
+                Proxy.git_config_add_file_ondisk(configHandle, repoConfigPath, ConfigurationLevel.Local);
+            }
 
             if (globalConfigPath != null)
             {
@@ -73,21 +79,91 @@ private void Init()
             }
         }
 
+        /// <summary>
+        /// Access configuration values without a repository.
+        /// <para>
+        ///   Generally you want to access configuration via an instance of <see cref="Repository"/> instead.
+        /// </para>
+        /// </summary>
+        /// <param name="repositoryConfigurationFileLocation">Path to a Repository configuration file.</param>
+        /// <returns>An instance of <see cref="Configuration"/>.</returns>
+        public static Configuration BuildFrom(
+            string repositoryConfigurationFileLocation)
+        {
+            return BuildFrom(repositoryConfigurationFileLocation, null, null, null);
+        }
+
+        /// <summary>
+        /// Access configuration values without a repository.
+        /// <para>
+        ///   Generally you want to access configuration via an instance of <see cref="Repository"/> instead.
+        /// </para>
+        /// </summary>
+        /// <param name="repositoryConfigurationFileLocation">Path to a Repository configuration file.</param>
+        /// <param name="globalConfigurationFileLocation">Path to a Global configuration file. If null, the default path for a Global configuration file will be probed.</param>
+        /// <returns>An instance of <see cref="Configuration"/>.</returns>
+        public static Configuration BuildFrom(
+            string repositoryConfigurationFileLocation,
+            string globalConfigurationFileLocation)
+        {
+            return BuildFrom(repositoryConfigurationFileLocation, globalConfigurationFileLocation, null, null);
+        }
+
+        /// <summary>
+        /// Access configuration values without a repository.
+        /// <para>
+        ///   Generally you want to access configuration via an instance of <see cref="Repository"/> instead.
+        /// </para>
+        /// </summary>
+        /// <param name="repositoryConfigurationFileLocation">Path to a Repository configuration file.</param>
+        /// <param name="globalConfigurationFileLocation">Path to a Global configuration file. If null, the default path for a Global configuration file will be probed.</param>
+        /// <param name="xdgConfigurationFileLocation">Path to a XDG configuration file. If null, the default path for a XDG configuration file will be probed.</param>
+        /// <returns>An instance of <see cref="Configuration"/>.</returns>
+        public static Configuration BuildFrom(
+            string repositoryConfigurationFileLocation,
+            string globalConfigurationFileLocation,
+            string xdgConfigurationFileLocation)
+        {
+            return BuildFrom(repositoryConfigurationFileLocation, globalConfigurationFileLocation, xdgConfigurationFileLocation, null);
+        }
+
+        /// <summary>
+        /// Access configuration values without a repository.
+        /// <para>
+        ///   Generally you want to access configuration via an instance of <see cref="Repository"/> instead.
+        /// </para>
+        /// </summary>
+        /// <param name="repositoryConfigurationFileLocation">Path to a Repository configuration file.</param>
+        /// <param name="globalConfigurationFileLocation">Path to a Global configuration file. If null, the default path for a Global configuration file will be probed.</param>
+        /// <param name="xdgConfigurationFileLocation">Path to a XDG configuration file. If null, the default path for a XDG configuration file will be probed.</param>
+        /// <param name="systemConfigurationFileLocation">Path to a System configuration file. If null, the default path for a System configuration file will be probed.</param>
+        /// <returns>An instance of <see cref="Configuration"/>.</returns>
+        public static Configuration BuildFrom(
+            string repositoryConfigurationFileLocation,
+            string globalConfigurationFileLocation,
+            string xdgConfigurationFileLocation,
+            string systemConfigurationFileLocation)
+        {
+            return new Configuration(null, repositoryConfigurationFileLocation, globalConfigurationFileLocation, xdgConfigurationFileLocation, systemConfigurationFileLocation);
+        }
+
         /// <summary>
         /// Access configuration values without a repository. Generally you want to access configuration via an instance of <see cref="Repository"/> instead.
         /// </summary>
         /// <param name="globalConfigurationFileLocation">Path to a Global configuration file. If null, the default path for a global configuration file will be probed.</param>
+        [Obsolete("This method will be removed in the next release. Please use Configuration.BuildFrom(string, string) instead.")]
         public Configuration(string globalConfigurationFileLocation)
-            : this(null, globalConfigurationFileLocation, null, null)
+            : this(null, null, globalConfigurationFileLocation, null, null)
         { }
 
         /// <summary>
         /// Access configuration values without a repository. Generally you want to access configuration via an instance of <see cref="Repository"/> instead.
         /// </summary>
         /// <param name="globalConfigurationFileLocation">Path to a Global configuration file. If null, the default path for a global configuration file will be probed.</param>
         /// <param name="xdgConfigurationFileLocation">Path to a XDG configuration file. If null, the default path for a XDG configuration file will be probed.</param>
+        [Obsolete("This method will be removed in the next release. Please use Configuration.BuildFrom(string, string, string) instead.")]
         public Configuration(string globalConfigurationFileLocation, string xdgConfigurationFileLocation)
-            : this(null, globalConfigurationFileLocation, xdgConfigurationFileLocation, null)
+            : this(null, null, globalConfigurationFileLocation, xdgConfigurationFileLocation, null)
         { }
 
         /// <summary>
@@ -96,10 +172,10 @@ public Configuration(string globalConfigurationFileLocation, string xdgConfigura
         /// <param name="globalConfigurationFileLocation">Path to a Global configuration file. If null, the default path for a global configuration file will be probed.</param>
         /// <param name="xdgConfigurationFileLocation">Path to a XDG configuration file. If null, the default path for a XDG configuration file will be probed.</param>
         /// <param name="systemConfigurationFileLocation">Path to a System configuration file. If null, the default path for a system configuration file will be probed.</param>
+        [Obsolete("This method will be removed in the next release. Please use Configuration.BuildFrom(string, string, string, string) instead.")]
         public Configuration(string globalConfigurationFileLocation, string xdgConfigurationFileLocation, string systemConfigurationFileLocation)
-            : this(null, globalConfigurationFileLocation, xdgConfigurationFileLocation, systemConfigurationFileLocation)
-        {
-        }
+            : this(null, null, globalConfigurationFileLocation, xdgConfigurationFileLocation, systemConfigurationFileLocation)
+        { }
 
         /// <summary>
         /// Determines which configuration file has been found.
diff --git a/LibGit2Sharp/Repository.cs b/LibGit2Sharp/Repository.cs
@@ -125,7 +125,7 @@ public Repository(string path, RepositoryOptions options)
                 config =
                     new Lazy<Configuration>(
                         () =>
-                        RegisterForCleanup(new Configuration(this, configurationGlobalFilePath, configurationXDGFilePath,
+                        RegisterForCleanup(new Configuration(this, null, configurationGlobalFilePath, configurationXDGFilePath,
                                                              configurationSystemFilePath)));
                 odb = new Lazy<ObjectDatabase>(() => new ObjectDatabase(this));
                 diff = new Diff(this);

Original file line number	Diff line number	Diff line change
`@@ -227,7 +227,7 @@ public void CanSetBooleanValue()`
`227`	`227`	`[Fact]`
`228`	`228`	`public void SettingLocalConfigurationOutsideAReposThrows()`
`229`	`229`	`{`
`230`		`- using (var config = new Configuration(null, null, null))`
	`230`	`+ using (var config = Configuration.BuildFrom(null, null, null, null))`
`231`	`231`	`{`
`232`	`232`	`Assert.Throws<LibGit2SharpException>(() => config.Set("unittests.intsetting", 3));`
`233`	`233`	`}`
`@@ -366,5 +366,25 @@ public void CanTellIfASpecificStoreContainsAKey()`
`366`	`366`	`Assert.Null(repo.Config.Get<string>("MCHammer.You-cant-touch-this", ConfigurationLevel.System));`
`367`	`367`	`}`
`368`	`368`	`}`
	`369`	`+`
	`370`	`+ [Fact]`
	`371`	`+ public void CanAccessConfigurationWithoutARepository()`
	`372`	`+ {`
	`373`	`+ var path = SandboxStandardTestRepoGitDir();`
	`374`	`+`
	`375`	`+ string globalConfigPath = CreateConfigurationWithDummyUser(Constants.Signature);`
	`376`	`+ var options = new RepositoryOptions { GlobalConfigurationLocation = globalConfigPath };`
	`377`	`+`
	`378`	`+ using (var repo = new Repository(path, options))`
	`379`	`+ {`
	`380`	`+ repo.Config.Set("my.key", "local");`
	`381`	`+ repo.Config.Set("my.key", "mouse", ConfigurationLevel.Global);`
	`382`	`+ }`
	`383`	`+`
	`384`	`+ var config = Configuration.BuildFrom(Path.Combine(path, ".git", "config"), globalConfigPath);`
	`385`	`+`
	`386`	`+ Assert.Equal("local", config.Get<string>("my.key").Value);`
	`387`	`+ Assert.Equal("mouse", config.Get<string>("my.key", ConfigurationLevel.Global).Value);`
	`388`	`+ }`
`369`	`389`	`}`
`370`	`390`	`}`
Original file line number	Diff line number	Diff line change
`@@ -337,18 +337,18 @@ protected string CreateConfigurationWithDummyUser(string name, string email)`
`337`	`337`	`{`
`338`	`338`	`SelfCleaningDirectory scd = BuildSelfCleaningDirectory();`
`339`	`339`	`Directory.CreateDirectory(scd.DirectoryPath);`
`340`		`- string configFilePath = Path.Combine(scd.DirectoryPath, "global-config");`
	`340`	`+ string configFilePath = Path.Combine(scd.DirectoryPath, "fake-config");`
`341`	`341`
`342`		`- using (Configuration config = new Configuration(configFilePath))`
	`342`	`+ using (Configuration config = Configuration.BuildFrom(configFilePath))`
`343`	`343`	`{`
`344`	`344`	`if (name != null)`
`345`	`345`	`{`
`346`		`- config.Set("user.name", name, ConfigurationLevel.Global);`
	`346`	`+ config.Set("user.name", name);`
`347`	`347`	`}`
`348`	`348`
`349`	`349`	`if (email != null)`
`350`	`350`	`{`
`351`		`- config.Set("user.email", email, ConfigurationLevel.Global);`
	`351`	`+ config.Set("user.email", email);`
`352`	`352`	`}`
`353`	`353`	`}`
`354`	`354`