complex_config 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce05b6145a1404ee49c681b56299be1ea31fb1e4
-  data.tar.gz: 8056f3a0946139f199c27d2f72bfef27f9b7c4eb
+  metadata.gz: c0f60e08a3a290db243d83585edac94e0c62bd4c
+  data.tar.gz: 8bd5bbe19ba7f8001ab5ba4b2bf16f6efd43fad8
 SHA512:
-  metadata.gz: 0e333940bdbf7bc28857ecddde5986b754cc90e388ed077faa53608fee1e9440b64890893581a906da8e0b53d4eb50459b25afeef382dc8eaef87cef5d696842
-  data.tar.gz: 2cc771c28cdbdb6ada774b87f63b20b8f46b94074571b808c5179dc52ce55a2fb7d8c9b057b25f7e98f047aff893404879fac80b14a835fe2dccc454eb8e82e2
+  metadata.gz: 338b9417076107d634da170a25bcebe833762efcc197099c1fe87bd0621a04403fd901b85639b89accdcf7401cd6929d60687ea636b82371cba0c4d828e5594c
+  data.tar.gz: 60865b2f017981a53a09b4e0b7e7a430cc1c7c8cbc39c51dddcba93b0b3bd24eb47ab877a1ecafc2ecd5fccab29837fc30650571a660f66913ef18412bf4e82e

data/.gitignore

@@ -1,7 +1,9 @@
 .*.sw[pon]
 .AppleDouble
 .DS_Store
+.byebug_history
 .rvmrc
 Gemfile.lock
 coverage
+errors.lst
 pkg

data/README.md

@@ -88,12 +88,39 @@ namespacing via the `RAILS_ENV` environment, so
 `complex_config(:products).test.flux_capacitor` returns the same settings
 object.
 
+### Configuration
+
+You can complex\_config by passing a block to its configure method, which you
+can for example do in a rails config/initializers file:
+
+    ComplexConfig.configure do |config|
+      config.deep_freeze = !Rails.env.test? # allow modification during tests b/c of stubs etc.
+      
+      # config.env = 'some_environment'
+
+      # config.config_dir = Rails.root + 'config'
+
+      config.add_plugin -> id do
+        if base64_string = ask_and_send("#{id}_base64")
+          Base64.decode64 base64_string
+        else
+          skip
+        end
+      end
+    end
+
 ### Adding plugins
 
 You can add your own plugins by calling
 
     ComplexConfig::Provider.add_plugin SomeNamespace::PLUGIN
 
+or in the configuration block by calling
+
+    ComplexConfig.configure do |config|
+      config.add_plugin SomeNamespace::PLUGIN
+    end
+
 ### Implementing your own plugins
 
 A plugin is just a lambda expression with a single argument `id` which
@@ -116,6 +143,9 @@ Here is the `ComplexConfig::Plugins::MONEY` plugin for example:
     end
 
 ## Changes
+* 2015-11-19 Release 0.5.0
+  * Support rails reloading behaviour.
+  * Allow configuration via ComplexConfig.configure(&block) method.
 * 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

data/Rakefile

@@ -10,7 +10,9 @@ GemHadar do
   summary     'configuration library'
   description 'This library allows you to access configuration files via a simple interface'
   test_dir    'spec'
-  ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', 'coverage', '.rvmrc', '.AppleDouble', '.DS_Store'
+  ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', 'coverage', '.rvmrc',
+    '.AppleDouble', '.DS_Store', '.byebug_history', 'errors.lst'
+
   readme      'README.md'
   title       "#{name.camelize} -- configuration library"
   licenses    << 'Apache-2.0'

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/complex_config.gemspec

@@ -1,24 +1,24 @@
 # -*- encoding: utf-8 -*-
