nested_config 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a357315a32e5b011e722c36ca2e97bf0f45d86d0
-  data.tar.gz: f60e835020536810df8a3eda0c5de853c1a54da6
+  metadata.gz: 7b2d8e043d622bfb78abda999e982036170a52e7
+  data.tar.gz: 5163d83682df800346302dbd35d8ba7e797a551d
 SHA512:
-  metadata.gz: a68a27481299c850f378c21e6e3ad0315d35307bf26a1134ff7a9ceace977f86ef6efbf283d5dd2255a121642ab6060bd76f01851132693f9a04ff6617650689
-  data.tar.gz: 95f6909ff632d697c5cc0deb443980e970a456e4bc808564182860a752df8c803472d7518fc0cd684d523926e54c8dd76f8d8db1861053de4ac4780bfe71d86d
+  metadata.gz: 13a62a6670d52e45fb14a9bc13b9bda31212101925f8f12c7e29e6a09f3437c7176059cce22f8ceae172ac7d52c1cf3e2056e1965fb05d15aec806bc8aaedc4c
+  data.tar.gz: ab6e5d35e35e697f39345367af8199b4003c8ca10c67ce4435781867b96d4eff73ff380d1b544fa3550b142e4ae82d211bc3a6f9602ba4244b09b143863a0e3e

data/.simplecov

@@ -1,7 +1,9 @@
-require 'simplecov-rcov'
+if ENV['COVERAGE']
+  require 'simplecov-rcov'
 
-SimpleCov.coverage_dir "tmp/coverage"
-SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter if ENV['CI']
-SimpleCov.start do
-  add_filter '/test/'
+  SimpleCov.coverage_dir "tmp/coverage"
+  SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter if ENV['CI']
+  SimpleCov.start do
+    add_filter '/test/'
+  end
 end

data/.travis.yml

@@ -1,7 +1,29 @@
 language: ruby
+sudo: false
+cache: bundler
 rvm:
+  - ruby-head
+  - 2.2
   - 2.1
   - 2.0
   - 1.9.3
-  - jruby-19mode
-  - rbx-19mode
+  - jruby
+  - jruby-head
+  - rbx-2
+env:
+  global:
+    - CODECLIMATE_REPO_TOKEN=a682282424953217391072dbe4c6b0f793a6c40312a182bc1eb3e26337dbf0f1
+    - JRUBY_OPTS='--dev -J-Xmx1024M'
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby
+    - rvm: jruby-head
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/ed57a44a47758f95c362
+    on_success: change  # options: [always|never|change] default: always
+    on_failure: always  # options: [always|never|change] default: always
+    on_start: false     # default: false

data/Gemfile

@@ -8,3 +8,7 @@ if ENV['COVERAGE']
     gem 'simplecov-rcov',   :require => false
   end
 end
+
+if ENV['CODECLIMATE_REPO_TOKEN']
+  gem "codeclimate-test-reporter", :group => :test, :require => nil
+end

data/README.md

