gem_config 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1046dd50da7f348b21c6bfcc3e71903012f82897
-  data.tar.gz: 44245b10f3f50bd9edde6414fb25f109bbd5378c
+  metadata.gz: 25092c71a9f45af628d36f7a87b85778ebce2981
+  data.tar.gz: 8f72f574e780277154637e2b3cb0417801c9ab3f
 SHA512:
-  metadata.gz: 01e105eeb51018f58561cecaeb4816ba754449488401d58c1544bdbfa145124a4689231014c40fefd66e988b600dd35094cc634bb1c8009d8993801f0ea6c202
-  data.tar.gz: 6402a8a2746c3319e2742db56c4f8999a032f18242f9f4b7187583471c8ec641f798e42d4f524926257c43955c6ad68132f9e4e6a7227420672832ab8220e832
+  metadata.gz: 217c0a4b1fc72bb96ca9e1f4e66e131289a39250c5d93f81028fbc151f90d1cea5ffe032d42546424194ed658c2c8e72c676a215c75bae2af33af270cd219cef
+  data.tar.gz: 98e921ae234bd2191c1d18606b1b84772d3eb8132dd83bbde80d720a438abd7ca6eedd7668d396bde28a6b57ca6b1aa2ac461b688924a82f269726e1833f8b97

data/Guardfile

@@ -0,0 +1,9 @@
+guard 'rspec', cmd: 'bundle exec rspec', failed_mode: :none, all_after_pass: true, all_on_start: true do
+  # Specs
+  watch(%r(^spec/.+_spec\.rb$))
+  watch('spec/spec_helper.rb')       { 'spec' }
+  watch(%r(^spec/support/(.+)\.rb$)) { 'spec' }
+
+  # Files
+  watch(%r(^lib/(.+)\.rb$))          { |m| "spec/#{m[1]}_spec.rb" }
+end

data/gem_config.gemspec

@@ -20,5 +20,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_development_dependency 'rake', '>= 0.9.0'
-  gem.add_development_dependency 'rspec', '~> 2.13.0'
+  gem.add_development_dependency 'rspec', '~> 3.0.0.beta2'
+  gem.add_development_dependency 'guard-rspec', '~> 4.2'
 end

data/lib/gem_config/base.rb

@@ -10,12 +10,16 @@ module GemConfig
       end
 
       def configuration
-        @configuration ||= Configuration.new
+        @configuration ||= Configuration.new(self)
       end
 
       def with_configuration(&block)
         configuration.rules.instance_eval(&block)
       end
+
+      def after_configuration_change(&block)
+        @after_configuration_change = block
+      end
     end
   end
 end

data/lib/gem_config/configuration.rb

@@ -1,5 +1,9 @@
 module GemConfig
   class Configuration
+    def initialize(parent = nil)
+      @parent = parent
+    end
+
     def rules
       @rules ||= Rules.new
     end
@@ -19,6 +23,7 @@ module GemConfig
     def unset(key)
       raise InvalidKeyError, "#{key} is not a valid key." unless self.rules.keys.include?(key.to_sym)
       remove_instance_variable "@#{key}" if instance_variable_defined?("@#{key}")
+      call_after_configuration_change
     end
 
     def method_missing(method, *args, &block)
@@ -28,7 +33,7 @@ module GemConfig
       when (match = method.to_s.match(/\A(?<key>\w+)=\z/)) && self.rules.keys.include?(match[:key].to_sym)
         set match[:key], args.first
       else
-        super method, *args, block
+        super
       end
     end
 
@@ -37,6 +42,7 @@ module GemConfig
     def set(key, value)
       self.rules.check(key, value)
       instance_variable_set "@#{key}", value
+      call_after_configuration_change
     end
 
     def get(key)
@@ -46,5 +52,12 @@ module GemConfig
         self.rules[key.to_sym][:default]
       end
     end
+
+    def call_after_configuration_change
+      unless @parent.nil?
+        after_configuration_change = @parent.instance_variable_get(:@after_configuration_change)
+        after_configuration_change.call unless after_configuration_change.nil?
+      end
+    end
   end
 end

data/lib/gem_config/version.rb

@@ -1,3 +1,3 @@
 module GemConfig
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/spec/gem_config/base_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe GemConfig::Base do
+  it 'provides a class method `with_configuration` when included' do
+    m = Module.new do
+      include GemConfig::Base
+    end
+
+    expect(m).to respond_to(:with_configuration)
+  end
+
+  it 'provides a class method `after_configuration_change` when included' do
+    m = Module.new do
+      include GemConfig::Base
+    end
+
+    expect(m).to respond_to(:after_configuration_change)
+  end
+end

data/spec/gem_config/configuration_spec.rb