-# stub: complex_config 0.4.0 ruby lib
+# stub: complex_config 0.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "complex_config"
-  s.version = "0.4.0"
+  s.version = "0.5.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-17"
+  s.date = "2015-11-19"
   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/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.extra_rdoc_files = ["README.md", "lib/complex_config.rb", "lib/complex_config/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/railtie.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/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/railtie.rb", "lib/complex_config/rude.rb", "lib/complex_config/settings.rb", "lib/complex_config/shortcuts.rb", "lib/complex_config/version.rb", "spec/complex_config/config_spec.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.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"]
+  s.test_files = ["spec/complex_config/config_spec.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/spec_helper.rb"]
 
   if s.respond_to? :specification_version then
     s.specification_version = 4

data/lib/complex_config.rb

@@ -7,4 +7,8 @@ require 'complex_config/version'
 require 'complex_config/errors'
 require 'complex_config/proxy'
 require 'complex_config/settings'
+require 'complex_config/config'
 require 'complex_config/provider'
+defined? Rails and require 'complex_config/railtie'
+
+

data/lib/complex_config/config.rb

@@ -0,0 +1,32 @@
+module ComplexConfig
+  Config = Struct.new('Config', :config_dir, :env, :deep_freeze, :plugins) do
+    def initialize(*)
+      super
+      self.plugins = []
+    end
+
+    def configure(provider)
+      each_pair do |name, value|
+        value.nil? and next
+        name == :plugins and next
+        provider.__send__("#{name}=", value)
+      end
+      plugins.each do |code|
+        provider.add_plugin(code)
+      end
+      self
+    end
+
+    def add_plugin(code)
+      plugins << code
+      self
+    end
+  end
+
+  def self.configure
+    config = Config.new
+    yield config
+    ComplexConfig::Provider.configure_with config
+    config
+  end
+end

data/lib/complex_config/provider.rb

@@ -11,6 +11,11 @@ class ComplexConfig::Provider
     @deep_freeze = true
   end
 
+  def configure_with(config)
+    config.configure(self)
+    flush_cache
+  end
+
   attr_reader :plugins
 
   def add_plugin(plugin)
@@ -33,8 +38,20 @@ class ComplexConfig::Provider
     end
   end
 
+  def config_dir=(dir)
+    if dir.nil?
+      @config_dir = nil
+    else
+      @config_dir = Pathname.new(dir)
+    end
+  end
+
+  def config_dir
+    @config_dir || (defined?(Rails) && Rails.root || Pathname.pwd) + 'config'
+  end
+
   def pathname(name)
-    root + "config/#{name}.yml"
+    config_dir + "#{name}.yml"
   end
 
   def config(pathname, name = nil)
@@ -70,15 +87,9 @@ class ComplexConfig::Provider
     erb.result
   end
 
-  attr_writer :root
-
-  def root
-    @root || defined?(Rails) && Rails.root || Pathname.pwd
-  end
-
-  attr_writer :env
-
   def env
     @env || defined?(Rails) && Rails.env || ENV['RAILS_ENV'] || 'development'
   end
+
+  attr_writer :env
 end

data/lib/complex_config/railtie.rb

@@ -0,0 +1,7 @@
+module ComplexConfig
+  class Railtie < Rails::Railtie
+    config.to_prepare do
+      ComplexConfig::Provider.flush_cache
+    end
+  end
+end

data/lib/complex_config/version.rb

@@ -1,6 +1,6 @@
 module ComplexConfig
   # ComplexConfig version
-  VERSION         = '0.4.0'
+  VERSION         = '0.5.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/config_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+RSpec.describe ComplexConfig::Config do
+  let :plugin_code do
+    -> id { skip }
+  end
+
+  it 'configures' do
+    ComplexConfig.configure do |config|
+      config.config_dir = 'foo'
+      config.env        = 'bar'
+      config.add_plugin plugin_code
+    end
+    expect(ComplexConfig::Provider.config_dir).to eq Pathname.new('foo')
+    expect(ComplexConfig::Provider.env).to eq 'bar'
+    expect(ComplexConfig::Provider.plugins).to include plugin_code
+  end
+end
+