@@ -0,0 +1,168 @@
+[github]: https://github.com/neopoly/nested_config
+[doc]: http://rubydoc.info/github/neopoly/nested_config/master/file/README.md
+[gem]: https://rubygems.org/gems/nested_config
+[travis]: https://travis-ci.org/neopoly/nested_config
+[codeclimate]: https://codeclimate.com/github/neopoly/nested_config
+[inchpages]: https://inch-ci.org/github/neopoly/nested_config
+
+# nested_config
+
+[![Travis](https://img.shields.io/travis/neopoly/nested_config.svg?branch=master)][travis]
+[![Gem Version](https://img.shields.io/gem/v/nested_config.svg)][gem]
+[![Code Climate](https://img.shields.io/codeclimate/github/neopoly/nested_config.svg)][codeclimate]
+[![Test Coverage](https://codeclimate.com/github/neopoly/nested_config/badges/coverage.svg)][codeclimate]
+[![Inline docs](https://inch-ci.org/github/neopoly/nested_config.svg?branch=master&style=flat)][inchpages]
+
+[Gem][gem] |
+[Source][github] |
+[Documentation][doc]
+
+Simple, static, nested application configuration
+
+## Usage
+
+```ruby
+require 'nested_config'
+
+class MyApp
+  def self.configure
+    yield config
+  end
+
+  def self.config
+    @config ||= MyConfig.new
+  end
+
+  class MyConfig < NestedConfig
+  end
+end
+```
+
+### Basic
+
+```ruby
+MyApp.configure do |config|
+  config.coins = 1000
+  config.user do |user|
+    user.max = 5
+  end
+  config.queue do |queue|
+    queue.workers do |workers|
+      workers.max = 2
+      workers.timeout = 60.seconds
+    end
+  end
+end
+
+MyApp.config.coins # => 1000
+MyApp.config.queue.workers.timeout # => 60
+```
+
+### Special config keys
+
+Sometimes you need to define config keys which contains spaces, dashes or other special chars.
+In those case you can use `NestedConfig#_`:
+
+```ruby
+config = NestedConfig.new.tap do |config|
+  config._ "mix & match" do |mix_and_match|
+    mix_and_match.name = "Mix & match"
+    # ...
+  end
+end
+
+config["mix & match"].name # => Mix & match
+```
+
+### EvaluateOnce
+
+With the module `EvaluateOnce` you can define config value which will be
+evaluated lazily. Once.
+
+```ruby
+class MyConfig
+  include NestedConfig::EvaluateOnce
+end
+
+MyApp.configure do |config|
+  config.country_list = proc { Country.all }
+end
+
+MyApp.config.country_list # => [List of countries]
+MyApp.config.country_list # => [List of countries] (cached)
+```
+
+The initial access to key `country_list` calls (via `call` method) the proc
+and replaces the value. Subsequent calls just fetch the replaced value.
+
+### Modifying config using NestedConfig::WithConfig
+
+Values of NestedConfig can be temporalily modified.
+
+This can be used in tests modifying a global application config inside a
+block:
+
+```ruby
+require 'nested_config/with_config'
+
+class MyCase < MiniTest::TestCase
+  include NestedConfig::WithConfig
+
+  def app_config
+    MyApp.config # global
+  end
+end
+
+class SomeCase < MyCase
+  def setup
+    app_config.tap do |config|
+      config.coins = 1000
+      config.queue do |queue|
+        queue.workers do |workers|
+          workers.max = 5
+        end
+      end
+    end
+  end
+
+  def test_with_basic_value
+    with_config(app_config) do |config|
+      config.coins = 500
+    end
+    # global config reset to previous config
+  end
+
+  def test_queue_with_changed_workers
+    with_config(app_config, :queue, :workers) do |workers|
+      workers.max = 1
+      # do stuff with modified config max value
+    end
+    # global config reset to previous config
+  end
+end
+```
+
+### Key names
+
+**Note**: NestedConfig is not a blank slate so you CANNOT use defined method
+names as keys like `object_id`.
+
+## Installation
+
+    gem install nested_config
+
+## Test
+
+    rake test
+    COVERAGE=1 bundle exec rake test
+
+## TODO
+
+*   Make NestedConfig a blank slate
+
+
+## Release
+
+    edit lib/nested_config/version.rb
+    rake release
+

data/Rakefile

@@ -8,7 +8,7 @@ require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.test_files = FileList.new('test/**/*_test.rb')
   test.libs << 'test'
-  test.verbose = true
+  test.warning = true
 end
 
 # RDoc

data/lib/nested_config.rb

@@ -55,10 +55,26 @@ class NestedConfig
     @hash = hash
   end
 
+  # Define a config with special names
+  #
+  # Example:
+  #   config = NestedConfig.new.tap do |config|
+  #     config._ "mix & match" do |mix_and_match|
+  #       mix_and_match.name = "Mix & match"
+  #       # ...
+  #     end
+  #   end
+  #
+  #   config["mix & match"].name # => Mix & match
+  def _(name)
+    raise ArgumentError, "provide missing block" unless block_given?
+    config = self[name] ||= self.class.new
+    yield config
+  end
+
   def method_missing(name, *args)
     if block_given?
-      config = self[name] ||= self.class.new
-      yield config
+      _(name, &Proc.new)
     else
       key = name.to_s.gsub(/=$/, '')
       if $& == '='

data/lib/nested_config/version.rb

@@ -1,3 +1,3 @@
 class NestedConfig
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/nested_config/with_config.rb

@@ -42,8 +42,8 @@ class NestedConfig
   #   end
   module WithConfig
     def with_config(config, *keys, &block)
-      current = keys.inject(config) do |config, key|
-        config[key] or raise KeyNotFound.new(key, keys)
+      current = keys.inject(config) do |acc, key|
+        acc[key] or raise KeyNotFound.new(key, keys)
       end
       current.respond_to?(:__hash__) or raise ValueNotCloneable.new(current)
 

data/nested_config.gemspec

@@ -17,6 +17,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rake"
-  s.add_development_dependency "minitest"
-  s.add_development_dependency "rdoc"
+  s.add_development_dependency "minitest", "~> 5.8.4"
+  s.add_development_dependency "rdoc", "~> 4.2.2"
 end

data/test/helper.rb

@@ -1,5 +1,7 @@
-require 'rubygems'
-require 'bundler/setup'
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
 
 require 'simplecov' if ENV['COVERAGE']
 

data/test/nested_config_test.rb

@@ -21,25 +21,25 @@ class NestedConfigTest < NestedConfigSpec
     end
 
     test "inspect" do
-      c = config.tap { |c| c.foo = :bar }
+      c = config.tap { |config| config.foo = :bar }
 
       hash = c.__hash__.inspect
       assert_match %r{#<NestedConfig:0x[0-9a-z]+ @hash=#{hash}>}, c.inspect
     end
 
     test "cannot use defined method names as keys" do
-      c = config.tap do |c|
-        c.object_id = :foo
-        c.class     = :bar
+      c = config.tap do |config|
+        config.object_id = :foo
+        config.class     = :bar
       end
       refute_equal :foo, c.object_id
       refute_equal :bar, c.class
     end
 
     test "sets values" do
-      c = config.tap do |c|
-        c.foo = :bar
-        c.bar = :baz
+      c = config.tap do |config|
+        config.foo = :bar
+        config.bar = :baz
       end
 
       assert_equal :bar, c.foo
@@ -48,14 +48,14 @@ class NestedConfigTest < NestedConfigSpec
     end
 
     test "sets deep values" do
-      c = config.tap do |c|
-        c.deep do |deep|
+      c = config.tap do |config|
+        config.deep do |deep|
           deep.key = :foo
           deep.deeper do |deeper|
             deeper.key = :bar
           end
         end
-        c.deep2 do |deep2|
+        config.deep2 do |deep2|
           deep2.key = :baz
         end
       end
@@ -66,40 +66,60 @@ class NestedConfigTest < NestedConfigSpec
     end
 
     test "sets arrays as value" do
-      c = config.tap do |c|
-        c.ary   = [ :foo, :bar ]
-        c.ary2  = :foo, :bar
+      c = config.tap do |config|
+        config.ary   = [ :foo, :bar ]
+        config.ary2  = :foo, :bar
       end
 
       assert_equal [ :foo, :bar ], c.ary
       assert_equal [ :foo, :bar ], c.ary2
     end
 
+    test "sets nested values via []" do
+      c = config.tap do |config|
+        config._ "special key" do |o|
+          o.key = "special"
+        end
+
+        config._ "special key" do |o|
+          o.key2 = "again"
+        end
+      end
+
+      assert_equal "special", c["special key"].key
+      assert_equal "again", c["special key"].key2
+
+      e = assert_raises ArgumentError do
+        c._ "special key"
+      end
+      assert_equal "provide missing block", e.message
+    end
+
     test "cannot nest nil" do
-      c = config.tap do |c|
-        c.key = :foo
+      c = config.tap do |config|
+        config.key = :foo
       end
 
       e = assert_raises NoMethodError do
         c.deep.deeper.key
       end
-      assert_match /NilClass/, e.message
+      assert_match(/NilClass/, e.message)
     end
 
     test "respond_to_missing?" do
-      c = config.tap do |c|
-        c.foo = :bar
+      c = config.tap do |config|
+        config.foo = :bar
       end
 
       assert_respond_to c, :foo
     end
 
     test "re-use already defined nested config" do
-      c = config.tap do |c|
-        c.users do |users|
+      c = config.tap do |config|
+        config.users do |users|
           users.max = 23
         end
-        c.users do |users|
+        config.users do |users|
           users.min = 5
         end
       end
@@ -122,8 +142,8 @@ class NestedConfigTest < NestedConfigSpec
       end
 
       test "nests subclassed config" do
-        c = subclassed_config.tap do |c|
-          c.users do |users|
+        c = subclassed_config.tap do |config|
+          config.users do |users|
             users.max = 23
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nested_config
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Peter Suschlik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-21 00:00:00.000000000 Z
+date: 2016-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -28,30 +28,30 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.8.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.8.4
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.2
 description: ''
 email:
 - ps@neopoly.de
@@ -60,11 +60,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".ruby-version"
 - ".simplecov"
 - ".travis.yml"
 - Gemfile
-- README.rdoc
+- README.md
 - Rakefile
 - lib/nested_config.rb
 - lib/nested_config/evaluate_once.rb
@@ -94,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Simple, static, nested config

data/.ruby-version

@@ -1 +0,0 @@
-2.1

data/README.rdoc

@@ -1,131 +0,0 @@
-= nested_config
-
-{<img src="http://img.shields.io/travis/neopoly/nested_config.svg" alt="Build Status" />}[http://travis-ci.org/neopoly/nested_config] {<img src="http://img.shields.io/gem/v/nested_config.svg" alt="Gem Version" />}[http://rubygems.org/gems/nested_config] {<img src="http://img.shields.io/codeclimate/github/neopoly/nested_config.svg" />}[https://codeclimate.com/github/neopoly/nested_config] {<img src="http://inch-ci.org/github/neopoly/nested_config.svg?branch=master" alt="Inline docs" />}[http://inch-ci.org/github/neopoly/nested_config]
-
-Simple, static, nested application configuration
-
-Gem[https://rubygems.org/gems/nested_config] |
-Source[https://github.com/neopoly/nested_config] |
-Documentation[http://rubydoc.info/github/neopoly/nested_config/master/file/README.rdoc]
-
-== Usage
-
-  require 'nested_config'
-
-  class MyApp
-    def self.configure
-      yield config
-    end
-
-    def self.config
-      @config ||= MyConfig.new
-    end
-
-    class MyConfig < NestedConfig
-    end
-  end
-
-=== Basic
-
-  MyApp.configure do |config|
-    config.coins = 1000
-    config.user do |user|
-      user.max = 5
-    end
-    config.queue do |queue|
-      queue.workers do |workers|
-        workers.max = 2
-        workers.timeout = 60.seconds
-      end
-    end
-  end
-
-  MyApp.config.coins # => 1000
-  MyApp.config.queue.workers.timeout # => 60
-
-
-=== EvaluateOnce
-
-With the module +EvaluateOnce+ you can define config value which will be evaluated lazily. Once.
-
-  class MyConfig
-    include NestedConfig::EvaluateOnce
-  end
-
-  MyApp.configure do |config|
-    config.country_list = proc { Country.all }
-  end
-
-  MyApp.config.country_list # => [List of countries]
-  MyApp.config.country_list # => [List of countries] (cached)
-
-The initial access to key +country_list+ calls (via +call+ method) the proc and replaces the value.
-Subsequent calls just fetch the replaced value.
-
-
-=== Modifying config using NestedConfig::WithConfig
-
-Values of NestedConfig can be temporalily modified.
-
-This can be used in tests modifying a global application config inside a block:
-
-  require 'nested_config/with_config'
-
-  class MyCase < MiniTest::TestCase
-    include NestedConfig::WithConfig
-
-    def app_config
-      MyApp.config # global
-    end
-  end
-
-  class SomeCase < MyCase
-    def setup
-      app_config.tap do |config|
-        config.coins = 1000
-        config.queue do |queue|
-          queue.workers do |workers|
-            workers.max = 5
-          end
-        end
-      end
-    end
-
-    def test_with_basic_value
-      with_config(app_config) do |config|
-        config.coins = 500
-      end
-      # global config reset to previous config
-    end
-
-    def test_queue_with_changed_workers
-      with_config(app_config, :queue, :workers) do |workers|
-        workers.max = 1
-        # do stuff with modified config max value
-      end
-      # global config reset to previous config
-    end
-  end
-
-
-=== Key names
-
-*Note*: NestedConfig is not a blank slate so you CANNOT use defined method names as keys like +object_id+.
-
-== Installation
-
-  gem install nested_config
-
-== Test
-
-  rake test
-  COVERAGE=1 bundle exec rake test
-
-== TODO
-
-* Make NestedConfig a blank slate
-
-== Release
-
-  edit lib/nested_config/version.rb
-  rake release