complex_config 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6959598393b83ee40918943044f4c4137f67ee6
-  data.tar.gz: 88b984849cc26105ecb236cd46b7c426a5f72437
+  metadata.gz: ce05b6145a1404ee49c681b56299be1ea31fb1e4
+  data.tar.gz: 8056f3a0946139f199c27d2f72bfef27f9b7c4eb
 SHA512:
-  metadata.gz: e4d354e51cf38457e101eea56a2015d8e16ffbd4d1423196f694e707733fe0fafdfd5b7a52a2a36004e062022b51b3f242ee66e328184184710d4cbfa753ff85
-  data.tar.gz: c146d3ebd2914af05e521f9925aef0a99dea4d61e28b91692bf4871d3fe90219fc8f1786566a1a692fd0c86192ef618884c6a7181546e2f7c2854d2d79359a83
+  metadata.gz: 0e333940bdbf7bc28857ecddde5986b754cc90e388ed077faa53608fee1e9440b64890893581a906da8e0b53d4eb50459b25afeef382dc8eaef87cef5d696842
+  data.tar.gz: 2cc771c28cdbdb6ada774b87f63b20b8f46b94074571b808c5179dc52ce55a2fb7d8c9b057b25f7e98f047aff893404879fac80b14a835fe2dccc454eb8e82e2

data/README.md

@@ -17,7 +17,8 @@ You can also put this line into your Gemfile
     gem 'complex_config', require: 'complex_config/rude'
 
 and bundle. This command will enable all the default plugins and make the `cc`
-and `complex_config` shortcuts available.
+and `complex_config` shortcuts available. The configurations are expected to be
+in the `config` subdirectory according to the rails convention.
 
 ## Usage
 
@@ -52,34 +53,37 @@ can now access the configuration.
 
 Fetching the name of a product:
 
-    > cc(:products).flux_capacitor.enterprise_version.name => "Flux Capacitor Enterpise"
+    > cc.products.flux_capacitor.enterprise_version.name => "Flux Capacitor Enterpise"
+
+If the name of configuration file isn't valid ruby method name syntax you can also
+use `cc(:products).flux_capacitor…` to avoid this problem.
 
 Fetching the price of a product in cents:
 
-    > cc(:products).flux_capacitor.enterprise_version.price_in_cents => 160000000
+    > c.products.flux_capacitor.enterprise_version.price_in_cents => 160000000
 
 Fetching the price of a product and using the ComplexConfig::Plugins::MONEY
 plugin to format it:
 
-    > cc(:products).flux_capacitor.enterprise_version.price.format => "€1,600,000.00"
+    > c.products.flux_capacitor.enterprise_version.price.format => "€1,600,000.00"
 
 Fetching the URL of a product manual as a string:
 
-    > cc(:products).flux_capacitor.enterprise_version.manual_pdf_url => "http://brown-inc.com/manuals/fc_enterprise.pdf"
+    > c.products.flux_capacitor.enterprise_version.manual_pdf_url => "http://brown-inc.com/manuals/fc_enterprise.pdf"
 
 Fetching the URL of a product manual and using the ComplexConfig::Plugins::URI
 plugin return an URI instance:
 
-    > cc(:products).flux_capacitor.enterprise_version.manual_pdf_uri => #<URI::HTTP:0x007ff626d2a2e8 URL:http://brown-inc.com/manuals/fc_enterprise.pdf>
+    > c.products.flux_capacitor.enterprise_version.manual_pdf_uri => #<URI::HTTP:0x007ff626d2a2e8 URL:http://brown-inc.com/manuals/fc_enterprise.pdf>
 
 You can also fetch config settings from a different environment:
 
-    >> pp cc(:products, :test); nil
-    flux_capacitor.test_version.name = "Yadayada"
-    flux_capacitor.test_version.price_in_cents = 666
-    flux_capacitor.test_version.manual_pdf_url = "http://staging.brown-inc.com/manuals/fc_10.pdf"
+    >> pp cc.products(:test); nil
+    products.flux_capacitor.test_version.name = "Yadayada"
+    products.flux_capacitor.test_version.price_in_cents = 666
+    products.flux_capacitor.test_version.manual_pdf_url = "http://staging.brown-inc.com/manuals/fc_10.pdf"
 
-Calling `complex_config(:products)` instead of `cc(…)` would skip the implicite
+Calling `complex_config.products.` instead of `cc(…)` would skip the implicite
 namespacing via the `RAILS_ENV` environment, so
 `complex_config(:products).test.flux_capacitor` returns the same settings
 object.
