configatron 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ade0eaacbaca6d1751e811972975ce00ccd7336e
-  data.tar.gz: 37087c12805c28940771cf27746b1c1858c115a0
+  metadata.gz: e6c93e7ecc847458d9417c053fa4a93fba83b616
+  data.tar.gz: f8f87d9a27a7a0e9af621dc109dbf17a1b664054
 SHA512:
-  metadata.gz: 901770f4fa820125723c7b4631cad49b74da6e0b4c0f44ff7f1dda511f172b7da947ae6e630dca94f3c7d0fb9a4282cf688d5bc01f76a94d654ad5e0ee4c4992
-  data.tar.gz: 9c6c28a946279c0cff614b99ce8a676f9c71039a7c9b70cbd4256b2c4d9ac8d6aeb7ab15728efd0777a94fca20bfd1312a703ab219d5638d2004f8024bc8a313
+  metadata.gz: 75cca363649f725091cfbe1b4e5d846d9a5a23b479a83163fd5e647be097353ae6cbbeae78a3bef5277d101cc837e9a88ab569d83f7c132f61ac1bf6b2fc20e8
+  data.tar.gz: 3e7f64f6a99e29280a6981b4188dd887f33998d6c785cf3e458f6ea039d3aac3fcc44cd9a2482111f1ed445e6d40c530881fe428f95ccf2b3ef06f3526f06784

data/History.txt

@@ -1,4 +1,8 @@
-=== 4.0.0 (WIP)
+=== 4.0.1
+
+* Fix #inspect and #to_s methods on KernelStore to pass through to Store
+
+=== 4.0.0
 
 This is largely a restructuring of existing functionality, making it
 simpler and more consistent. The tests have also been fully

data/README.md

@@ -66,7 +66,7 @@ Notice how our other configuration parameters haven't changed? Cool, eh?
 
 ### Hash/YAML
 
-You can configure Configatron from a hash as well (this is really only useful in testing or for data driven configuration, it's not recommended for actual configuration):
+You can configure Configatron from a hash as well (this is particularly useful if you'd like to have configuration files):
 
 ```ruby
 configatron.configure_from_hash(email: {pop: {address: 'pop.example.com', port: 110}}, smtp: {address: 'smtp.example.com'})
@@ -76,10 +76,6 @@ configatron.email.pop.port # => 110
 # and so on...
 ```
 
-#### YAML
-
-YAML is terrible and should be driven from the face of the Earth. Because of this Configatron V3 does not support it. Sorry.
-
 ### Namespaces
 
 The question that should be on your lips is what I need to have namespaced configuration parameters. It's easy! Configatron allows you to create namespaces.
@@ -119,7 +115,7 @@ end
 
 ### Temp Configurations
 
-Sometimes in testing, or other situations, you want to temporarily change some settings. You can do this with the `temp` method:
+Sometimes in testing, or other situations, you want to temporarily change some settings. You can do this with the `temp` method (only available on the top-level configatron `RootStore`):
 
 ```ruby
 configatron.one = 1
@@ -191,15 +187,7 @@ Each time you call `configatron.current.time` it will return a new value to you.
 
 ### nil
 
-Even if parameters haven't been set, you can still call them, but you'll get a `Configatron::Store` object back. The `Configatron::Store` class, however, will respond true to `.nil?` or `.blank?` if there are no parameters configured on it.
-
-```ruby
-configatron.i.dont.exist.nil? # => true
-configatron.i.dont.exist.blank? # => true
-configatron.i.dont.exist # => Configatron::Store
-```
-
-You can use `.has_key?` to determine if a key already exists.
+Even if parameters haven't been set, you can still call them, but you'll get a `Configatron::Store` object back. You can use `.has_key?` to determine if a key already exists.
 
 ```ruby
 configatron.i.dont.has_key?(:exist) # => false
@@ -218,16 +206,14 @@ configatron.a.b.c! # => raise Configratron::UndefinedKeyError
 
 ### Kernel
 
-The `configatron` "helper" method is store in the `Kernel` module. Some people didn't like that in the V2 of Configatron, so in V3, while that hasn't changed, you don't have to use it.
-
-Instead of requiring `configatron` simply require `configatron/core`, but then you'll have to set up your own `Configatron::Store` object.
+The `configatron` "helper" method is stored in the `Kernel` module. You can opt-out of this global monkey-patching by requiring `configatron/core` rather than `configatron`. You'll have to set up your own `Configatron::RootStore` object.
 
 Example:
 
 ```ruby
 require 'configatron/core'
 
-store = Configatron::Store.new
+store = Configatron::RootStore.new
 store.foo = 'FOO'
 
 store.to_h #= {foo: 'FOO'}

data/lib/configatron/root_store.rb

@@ -2,6 +2,7 @@
 # operate on the entire configatron hierarchy.
 class Configatron::RootStore
   include Singleton
+  extend ::Forwardable
 
   attr_reader :store
 
@@ -49,4 +50,7 @@ class Configatron::RootStore
   def unlock!
     @locked = false
   end
+
+  def_delegator :@store, :to_s
+  def_delegator :@store, :inspect
 end

data/lib/configatron/store.rb

@@ -58,11 +58,6 @@ class Configatron
       end
     end
 
-    # Needed to allow 'puts'ing of a configatron.
-    def to_ary
-      raise NoMethodError
-    end
-
     def to_s
       @name
     end
@@ -90,6 +85,11 @@ class Configatron
     end
 
     def method_missing(name, *args, &block)
+      # Needed to allow 'puts'ing of a configatron.
+      if name == :to_ary
+        raise NoMethodError.new("Called :to_ary")
+      end
+
       # In case of Configatron bugs, prevent method_missing infinite
       # loops.
       if @method_missing

data/lib/configatron/version.rb

@@ -1,3 +1,3 @@
 class Configatron
-  VERSION = "4.0.0"
+  VERSION = "4.0.1"
 end

data/test/functional/configatron.rb

@@ -73,4 +73,11 @@ class Critic::Functional::ConfigatronTest < Critic::Functional::Test
       assert_equal(name, 'configatron.foo.bar.baz')
     end
   end
+
+  describe 'puts' do
+    it 'does not cause an exception' do
+      puts @kernel
+      puts @kernel.hi
+    end
+  end
 end

data/test/unit/configatron/root_store.rb

@@ -1,14 +1,14 @@
 require_relative '../_lib'
 
-class Critic::Unit::KernelTest < Critic::Unit::Test
+class Critic::Unit::RootTest < Critic::Unit::Test
   before do
-    @kernel = Configatron::RootStore.new
+    @root = Configatron::RootStore.new
   end
 
   describe 'delegation' do
     it 'passes on to Configatron::Store' do
-      @kernel.a.b.c.d = 'D'
-      assert_equal('D', @kernel.a.b.c.d)
+      @root.a.b.c.d = 'D'
+      assert_equal('D', @root.a.b.c.d)
     end
   end
 
@@ -17,4 +17,21 @@ class Critic::Unit::KernelTest < Critic::Unit::Test
       assert_equal(true, configatron.kind_of?(Configatron::RootStore))
     end
   end
+
+  describe 'inspect' do
+    it 'delegates to store' do
+      @root.a.b.c.d = 'D'
+      @root.a.b.e = 'E'
+      assert_equal('configatron.a.b.c.d = "D"
+configatron.a.b.e = "E"', @root.inspect)
+    end
+  end
+
+  describe 'to_s' do
+    it 'delegates to store' do
+      @root.a.b.c.d = 'D'
+      @root.a.b = 'D'
+      assert_equal('configatron', @root.to_s)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: configatron
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Mark Bates