configatron 3.2.0 → 4.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1dc9cfe0ed3b4c2c0c90b325d4b837e4aed30d8b
-  data.tar.gz: 6bd11604cc4abf42aa461f33970e0935580774a7
+  metadata.gz: 132989ab43482032a4a574c7c165e382bd361fb8
+  data.tar.gz: e6774fccb00c33995c109f8ce62e05caa87bebd8
 SHA512:
-  metadata.gz: 8f4c42d22a0fa92b539c716aa2fcb53e3b837cf843f6fde91114823d8a5f2eb9c022d1712af686fadab9a3d1604ae746f2f64d626d4c4fa298b9d192f6e18823
-  data.tar.gz: 6ba36b1929bf8fad1774f10c309b145f3cddd01371a2d2b81213dc92f3d7446a03d18255425c8ffbf48649100c3535e54dfa39a080e37ad8f9200c60be7125cc
+  metadata.gz: 4f94da811e4b3add13ef0ae54ade8c6202568eeee89d0b1f803980b1ca1f25d968e99793c515de95566715a7a611a16ca0f2a19c1107f1bf650fd2b650b3381a
+  data.tar.gz: f90d0c18873c458a933e26d58f30eda5e712a7e2f6e34bc752dace68604f4eab75062fd3ac9eb7052afe7bcedc6d1c76ca8f99a9af47a29aade4abcc6114c9b9

data/.gitignore

@@ -15,6 +15,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.ruby-version
 
 .DS_Store
 *.rbc

data/.travis.yml

@@ -4,5 +4,5 @@ rvm:
   - 2.0.0
   - 2.1.0
   - 2.1.1
-install: bundle install
-script: bundle exec rake
+install: travis_retry bundle install
+script: bundle exec rake test

data/History.txt

@@ -0,0 +1,72 @@
+=== 4.5.0
+
+* [backwards-incompatible] Switch from DeepClone to copy-on-write for temp. As part of the implementation, *values* are no longer cloned.
+
+=== 4.4.1
+
+* Make lock!/unlock! support blocks
+
+=== 4.4.0
+
+* [backwards-incompatible] Make temp preserve locking state across invocations
+
+=== 4.3.0
+
+* [backwards-incompatible] Make nil into a valid config value
+* [backwards-incompatible] Make temp clean up after itself when an exception is thrown
+
+=== 4.2.1
+
+* Fix a bug with deep cloning which caused temping to break for nested settings
+
+=== 4.2.0
+
+* [backwards-incompatible] Make to_h/to_hash recursively hashify Configatron::Stores, and resolve Configatron::Procs.
+
+=== 4.1.1
+
+* Fix delayed attributes
+
+=== 4.1.0
+
+* Fix bugs from BasicObject fallout
+* Have KernelStore proxy calls using `public_send` for consistent shadowing
+
+=== 4.0.3
+
+* Switch Store and RootStore to descend from BasicObject
+
+=== 4.0.2
+
+* Add missing require of Rails integration
+
+=== 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
+refactored.
+
+Added the following:
+
+* A Minitest integration at Configatron::Integrations::Minitest
+* Key errors while locked return the name of the relevant configatron
+* Configatron::RootStore is now the intended way to start a new configatron hiearchy. (You should likely not initialize a Configatron::Store yourself.)
+
+Deprecated the following:
+
+* Initializing a Configatron::Store with a custom hash
+* Calling .nil?/.empty? on a Configatron::Store
+* Calling locking, temp, or reset methods directly on a Configatron::Store (moved instead to Configatron::RootStore)
+* A DeepClone module is no longer defined at the top-level
+* Removed Configatron::KernelStore
+
+Other backwards-incompatible changes:
+
+* Renamespaced Configatron::Rails under Configatron::Integrations::Rails.
+* Moved locking and temp methods to exist just on Configatron::RootStore.
+* Configatron::Store.inspect no longer takes a name
+* key? will now return true for sub-Configatron::Stores

data/README.md

@@ -3,7 +3,7 @@
 
 Configatron makes configuring your applications and scripts incredibly easy. No longer is a there a need to use constants or global variables. Now you can use a simple and painless system to configure your life. And, because it's all Ruby, you can do any crazy thing you would like to!
 
