complex_config 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02095dc1d57e5c7310afb22efd984d69b3054473
-  data.tar.gz: ac7bfb58dae97e30b401447649accdeb3ebd3afc
+  metadata.gz: be1bf6c1cc5c0472312df63b9f4e9b5d2165b659
+  data.tar.gz: 9234cf89ba86ed15fdc24041000ee334340d3ccf
 SHA512:
-  metadata.gz: a136b2e271793501909062fb7ec333041de9a53c19490d19655d05946abb3ca7e0bfecff51f944eafd3c7d6d206f7eb491f0a65ae7b98456b50dd7d23976b965
-  data.tar.gz: 56fe16ae1198d30650e57ab501725a15ef78de7afe2930962f62a9b838d1265ee0f39afc8b8e1ff9952686bfbf29469ef1e13538ef4efcdc6748132e4a170e4a
+  metadata.gz: 47801efebe328219554dff8380be0db7098f430d2f913b461999fae3513f01ecab0a67300060222311a8cb0abc0e2c3d81e3017cb289f8d87b28b571f1a8eff6
+  data.tar.gz: 32a4b840c5ff2ab5a89a00b972f3efdf295bfb0cc4d2dec41bd6731d6595956036bec2a1e82af7b27ae490f89ceb4da815600afaf9b188e0a69261447b974bd2

data/Gemfile

@@ -3,3 +3,5 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem "codeclimate-test-reporter", group: :development, require: nil

data/README.md

@@ -114,6 +114,9 @@ Here is the `ComplexConfig::Plugins::MONEY` plugin for example:
 
 ## Changes
 
+* 2014-12-15 Release 0.1.0
+  * Freeze configuration by default.
+
 * 2014-12-12 Release 0.0.0
 
 ## Download

data/TODO.md

@@ -0,0 +1,5 @@
+# TODO
+
+- Cache the plugin results?
+- Figure out why rspec don't like my double dispatch.
+

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/complex_config.gemspec

@@ -1,18 +1,18 @@
 # -*- encoding: utf-8 -*-
-# stub: complex_config 0.0.0 ruby lib
+# stub: complex_config 0.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "complex_config"
-  s.version = "0.0.0"
+  s.version = "0.1.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 = "2014-12-12"
+  s.date = "2014-12-15"
   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", "Gemfile", "README.md", "Rakefile", "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.files = [".gitignore", ".rspec", ".travis.yml", ".utilsrc", "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.homepage = "https://github.com/flori/complex_config"
   s.licenses = ["Apache-2.0"]
   s.rdoc_options = ["--title", "ComplexConfig -- configuration library", "--main", "README.md"]

data/lib/complex_config/provider.rb

@@ -7,7 +7,8 @@ class ComplexConfig::Provider
   include Tins::SexySingleton
 
   def initialize
-    @plugins = Set.new
+    @plugins     = Set.new
+    @deep_freeze = true
   end
 
   attr_reader :plugins
@@ -17,6 +18,12 @@ class ComplexConfig::Provider
     self
   end
 
+  attr_writer :deep_freeze
+
+  def deep_freeze?
+    !!@deep_freeze
+  end
+
   def apply_plugins(setting, id)
     @plugins.find do |plugin|
       catch :skip do
@@ -32,7 +39,9 @@ class ComplexConfig::Provider
 
   def config(pathname)
     result = evaluate(pathname)
-    ComplexConfig::Settings[::YAML.load(result, pathname)]
+    ComplexConfig::Settings[::YAML.load(result, pathname)].tap do |settings|
+      deep_freeze? and settings.deep_freeze
+    end
   rescue ::Errno::ENOENT => e
     raise ComplexConfig::ComplexConfigError.wrap(:ConfigurationFileMissing, e)
   rescue ::Psych::SyntaxError => e

data/lib/complex_config/settings.rb

@@ -35,6 +35,13 @@ class ComplexConfig::Settings < JSON::GenericObject
 
   alias inspect to_s
 
+  def deep_freeze
+    each do |_, v|
+      v.ask_and_send(:deep_freeze) || (v.freeze rescue v)
+    end
+    freeze
+  end
+
   private
 
   def respond_to_missing?(id, include_private = false)

data/lib/complex_config/version.rb

@@ -1,6 +1,6 @@
 module ComplexConfig
   # ComplexConfig version
-  VERSION         = '0.0.0'
+  VERSION         = '0.1.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

@@ -5,6 +5,10 @@ RSpec.describe ComplexConfig::Provider do
     ComplexConfig::Provider
   end
 
+  after do
+    provider.flush_cache
+  end
+
   context 'plugin' do
     let :plugin do
       -> id { __send__ id }
@@ -62,6 +66,21 @@ RSpec.describe ComplexConfig::Provider do
       ).to be_a ComplexConfig::Settings
     end
 
+    it 'has deep frozen settings' do
+      settings = provider.config(asset('config.yml'))
+      expect(settings).to be_frozen
+    end
+
+    it 'deep freezing can be disabled' do
+      begin
+        provider.deep_freeze = false
+        settings = provider.config(asset('config.yml'))
+        expect(settings).not_to be_frozen
+      ensure
+        provider.deep_freeze = true
+      end
+    end
+
     it 'handles missing configuration files' do
       expect { provider.config(asset('nix_config.yml')) }.to\
         raise_error(ComplexConfig::ConfigurationFileMissing)
@@ -78,10 +97,6 @@ RSpec.describe ComplexConfig::Provider do
       provider.root = Pathname.new(__FILE__).dirname.dirname
     end
 
-    after do
-      provider.flush_cache
-    end
-
     it 'returns the correct configuration' do
       expect(provider['config']).to be_a ComplexConfig::Settings
     end

data/spec/complex_config/settings_spec.rb

@@ -1,10 +1,6 @@
 require 'spec_helper'
 
 RSpec.describe ComplexConfig::Settings do
-  let :provider do
-    ComplexConfig::Provider
-  end
-
   let :settings do
     ComplexConfig::Settings[
       foo: {
@@ -44,15 +40,15 @@ RSpec.describe ComplexConfig::Settings do
 EOT
   end
   it 'raises exception if expected attribute is missing' do
-    skip "doesn't work in spec?!?" # XXX
-    expect { settings.foo.baz }.to raise_error(ComplexConfig::AttributeMissing)
+    pending "still doesn't work"
+    expect { settings.nix }.to raise_error(ComplexConfig::AttributeMissing)
   end
 
   it 'can be checked for set attributes' do
     expect(settings.foo.attribute_set?(:bar)).to eq true
     expect(settings.foo.bar?).to be_truthy
     expect(settings.foo.attribute_set?(:baz)).to eq false
-    # XXX doesn't work in spec?!? expect(settings.foo.baz?).to be_falsy
+    #expect(settings.foo.baz?).to be_falsy
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: complex_config
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Florian Frank
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-12 00:00:00.000000000 Z
+date: 2014-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -133,6 +133,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- TODO.md
 - VERSION
 - complex_config.gemspec
 - lib/complex_config.rb