@@ -112,6 +116,8 @@ Here is the `ComplexConfig::Plugins::MONEY` plugin for example:
     end
 
 ## Changes
+* 2015-11-17 Release 0.4.0
+  * Add root object for configuration, e. g. cc.name instead of cc(name).
 * 2015-11-03 Release 0.3.1
   * Add missing dependency to tins.
 * 2015-11-03 Release 0.3.0

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/complex_config.gemspec

@@ -1,22 +1,22 @@
 # -*- encoding: utf-8 -*-
-# stub: complex_config 0.3.1 ruby lib
+# stub: complex_config 0.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "complex_config"
-  s.version = "0.3.1"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Florian Frank"]
-  s.date = "2015-11-03"
+  s.date = "2015-11-17"
   s.description = "This library allows you to access configuration files via a simple interface"
   s.email = "flori@ping.de"
-  s.extra_rdoc_files = ["README.md", "lib/complex_config.rb", "lib/complex_config/errors.rb", "lib/complex_config/plugins.rb", "lib/complex_config/plugins/enable.rb", "lib/complex_config/plugins/money.rb", "lib/complex_config/plugins/uri.rb", "lib/complex_config/provider.rb", "lib/complex_config/rude.rb", "lib/complex_config/settings.rb", "lib/complex_config/shortcuts.rb", "lib/complex_config/version.rb"]
-  s.files = [".gitignore", ".rspec", ".travis.yml", ".utilsrc", "COPYING", "Gemfile", "README.md", "Rakefile", "TODO.md", "VERSION", "complex_config.gemspec", "lib/complex_config.rb", "lib/complex_config/errors.rb", "lib/complex_config/plugins.rb", "lib/complex_config/plugins/enable.rb", "lib/complex_config/plugins/money.rb", "lib/complex_config/plugins/uri.rb", "lib/complex_config/provider.rb", "lib/complex_config/rude.rb", "lib/complex_config/settings.rb", "lib/complex_config/shortcuts.rb", "lib/complex_config/version.rb", "spec/complex_config/plugins_spec.rb", "spec/complex_config/provider_spec.rb", "spec/complex_config/settings_spec.rb", "spec/complex_config/shortcuts_spec.rb", "spec/config/broken_config.yml", "spec/config/config.yml", "spec/spec_helper.rb"]
+  s.extra_rdoc_files = ["README.md", "lib/complex_config.rb", "lib/complex_config/errors.rb", "lib/complex_config/plugins.rb", "lib/complex_config/plugins/enable.rb", "lib/complex_config/plugins/money.rb", "lib/complex_config/plugins/uri.rb", "lib/complex_config/provider.rb", "lib/complex_config/proxy.rb", "lib/complex_config/rude.rb", "lib/complex_config/settings.rb", "lib/complex_config/shortcuts.rb", "lib/complex_config/version.rb"]
+  s.files = [".gitignore", ".rspec", ".travis.yml", ".utilsrc", "COPYING", "Gemfile", "README.md", "Rakefile", "TODO.md", "VERSION", "complex_config.gemspec", "config/products.yml", "lib/complex_config.rb", "lib/complex_config/errors.rb", "lib/complex_config/plugins.rb", "lib/complex_config/plugins/enable.rb", "lib/complex_config/plugins/money.rb", "lib/complex_config/plugins/uri.rb", "lib/complex_config/provider.rb", "lib/complex_config/proxy.rb", "lib/complex_config/rude.rb", "lib/complex_config/settings.rb", "lib/complex_config/shortcuts.rb", "lib/complex_config/version.rb", "spec/complex_config/plugins_spec.rb", "spec/complex_config/provider_spec.rb", "spec/complex_config/settings_spec.rb", "spec/complex_config/shortcuts_spec.rb", "spec/config/broken_config.yml", "spec/config/config.yml", "spec/spec_helper.rb"]
   s.homepage = "https://github.com/flori/complex_config"
   s.licenses = ["Apache-2.0"]
   s.rdoc_options = ["--title", "ComplexConfig -- configuration library", "--main", "README.md"]
-  s.rubygems_version = "2.4.8"
+  s.rubygems_version = "2.5.0"
   s.summary = "configuration library"
   s.test_files = ["spec/complex_config/plugins_spec.rb", "spec/complex_config/provider_spec.rb", "spec/complex_config/settings_spec.rb", "spec/complex_config/shortcuts_spec.rb", "spec/spec_helper.rb"]
 

data/config/products.yml