-One of the more important changes to V3 is that it now resembles more a `Hash` style interface. You can use `[]`, `fetch`, `each`, etc...
+One of the more important changes to V3 is that it now resembles more a `Hash` style interface. You can use `[]`, `fetch`, `each`, etc... Actually the hash notation is a bit more robust since the dot notation won't work for a few property names (a few public methods from `Configatron::Store` itself).
 
 ## Installation
 
@@ -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,9 +76,11 @@ configatron.email.pop.port # => 110
 # and so on...
 ```
 
-#### YAML
+### Method vs hash access
 
-YAML is terrible and should be driven from the face of the Earth. Because of this Configatron V3 does not support it. Sorry.
+As a note, method (`configatron.foo`) access will be shadowed by public methods defined on the configatron object. (The configatron object descends from [`BasicObject`](http://apidock.com/ruby/BasicObject) and adds a few methods to resemble the `Hash` API and to play nice with `puts`, so it should have a pretty bare set of methods.)
+
+If you need to use keys that are themselves method names, you can just use hash access (`configatron['foo']`).
 
 ### Namespaces
 
@@ -119,7 +121,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
@@ -189,17 +191,17 @@ configatron.current.time = Configatron::Dynamic.new {Time.now}
 
 Each time you call `configatron.current.time` it will return a new value to you. While this seems a bit useless, it is pretty useful if you have ever changing configurations.
 
-### nil
+### Reseting Configurations
 
-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.
+In some testing scenarios, it can be helpful to restore Configatron to its default state. This can be done with:
 
 ```ruby
-configatron.i.dont.exist.nil? # => true
-configatron.i.dont.exist.blank? # => true
-configatron.i.dont.exist # => Configatron::Store
-```
+configatron.reset!
+``` 
+
+### Checking keys
 
-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 +220,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'}
@@ -289,23 +289,24 @@ configatron.to_h # => {:letters=>{:a=>"A", :b=>"BB", :c=>"C"}}
 ## Contributors
 
 * Mark Bates
+* Greg Brockman
 * Kurtis Rainbolt-Greene
 * Rob Sanheim
-* Greg Brockman
 * Jérémy Lecour
 * Cody Maggard
 * Jean-Denis Vauguet
-* Torsten Schönebaum
-* Simon Menke
-* Gleb Pomykalov
 * chatgris
+* Simon Menke
 * Mat Brown
+* Torsten Schönebaum
+* Gleb Pomykalov
 * Casper Gripenberg
-* Dan Pickett
 * Artiom Diomin
-* Tim Riley
 * mattelacchiato
-* joe miller
-* Brandon Dimcheff
+* Dan Pickett
+* Tim Riley
 * Rick Fletcher
+* Jose Antonio Pio
+* Brandon Dimcheff
+* joe miller
 * Josh Nichols

data/Rakefile

@@ -3,7 +3,13 @@ require 'rake/testtask'
 
 Bundler::GemHelper.install_tasks
 
-Rake::TestTask.new(:default) do |t|
-  t.libs << "test"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
+Rake::TestTask.new do |t|
+  t.libs = ["lib"]
+  # t.warning = true
+  t.verbose = true
+  t.test_files = FileList['test/**/*.rb'].reject do |file|
+    file.end_with?('_lib.rb') || file.include?('/_lib/')
+  end
+end
+
+task :default => :test

data/configatron.gemspec

@@ -20,5 +20,6 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "mocha"
+  gem.add_development_dependency "subprocess"
   gem.add_development_dependency "minitest", '>=5.2.3'
 end

data/lib/configatron.rb

@@ -1,5 +1,23 @@
-require 'singleton'
 require 'configatron/version'
-require 'configatron/kernel'
-require 'configatron/core'
-require 'configatron/rails'
+
+require 'configatron/errors'
+require 'configatron/integrations'
+require 'configatron/root_store'
+require 'configatron/store'
+
+# Proc *must* load before dynamic/delayed, or else Configatron::Proc
+# will refer to the global ::Proc
+require 'configatron/proc'
+require 'configatron/delayed'
+require 'configatron/dynamic'
+
+class Configatron
+end
+
+# NO_EXT gets defined when you require "configatron/core", which
+# signals that you don't want any extensions. It'd be nice to have a
+# better internal signaling mechanism (could use environment
+# variables, but then they become part of the public interface).
+unless defined?(Configatron::NO_EXT)
+  require 'configatron/ext/kernel'
+end