@@ -0,0 +1,168 @@
+require 'spec_helper'
+
+AfterConfigurationChangeReceived = Class.new(StandardError)
+
+describe GemConfig::Configuration do
+  let(:parent) {
+    Module.new do
+      include GemConfig::Base
+    end
+  }
+  subject do
+    GemConfig::Configuration.new(parent).tap do |configuration|
+      configuration.rules.has :all_allowed
+      configuration.rules.has :foo_bar_allowed, values: %w(foo bar)
+      configuration.rules.has :string_allowed, classes: String
+      configuration.rules.has :foo, default: 'bar'
+      configuration.rules.has :bar
+      configuration.rules.has :count
+      configuration.rules.has :api_key, default: 'foobarbaz'
+
+      configuration.foo   = 'pelle'
+      configuration.count = 123
+
+      configuration
+    end
+  end
+
+  def set_after_configuration_change_received
+    parent.class_eval do
+      after_configuration_change do
+        raise AfterConfigurationChangeReceived
+      end
+    end
+  end
+
+  describe '#rules' do
+    it 'returns a Rules object' do
+      subject.rules.is_a?(GemConfig::Rules)
+    end
+  end
+
+  describe '#current' do
+    it 'returns the current configuration' do
+      expect(subject.current).to eq(
+        all_allowed:     nil,
+        foo_bar_allowed: nil,
+        string_allowed:  nil,
+        foo:             'pelle',
+        bar:             nil,
+        count:           123,
+        api_key:         'foobarbaz'
+      )
+    end
+  end
+
+  describe '#reset' do
+    it 'resets the configuration' do
+      expect { subject.reset }.to change { [subject.foo, subject.count] }.from(['pelle', 123]).to(['bar', nil])
+    end
+  end
+
+  describe '#unset' do
+    context 'with an existing key' do
+      context 'when that key has not been set' do
+        it 'doesnt change anything' do
+          expect { subject.unset(:bar) }.to_not change { subject.bar }
+        end
+      end
+
+      context 'when that key has been set' do
+        it 'unsets the key' do
+          expect { subject.unset(:count) }.to change { subject.count }.from(123).to(nil)
+        end
+      end
+    end
+
+    context 'with a non-existing key' do
+      it 'raises an exception' do
+        expect { subject.unset(:pelle) }.to raise_error(GemConfig::InvalidKeyError)
+      end
+    end
+
+    context 'when a after_configuration_change block is present' do
+      before do
+        set_after_configuration_change_received
+      end
+
+      it 'calls that block after setting a new value' do
+        expect { subject.unset :count }.to raise_error(AfterConfigurationChangeReceived)
+      end
+    end
+  end
+
+  describe 'setting a configuration option' do
+    context 'when all values and classes are allowed' do
+      it 'sets the configuration option' do
+        expect { subject.all_allowed = 'foo' }.to change { subject.all_allowed }.from(nil).to('foo')
+        expect { subject.all_allowed = 'bar' }.to change { subject.all_allowed }.from('foo').to('bar')
+      end
+    end
+
+    context 'when only certain values are allowed' do
+      it 'sets the configuration option to those values' do
+        expect { subject.foo_bar_allowed = 'foo' }.to change { subject.foo_bar_allowed }.from(nil).to('foo')
+        expect { subject.foo_bar_allowed = 'bar' }.to change { subject.foo_bar_allowed }.from('foo').to('bar')
+      end
+
+      it 'raises an error when for other values' do
+        expect { subject.foo_bar_allowed = 'pelle' }.to raise_error(GemConfig::InvalidKeyError)
+      end
+
+      it "doesn't set the configuration option for other values" do
+        expect do
+          begin
+            subject.foo_bar_allowed = 'pelle'
+          rescue GemConfig::InvalidKeyError
+          end
+        end.to_not change { subject.foo_bar_allowed }
+      end
+    end
+
+    context 'when only certain classes are allowed' do
+      it 'sets the configuration option to those classes' do
+        expect { subject.string_allowed = 'foo' }.to change { subject.string_allowed }.from(nil).to('foo')
+        expect { subject.string_allowed = 'bar' }.to change { subject.string_allowed }.from('foo').to('bar')
+      end
+
+      it 'raises an error when for other values' do
+        expect { subject.string_allowed = 1 }.to raise_error(GemConfig::InvalidKeyError)
+      end
+
+      it "doesn't set the configuration option for other values" do
+        expect do
+          begin
+            subject.string_allowed = 1
+          rescue GemConfig::InvalidKeyError
+          end
+        end.to_not change { subject.string_allowed }
+      end
+    end
+
+    context 'when a after_configuration_change block is present' do
+      before do
+        set_after_configuration_change_received
+      end
+
+      it 'calls that block after setting a new value' do
+        expect { subject.all_allowed = 'foo' }.to raise_error(AfterConfigurationChangeReceived)
+      end
+    end
+  end
+
+  describe 'getting a configuration option' do
+    it 'returns the value if it is set' do
+      subject.foo = 'bar'
+      expect(subject.foo).to eq('bar')
+    end
+
+    it 'also accepts nil as a value' do
+      subject.foo = nil
+      expect(subject.foo).to be_nil
+    end
+
+    it 'returns the default if no value but a default is set' do
+      expect(subject.api_key).to eq('foobarbaz')
+    end
+  end
+end