@@ -0,0 +1,21 @@
+development:
+  flux_capacitor:
+    version_20:
+      name: Flux Capacitor Version 2.0
+      price_in_cents: 12_000_00
+      manual_pdf_url: "http://brown-inc.com/manuals/fc_20.pdf"
+    pro_version:
+      name: Flux Capacitor Professional
+      price_in_cents: 23_000_00
+      manual_pdf_url: "http://brown-inc.com/manuals/fc_pro.pdf"
+    enterprise_version:
+      name: Flux Capacitor Enterpise
+      price_in_cents: 1_600_000_00
+      manual_pdf_url: "http://brown-inc.com/manuals/fc_enterprise.pdf"
+
+test:
+  flux_capacitor:
+    test_version:
+      name: Yadayada
+      price_in_cents: 6_66
+      manual_pdf_url: "http://staging.brown-inc.com/manuals/fc_10.pdf"

data/lib/complex_config.rb

@@ -5,5 +5,6 @@ end
 
 require 'complex_config/version'
 require 'complex_config/errors'
+require 'complex_config/proxy'
 require 'complex_config/settings'
 require 'complex_config/provider'

data/lib/complex_config/provider.rb

@@ -37,9 +37,10 @@ class ComplexConfig::Provider
     root + "config/#{name}.yml"
   end
 
-  def config(pathname)
+  def config(pathname, name = nil)
     result = evaluate(pathname)
-    ComplexConfig::Settings[::YAML.load(result, pathname)].tap do |settings|
+    hash = ::YAML.load(result, pathname)
+    ComplexConfig::Settings.build(name, hash).tap do |settings|
       deep_freeze? and settings.deep_freeze
     end
   rescue ::Errno::ENOENT => e
@@ -49,10 +50,14 @@ class ComplexConfig::Provider
   end
 
   def [](name)
-    config pathname(name)
+    config pathname(name), name
   end
   memoize_method :[]
 
+  def proxy(env = nil)
+    ComplexConfig::Proxy.new(env)
+  end
+
   def flush_cache
     memoize_cache_clear
     self

data/lib/complex_config/proxy.rb

@@ -0,0 +1,32 @@
+module ComplexConfig
+  class Proxy < BasicObject
+    def initialize(env = nil)
+      @env = env
+    end
+
+    def to_s
+      'ComplexConfig::Proxy'
+    end
+
+    def inspect
+      "#<#{to_s}>"
+    end
+
+    def reload
+      ::ComplexConfig::Provider.flush_cache
+      self
+    end
+
+    def method_missing(name, *args)
+      config = ::ComplexConfig::Provider[name]
+      env, = args
+      if env
+        config[env]
+      elsif @env
+        config[@env]
+      else
+        config
+      end
+    end
+  end
+end

data/lib/complex_config/settings.rb

@@ -1,11 +1,32 @@
 require 'json'
 require 'tins/xt/ask_and_send'
+require 'tins/thread_local'
 
 class ComplexConfig::Settings < JSON::GenericObject
   def self.[](*a)
     from_hash *a
   end
 
+  class << self
+    extend Tins::ThreadLocal
+
+    thread_local :name_prefix
+  end
+
+  attr_accessor :name_prefix
+
+  def self.build(name, hash)
+    name.nil? or self.name_prefix = name.to_sym
+    self[hash]
+  ensure
+    self.name_prefix = nil
+  end
+
+  def initialize(*)
+    self.name_prefix = self.class.name_prefix
+    super
+  end
+
   def attribute_set?(name)
     table.key?(name.to_sym)
   end
@@ -37,7 +58,7 @@ class ComplexConfig::Settings < JSON::GenericObject
     end
   end
 
-  def pathes(hash = table, path_sep: ?., prefix: '', result: {})
+  def pathes(hash = table, path_sep: ?., prefix: name_prefix.to_s, result: {})
     hash.each do |key, value|
       path = prefix.empty? ? key.to_s : "#{prefix}#{path_sep}#{key}"
       case value

data/lib/complex_config/shortcuts.rb

@@ -1,10 +1,18 @@
 require 'complex_config'
 
-def complex_config_with_env(name, env = ComplexConfig::Provider.env)
-  ComplexConfig::Provider[name][env.to_s]
+def complex_config_with_env(name = nil, env = ComplexConfig::Provider.env)
+  if name
+    ComplexConfig::Provider[name][env.to_s]
+  else
+    ComplexConfig::Provider.proxy(env.to_s)
+  end
 end
 alias cc complex_config_with_env
 
-def complex_config(name)
-  ComplexConfig::Provider[name]
+def complex_config(name = nil)
+  if name
+    ComplexConfig::Provider[name]
+  else
+    ComplexConfig::Provider.proxy
+  end
 end