data/lib/configatron/core.rb

@@ -1,6 +1,6 @@
-require_relative "deep_clone"
-require_relative "store"
-require_relative "errors"
-require_relative "proc"
-require_relative "dynamic"
-require_relative "delayed"
+class Configatron
+  # Signals that we should not load the extensions.
+  NO_EXT = true
+end
+
+require 'configatron'

data/lib/configatron/ext/kernel.rb

@@ -0,0 +1,5 @@
+module Kernel
+  def configatron
+    Configatron::RootStore.instance
+  end
+end

data/lib/configatron/integrations.rb

@@ -0,0 +1,4 @@
+module Configatron::Integrations; end
+
+require 'configatron/integrations/minitest'
+require 'configatron/integrations/rails'

data/lib/configatron/integrations/minitest.rb

@@ -0,0 +1,29 @@
+# Include in a minitest to restore the global configatron object to
+# its global state afterwards. Particularly useful if you'd like to test
+# your application with various config settings.
+#
+# ```ruby
+# class Test::Suite < Minitest::Unit
+#   include Configatron::Integrations::Minitest
+#
+#   it 'works' do
+#     configatron.unlock! do
+#       configatron.some.setting = true
+#     end
+#
+#     [...]
+#   end
+# ```
+module Configatron::Integrations
+  module Minitest
+    def before_setup
+      configatron.temp_start
+      super
+    end
+
+    def before_teardown
+      super
+      configatron.temp_end
+    end
+  end
+end

data/lib/configatron/{rails.rb → integrations/rails.rb}

@@ -1,4 +1,4 @@
-class Configatron
+module Configatron::Integrations
   # Helpful for making using configatron with Rails even easier!
   #
   # To get started you can use the generator to generate

data/lib/configatron/root_store.rb

@@ -0,0 +1,121 @@
+require 'singleton'
+require 'forwardable'
+
+# This is the root configatron object, and contains methods which
+# operate on the entire configatron hierarchy.
+class Configatron::RootStore < BasicObject
+  include ::Singleton
+  extend ::Forwardable
+
+  attr_reader :store
+
+  # Have one global RootStore instance, but allow people to create
+  # their own parallel ones if they desire.
+  class << self
+    public :new
+  end
+
+  @@cow = 0
+
+  def initialize
+    @locked = false
+    @cow = nil
+    reset!
+  end
+
+  def __cow
+    @cow
+  end
+
+  def __cow_path(path)
+    start = @store.__cow_clone
+
+    node = start
+    branch = path.map do |key|
+      node = node[key]
+      node.__cow_clone
+    end
+    nodes = [start] + branch
+
+    # [node1, node2, node3] with
+    # [node2, node3, node4] and
+    # ['key1', 'key2, 'key3']
+    nodes[0...-1].zip(nodes[1..-1], path) do |parent, child, key|
+      # These are all cow_clones, so won't trigger a further cow
+      # modification.
+      parent[key] = child
+    end
+
+    @store = nodes.first
+    nodes.last
+  end
+
+  def method_missing(name, *args, &block)
+    store.__send__(name, *args, &block)
+  end
+
+  def reset!
+    @store = ::Configatron::Store.new(self)
+  end
+
+  def temp(&block)
+    temp_start
+
+    begin
+      yield
+    ensure
+      temp_end
+    end
+  end
+
+  def temp_start
+    @temp_locked = @locked
+    @temp_cow = @cow
+
+    # Just need to have a unique Copy-on-Write generation ID
+    @cow = @@cow += 1
+    @temp = @store
+  end
+
+  def temp_end
+    @locked = @temp_locked
+    @cow = @temp_cow
+
+    @store = @temp
+  end
+
+  def locked?
+    @locked
+  end
+
+  def lock!(&blk)
+    if blk
+      orig = @locked
+      begin
+        @locked = true
+        blk.call
+      ensure
+        @locked = orig
+      end
+    else
+      @locked = true
+    end
+  end
+
+  def unlock!(&blk)
+    if blk
+      orig = @locked
+      begin
+        @locked = false
+        blk.call
+      ensure
+        @locked = orig
+      end
+    else
+      @locked = false
+    end
+  end
+
+  def_delegator :@store, :to_s
+  def_delegator :@store, :inspect
+end