data/spec/{lib → gem_config}/rules_spec.rb

@@ -6,27 +6,27 @@ describe GemConfig::Rules do
   describe '#has' do
     it 'sets a rule' do
       subject.has :foo
-      subject.should have_key(:foo)
+      expect(subject).to have_key(:foo)
     end
 
     it 'sets the parameters of a rule' do
       params = { classes: String, values: %w(foo bar), default: 'foo' }
       subject.has :foo, params
-      subject[:foo].should eq(params)
+      expect(subject[:foo]).to eq(params)
     end
 
     it 'only allows certain parameters' do
       expect do
         subject.has :foo, classes: String
-      end.to_not raise_error(ArgumentError)
+      end.to_not raise_error
 
       expect do
         subject.has :foo, values: 'bar'
-      end.to_not raise_error(ArgumentError)
+      end.to_not raise_error
 
       expect do
         subject.has :foo, default: 'bar'
-      end.to_not raise_error(ArgumentError)
+      end.to_not raise_error
 
       expect do
         subject.has :foo, foo: 'bar'
@@ -44,11 +44,11 @@ describe GemConfig::Rules do
         it 'only allows a class or an array of classes as the value' do
           expect do
             subject.has :foo, classes: String
-          end.to_not raise_error(ArgumentError)
+          end.to_not raise_error
 
           expect do
             subject.has :foo, classes: [String, Numeric]
-          end.to_not raise_error(ArgumentError)
+          end.to_not raise_error
 
           expect do
             subject.has :foo, classes: 'foo'
@@ -61,15 +61,15 @@ describe GemConfig::Rules do
           it 'only allows values of one of the specified classes' do
             expect do
               subject.has :foo, classes: String, values: 'foo'
-            end.to_not raise_error(ArgumentError)
+            end.to_not raise_error
 
             expect do
               subject.has :foo, classes: Numeric, values: 1
-            end.to_not raise_error(ArgumentError)
+            end.to_not raise_error
 
             expect do
               subject.has :foo, classes: [String, Numeric], values: ['foo', 1]
-            end.to_not raise_error(ArgumentError)
+            end.to_not raise_error
 
             expect do
               subject.has :foo, classes: String, values: ['foo', 1]
@@ -83,15 +83,15 @@ describe GemConfig::Rules do
           it 'only allows a value of one of the specified classes' do
             expect do
               subject.has :foo, classes: String, default: 'foo'
-            end.to_not raise_error(ArgumentError)
+            end.to_not raise_error
 
             expect do
               subject.has :foo, classes: Numeric, default: 1
-            end.to_not raise_error(ArgumentError)
+            end.to_not raise_error
 
             expect do
               subject.has :foo, classes: [String, Numeric], default: 'foo'
-            end.to_not raise_error(ArgumentError)
+            end.to_not raise_error
 
             expect do
               subject.has :foo, classes: Numeric, default: 'foo'
@@ -103,11 +103,11 @@ describe GemConfig::Rules do
           it 'only allows one of the specified values' do
             expect do
               subject.has :foo, values: 'foo', default: 'foo'
-            end.to_not raise_error(ArgumentError)
+            end.to_not raise_error
 
             expect do
               subject.has :foo, values: ['foo', 1], default: 1
-            end.to_not raise_error(ArgumentError)
+            end.to_not raise_error
 
             expect do
               subject.has :foo, values: ['foo', 1], default: 'bar'
@@ -143,14 +143,14 @@ describe GemConfig::Rules do
       subject.has :foo, classes: [String, Numeric]
       expect do
         subject.check :foo, 1
-      end.to_not raise_error(GemConfig::InvalidKeyError)
+      end.to_not raise_error
     end
 
     it 'does not raise an error if :values are defined the the value is included in them' do
       subject.has :foo, values: ['foo', 'bar']
       expect do
         subject.check :foo, 'foo'
-      end.to_not raise_error(GemConfig::InvalidKeyError)
+      end.to_not raise_error
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,13 +1,7 @@
 require 'gem_config'
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
   config.order = 'random'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem_config
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Manuel Meurer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-14 00:00:00.000000000 Z
+date: 2014-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 3.0.0.beta2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 3.0.0.beta2
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
 description: A nifty way to make your gem configurable.
 email: manuel@krautcomputing.com
 executables: []
@@ -46,6 +60,7 @@ extra_rdoc_files: []
 files:
 - .travis.yml
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -55,10 +70,9 @@ files:
 - lib/gem_config/configuration.rb
 - lib/gem_config/rules.rb
 - lib/gem_config/version.rb