data/lib/complex_config/version.rb

@@ -1,6 +1,6 @@
 module ComplexConfig
   # ComplexConfig version
-  VERSION         = '0.3.1'
+  VERSION         = '0.4.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/spec/complex_config/provider_spec.rb

@@ -107,8 +107,8 @@ RSpec.describe ComplexConfig::Provider do
       }.to change {
         provider.instance.__send__(:__memoize_cache__).size
       }.by(1)
-      expect(provider['config']).to be_a ComplexConfig::Settings
       expect(provider).not_to receive(:config)
+      expect(provider['config']).to be_a ComplexConfig::Settings
     end
 
     it 'can flush loaded configurations' do

data/spec/complex_config/shortcuts_spec.rb

@@ -10,35 +10,56 @@ RSpec.describe 'shortcuts' do
     provider.root = Pathname.new(__FILE__).dirname.dirname
   end
 
+  it 'returns a proxy object for the shortcuts' do
+    expect(complex_config_with_env.to_s).to eq 'ComplexConfig::Proxy'
+    expect(cc.inspect).to eq '#<ComplexConfig::Proxy>'
+    expect(complex_config.to_s).to eq 'ComplexConfig::Proxy'
+    expect(cc.config.name_prefix).to eq :config
+  end
+
+  it 'can be reloaded via shortcut' do
+    expect(ComplexConfig::Provider).to receive(:flush_cache)
+    complex_config.reload
+  end
+
   it 'has the complex_config_with_env "shortcut"' do
-    settings = complex_config_with_env('config', 'development')
+    settings = complex_config_with_env.config('development')
     expect(settings).to be_a ComplexConfig::Settings
     expect(settings.config.baz).to eq 'something'
-    settings = complex_config_with_env('config', 'test')
+    settings = complex_config_with_env.config('test')
     expect(settings).to be_a ComplexConfig::Settings
     expect(settings.config.baz).to eq 'something else'
   end
 
   it 'has the alias cc for complex_config_with_env' do
-    settings = cc(:config, :development)
+    settings = cc.config(:development)
     expect(settings).to be_a ComplexConfig::Settings
     expect(settings.config.baz).to eq 'something'
   end
 
   it 'considers the environment for complex_config_with_env' do
-    settings = complex_config_with_env('config')
+    settings = complex_config_with_env.config
     expect(settings).to be_a ComplexConfig::Settings
     expect(settings.config.baz).to eq 'something'
     allow(provider).to receive(:env).and_return('test')
-    settings = complex_config_with_env('config')
+    settings = complex_config_with_env.config
     expect(settings).to be_a ComplexConfig::Settings
     expect(settings.config.baz).to eq 'something else'
   end
 
   it 'has the complex_config shortcut' do
-    settings = complex_config(:config)
+    settings = complex_config.config
     expect(settings).to be_a ComplexConfig::Settings
     expect(settings.development.config.baz).to eq 'something'
     expect(settings.test.config.baz).to eq 'something else'
   end
+
+  it 'has alternatives instead of method syntax' do
+    settings = complex_config_with_env(:config, :development)
+    expect(settings).to be_a ComplexConfig::Settings
+    settings = cc(:config)
+    expect(settings).to be_a ComplexConfig::Settings
+    settings = complex_config(:config)
+    expect(settings).to be_a ComplexConfig::Settings
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: complex_config
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Florian Frank
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-03 00:00:00.000000000 Z
+date: 2015-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -135,6 +135,7 @@ extra_rdoc_files:
 - lib/complex_config/plugins/money.rb
 - lib/complex_config/plugins/uri.rb
 - lib/complex_config/provider.rb
+- lib/complex_config/proxy.rb
 - lib/complex_config/rude.rb
 - lib/complex_config/settings.rb
 - lib/complex_config/shortcuts.rb
@@ -151,6 +152,7 @@ files:
 - TODO.md
 - VERSION
 - complex_config.gemspec
+- config/products.yml
 - lib/complex_config.rb
 - lib/complex_config/errors.rb
 - lib/complex_config/plugins.rb
@@ -158,6 +160,7 @@ files:
 - lib/complex_config/plugins/money.rb
 - lib/complex_config/plugins/uri.rb
 - lib/complex_config/provider.rb
+- lib/complex_config/proxy.rb
 - lib/complex_config/rude.rb
 - lib/complex_config/settings.rb
 - lib/complex_config/shortcuts.rb
@@ -193,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: configuration library