data/spec/complex_config/provider_spec.rb

@@ -34,28 +34,22 @@ RSpec.describe ComplexConfig::Provider do
   end
 
   context 'pathnames' do
-    module ::Rails
-      def self.root
-      end unless respond_to?(:root)
-    end
-
-    after do
-      provider.root = nil
-    end
-
-    it 'can compute default pathname' do
-      provider.root = Pathname.new('bar')
-      expect(provider.pathname('foo')).to eq Pathname.new('bar/config/foo.yml')
+    before do
+      module ::Rails
+        def self.root
+        end
+      end
+      provider.config_dir = nil
     end
 
     it 'can derive rails root from Rails.root if present' do
-      dir = Pathname.new('bar')
-      expect(Rails).to receive(:root).and_return(dir)
-      expect(provider.root).to eq dir
+      allow(::Rails).to receive(:root).and_return Pathname.new('bar')
+      dir = Pathname.new('bar/config')
+      expect(provider.config_dir).to eq dir
     end
 
     it 'falls back to current working directory by default' do
-      expect(provider.root).to eq Pathname.pwd
+      expect(provider.config_dir).to eq Pathname.pwd + 'config'
     end
   end
 
@@ -94,7 +88,7 @@ RSpec.describe ComplexConfig::Provider do
 
   context 'handling configuration files with []' do
     before do
-      provider.root = Pathname.new(__FILE__).dirname.dirname
+      provider.config_dir = Pathname.new(__FILE__).dirname.dirname + 'config'
     end
 
     it 'returns the correct configuration' do

data/spec/complex_config/shortcuts_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe 'shortcuts' do
   end
 
   before do
-    provider.root = Pathname.new(__FILE__).dirname.dirname
+    provider.config_dir = Pathname.new(__FILE__).dirname.dirname + 'config'
   end
 
   it 'returns a proxy object for the shortcuts' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: complex_config
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Florian Frank
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-17 00:00:00.000000000 Z
+date: 2015-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -129,6 +129,7 @@ extensions: []
 extra_rdoc_files:
 - README.md
 - lib/complex_config.rb
+- lib/complex_config/config.rb
 - lib/complex_config/errors.rb
 - lib/complex_config/plugins.rb
 - lib/complex_config/plugins/enable.rb
@@ -136,6 +137,7 @@ extra_rdoc_files:
 - lib/complex_config/plugins/uri.rb
 - lib/complex_config/provider.rb
 - lib/complex_config/proxy.rb
+- lib/complex_config/railtie.rb
 - lib/complex_config/rude.rb
 - lib/complex_config/settings.rb
 - lib/complex_config/shortcuts.rb
@@ -154,6 +156,7 @@ files:
 - complex_config.gemspec
 - config/products.yml
 - lib/complex_config.rb
+- lib/complex_config/config.rb
 - lib/complex_config/errors.rb
 - lib/complex_config/plugins.rb
 - lib/complex_config/plugins/enable.rb
@@ -161,10 +164,12 @@ files:
 - lib/complex_config/plugins/uri.rb
 - lib/complex_config/provider.rb
 - lib/complex_config/proxy.rb
+- lib/complex_config/railtie.rb
 - lib/complex_config/rude.rb
 - lib/complex_config/settings.rb
 - lib/complex_config/shortcuts.rb
 - lib/complex_config/version.rb
+- spec/complex_config/config_spec.rb
 - spec/complex_config/plugins_spec.rb
 - spec/complex_config/provider_spec.rb
 - spec/complex_config/settings_spec.rb
@@ -201,6 +206,7 @@ signing_key:
 specification_version: 4
 summary: configuration library
 test_files:
+- spec/complex_config/config_spec.rb
 - spec/complex_config/plugins_spec.rb
 - spec/complex_config/provider_spec.rb
 - spec/complex_config/settings_spec.rb