-- spec/features/configuration_spec.rb
-- spec/lib/base_spec.rb
-- spec/lib/configuration_spec.rb
-- spec/lib/rules_spec.rb
+- spec/gem_config/base_spec.rb
+- spec/gem_config/configuration_spec.rb
+- spec/gem_config/rules_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/krautcomputing/gem_config
 licenses:
@@ -80,14 +94,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A nifty way to make your gem configurable.
 test_files:
-- spec/features/configuration_spec.rb
-- spec/lib/base_spec.rb
-- spec/lib/configuration_spec.rb
-- spec/lib/rules_spec.rb
+- spec/gem_config/base_spec.rb
+- spec/gem_config/configuration_spec.rb
+- spec/gem_config/rules_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/spec/features/configuration_spec.rb

@@ -1,27 +0,0 @@
-require 'spec_helper'
-
-describe 'a module with configuration rules' do
-  subject do
-    Module.new do
-      include GemConfig::Base
-
-      with_configuration do
-        has :foo, classes: String
-        has :bar, classes: Numeric, default: 1
-        has :baz, values: %w(lorem ipsum dolor), default: 'lorem'
-      end
-    end
-  end
-
-  it 'can be configured' do
-    expect do
-      subject.configure do |config|
-        config.foo = 'bar'
-        config.baz = 'ipsum'
-      end
-    end.to_not raise_error
-
-    subject.configuration.foo.should eq('bar')
-    subject.configuration.baz.should eq('ipsum')
-  end
-end

data/spec/lib/base_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-
-describe GemConfig::Base do
-  it 'provides a class method `with_configuration` when included' do
-    m = Module.new do
-      include GemConfig::Base
-    end
-
-    m.should respond_to(:with_configuration)
-  end
-end

data/spec/lib/configuration_spec.rb

@@ -1,95 +0,0 @@
-require 'spec_helper'
-
-describe GemConfig::Configuration do
-  subject do
-    GemConfig::Configuration.new.tap do |configuration|
-      configuration.rules.has :foo, default: 'bar'
-      configuration.rules.has :bar
-      configuration.rules.has :count
-      configuration.rules.has :api_key, default: 'foobarbaz'
-      configuration.foo   = 'pelle'
-      configuration.count = 123
-      configuration
-    end
-  end
-
-  describe '#rules' do
-    it 'returns a Rules object' do
-      subject.rules.is_a?(GemConfig::Rules)
-    end
-  end
-
-  describe '#current' do
-    it 'returns the current configuration' do
-      subject.current.should eq(foo: 'pelle', count: 123, api_key: 'foobarbaz')
-    end
-  end
-
-  describe '#reset' do
-    it 'resets the configuration' do
-      subject.tap(&:reset).current.should eq(foo: 'bar', count: nil, api_key: 'foobarbaz')
-    end
-  end
-
-  describe '#unset' do
-    context 'with an existing key' do
-      context 'when that key has not been set' do
-        it 'doesnt change anything' do
-          expect { subject.unset(:bar) }.to_not change { subject.bar }
-        end
-      end
-
-      context 'when that key has been set' do
-        it 'unsets the key' do
-          expect { subject.unset(:count) }.to change { subject.count }.from(123).to(nil)
-        end
-      end
-    end
-
-    context 'with a non-existing key' do
-      it 'raises an exception' do
-        expect { subject.unset(:pelle) }.to raise_error(GemConfig::InvalidKeyError)
-      end
-    end
-  end
-
-  describe 'setting a configuration option' do
-    it 'checks if the value is allowed' do
-      subject.rules.should_receive :check, with: [:foo, 'bar']
-      subject.foo = 'bar'
-    end
-
-    it 'sets the configuration option if the value is allowed' do
-      subject.rules.stub(:check, with: [:foo, 'bar'])
-      expect do
-        subject.foo = 'bar'
-      end.to change { subject.foo }.from('pelle').to('bar')
-    end
-
-    it 'does not set the configuration option if the value is not allowed' do
-      subject.rules.stub(:check, with: [:foo, 'bar']).and_raise(GemConfig::InvalidKeyError)
-      expect do
-        begin
-          subject.foo = 'bar'
-        rescue GemConfig::InvalidKeyError
-        end
-      end.to_not change { subject.foo }.from('bar')
-    end
-  end
-
-  describe 'getting a configuration option' do
-    it 'returns the value if it is set' do
-      subject.foo = 'bar'
-      subject.foo.should eq('bar')
-    end
-
-    it 'also accepts nil as a value' do
-      subject.foo = nil
-      subject.foo.should be_nil
-    end
-
-    it 'returns the default if no value but a default is set' do
-      subject.api_key.should eq('foobarbaz')
-    end
-  end
-end