cconfig 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ea447e81e322d1bf22dddca71e18e2eab21760d
-  data.tar.gz: 003941dd51eebfa38fea464be15f861bcc49f28c
+  metadata.gz: 5f377c3a860f4c0bcb82f5f8cc4601921d0a1536
+  data.tar.gz: 0016898111f22120de5fd23ff97215388a44596b
 SHA512:
-  metadata.gz: 841ebc1ec251e9490865f5e7f918ef38051402898e604b3b8e2c93ed42fbb2c74609a1b6f39b344d367ad779892e29440840eb218c3a11f122adcea105d98aeb
-  data.tar.gz: 2a18d68a5ea16c626e1d245549d67425c4fe6a0c301e6476f032f562730c3e7484e36acfb8935a5c8d4f8c90a604951013866f9d25e47a4620b3368f33af60bc
+  metadata.gz: fabee37df15fa57f9ee82b408348a11829bac6616bd5a63e9b76b36052ce6e3ee23e7fed3301c2f55add43223a67bb571c0fcd64f2440cb92fd4cb8cb671724c
+  data.tar.gz: 288e140df8d6b47f3d7efa3d5980b96c3881c8f36aa17ed888824f7e9f443eb0da6f3fac42934a6b0a5dd512ee37c20379c2ba38994f1f4453efdcced5f27113

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## Next version
+
+## 1.2.0
+
+- Added the `#default_of` method for the returned hash (hence `APP_CONFIG` as
+  well). This method returns the default value for a given key. It can be useful
+  to check whether a configuration value has been set by either environment
+  variables or the local configuration. See [commit](50d638c8d81bab6b17164a1a5661dc2ca730cf92).
+
 ## 1.1.1
 
 - Fixed crash on nested values on the `#enabled?` method. See [#3](https://github.com/mssola/cconfig/issues/3).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cconfig (1.1.1)
+    cconfig (1.2.0)
       safe_yaml (~> 1.0.0, >= 1.0.0)
 
 GEM

data/README.md

@@ -1,4 +1,4 @@
-# CConfig [![Build Status](https://travis-ci.org/mssola/cconfig.svg?branch=master)](https://travis-ci.org/mssola/cconfig)
+# CConfig [![Build Status](https://travis-ci.org/mssola/cconfig.svg?branch=master)](https://travis-ci.org/mssola/cconfig) [![Gem Version](https://badge.fury.io/rb/cconfig.svg)](https://badge.fury.io/rb/cconfig)
 
 CConfig (Container Config) is a container-aware configuration management
 gem. This is useful for applications that want to keep a reference configuration

data/lib/cconfig/cconfig.rb

@@ -24,7 +24,8 @@ require "yaml"
 module CConfig
   # Config is the main class of this library. It allows you to fetch the current
   # configuration (after merging the values from all sources) as a hash. This
-  # has will have the special method `::CConfig::HashUtils::Extensions#enabled?`.
+  # has will have some specials methods: `::CConfig::HashUtils::Extensions#enabled?`,
+  # `::CConfig::HashUtils::Extensions#disabled?` and `::CConfig::HashUtils::Extensions#default_of`.
   class Config
     include ::CConfig::HashUtils
 
@@ -42,12 +43,13 @@ module CConfig
 
     # Returns a hash with the app configuration contained in it.
     def fetch
-      cfg   = {}
-      cfg   = YAML.load_file(@default) if File.file?(@default)
+      cfg   = File.file?(@default) ? YAML.load_file(@default) : {}
       local = fetch_local
 
       hsh = strict_merge_with_env(default: cfg, local: local, prefix: @prefix)
       hsh.extend(::CConfig::HashUtils::Extensions)
+      hsh.defaults = cfg
+      hsh
     end
 
     # Returns a string representation of the evaluated configuration.

data/lib/cconfig/hash_utils.rb

@@ -24,6 +24,8 @@ module CConfig
     # Extensions contains the methods to be provided for each hash object
     # produced by this gem.
     module Extensions
+      attr_accessor :defaults
+
       # Returns true if the given feature is enabled, false otherwise. This also
       # works in embedded configuration values. For example: enabled?("a.b")
       # will return true for:
@@ -48,6 +50,19 @@ module CConfig
       def disabled?(feature)
         !enabled?(feature)
       end
+
+      # Returns the default value of the given key. Note that this key can
+      # specify nested values with the period notation (e.g. "a.b").
+      def default_of(key)
+        cur = defaults
+
+        key.split(".").each do |part|
+          cur = cur[part]
+          return if cur.nil?
+        end
+
+        cur
+      end
     end
 
     protected

data/lib/cconfig/version.rb

@@ -19,5 +19,5 @@
 
 module CConfig
   # The current version of CConfig.
-  VERSION = "1.1.1".freeze
+  VERSION = "1.2.0".freeze
 end

data/spec/config_spec.rb

@@ -30,64 +30,93 @@ end
 describe CConfig::Config do
   after do
     ["TEST_LOCAL_CONFIG_PATH"].each { |key| ENV[key] = nil }
+    ["TEST_LDAP_COUNT", "TEST_ANOTHER_ENABLED", "TEST_LDAP_STRING"].each do |key|
+      ENV[key] = nil
+    end
   end
 
-  it "returns an empty config if neither the global nor the local were found" do
-    cfg = get_config("", "").fetch
-    expect(cfg).to be_empty
-  end
+  it "selects the proper local file depending of the environment variable" do
+    # Instead of bad.yml (which will raise an error on `fetch`), we will pick up
+    # the local.yml file.
+    base  = File.join(File.dirname(__FILE__), "fixtures")
+    local = File.join(base, "bad.yml")
+    ENV["CCONFIG_LOCAL_CONFIG_PATH"] = File.join(base, "local.yml")
 
-  it "only uses the global if the local config was not found" do
-    cfg = get_config("config.yml", "").fetch
-    expect(cfg["gravatar"]["enabled"]).to be_truthy
+    # Passing nil to the prefix on purpose (see SUSE/Portus#1379)
+    cfg = ::CConfig::Config.new(default: "config.yml", local: local, prefix: nil)
+    expect { cfg.fetch }.not_to raise_error
   end
 
-  it "merges both config files and work as expected" do
-    cfg = get_config("config.yml", "local.yml").fetch
+  describe "Merging configuration values" do
+    it "returns an empty config if neither the global nor the local were found" do
+      cfg = get_config("", "").fetch
+      expect(cfg).to be_empty
+    end
 
-    expect(cfg.enabled?("gravatar")).to be_truthy
-    expect(cfg.enabled?("ldap")).to be_truthy
-    expect(cfg["ldap"]["hostname"]).to eq "ldap.example.com"
-    expect(cfg["ldap"]["port"]).to eq 389
-    expect(cfg["ldap"]["base"]).to eq "ou=users,dc=example,dc=com"
-    expect(cfg["unknown"]).to be nil
-  end
+    it "only uses the global if the local config was not found" do
+      cfg = get_config("config.yml", "").fetch
+      expect(cfg["gravatar"]["enabled"]).to be_truthy
+    end
 
-  it "raises an error when the local file is badly formatted" do
-    bad = get_config("config.yml", "bad.yml")
-    msg =  "Wrong format for the config-local file!"
-    expect { bad.fetch }.to raise_error(::CConfig::FormatError, msg)
-  end
+    it "merges both config files and work as expected" do
+      cfg = get_config("config.yml", "local.yml").fetch
 
-  it "returns the proper config while hiding passwords" do
-    cfg     = get_config("config.yml", "local.yml")
-    fetched = cfg.fetch
-    evaled  = YAML.safe_load(cfg.to_s)
+      expect(cfg.enabled?("gravatar")).to be_truthy
+      expect(cfg.enabled?("ldap")).to be_truthy
+      expect(cfg["ldap"]["hostname"]).to eq "ldap.example.com"
+      expect(cfg["ldap"]["port"]).to eq 389
+      expect(cfg["ldap"]["base"]).to eq "ou=users,dc=example,dc=com"
+      expect(cfg["unknown"]).to be nil
+    end
 
-    expect(fetched).not_to eq(evaled)
-    fetched["ldap"]["authentication"]["password"] = "****"
-    expect(fetched).to eq(evaled)
-  end
+    it "raises an error when the local file is badly formatted" do
+      bad = get_config("config.yml", "bad.yml")
+      msg =  "Wrong format for the config-local file!"
+      expect { bad.fetch }.to raise_error(::CConfig::FormatError, msg)
+    end
+
+    it "returns the proper config while hiding passwords" do
+      cfg     = get_config("config.yml", "local.yml")
+      fetched = cfg.fetch
+      evaled  = YAML.safe_load(cfg.to_s)
 
-  it "works for nested options" do
-    cfg = get_config("config.yml", "").fetch
-    expect(cfg.enabled?("email.smtp")).to be true
+      expect(fetched).not_to eq(evaled)
+      fetched["ldap"]["authentication"]["password"] = "****"
+      expect(fetched).to eq(evaled)
+    end
   end
 
-  it "offers the #disabled? method" do
-    cfg = get_config("config.yml", "").fetch
-    expect(cfg.disabled?("ldap")).to be_truthy
+  describe "#enabled?" do
+    it "works for nested options" do
+      cfg = get_config("config.yml", "").fetch
+      expect(cfg.enabled?("email.smtp")).to be true
+    end
+
+    it "offers the #disabled? method" do
+      cfg = get_config("config.yml", "").fetch
+      expect(cfg.disabled?("ldap")).to be_truthy
+    end
   end
 
-  it "selects the proper local file depending of the environment variable" do
-    # Instead of bad.yml (which will raise an error on `fetch`), we will pick up
-    # the local.yml file.
-    base  = File.join(File.dirname(__FILE__), "fixtures")
-    local = File.join(base, "bad.yml")
-    ENV["CCONFIG_LOCAL_CONFIG_PATH"] = File.join(base, "local.yml")
+  describe "#default_of" do
+    it "returns the default when a local file has been added" do
+      cfg = get_config("config.yml", "local.yml").fetch
 
-    # Passing nil to the prefix on purpose (see SUSE/Portus#1379)
-    cfg = ::CConfig::Config.new(default: "config.yml", local: local, prefix: nil)
-    expect { cfg.fetch }.not_to raise_error
+      expect(cfg["ldap"]["hostname"]).to eq("ldap.example.com")
+      expect(cfg.default_of("ldap.hostname")).to eq("ldap_hostname")
+    end
+
+    it "returns the default even if an environment variable was set" do
+      ENV["TEST_LDAP_AUTHENTICATION_BIND_DN"] = "2"
+      cfg = get_config("config.yml", "local.yml").fetch
+
+      expect(cfg["ldap"]["authentication"]["bind_dn"]).to eq(2)
+      expect(cfg.default_of("ldap.authentication.bind_dn")).to eq("")
+    end
+
+    it "returns nil for an unknown key" do
+      cfg = get_config("config.yml", "local.yml").fetch
+      expect(cfg.default_of("something.that.does.not.exist")).to be_nil
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cconfig
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - mssola
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-11 00:00:00.000000000 Z
+date: 2017-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: safe_yaml
@@ -155,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Configuration management for container-aware applications.