gem_config 0.0.2 → 0.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YWMxNzQwNzU0OTczZTllMmY3YTYyZjIxMDE2ZWZkYWQ4YzA1MmYwOA==
-  data.tar.gz: !binary |-
-    NDU4YjE0M2Q4MDdkMTBlNTJhMTM3MTUwN2FkYmI2ZjNmNzkyMDQ5Zg==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    ODAxNjg0OGNhN2JkMjgxMDZmNjliNmFkNjY5ZTJiZjMzZDIzYjlhYjgzZmFk
-    YjkxNTYwYTJjZmFhYTkzYzRiYWM0ZDRkMjc0Y2UxMmRhOWNkNzRjNmFmMDYx
-    M2U1MjJhMWU2YzE2NTU5YjA2ZDIxNTcxMzQ1NTA5M2VhODdjM2U=
-  data.tar.gz: !binary |-
-    ZjQ4MjhhMjJjZWVhZThhNjhiMWJhZTg4MTk4ZmJkNDkxNmUyN2EyNGRjMGY5
-    YjZlZjQ0ZTZjYTBjYTViMjAzZWI0NmI3NWQ2MzFmYjY0ZWRjZjc4MDk0NGQ2
-    ODYxYmQ0N2U2YmE4YzE4Y2U0YmY2MmQ1ZWExYmRlMTkxMWUwNGE=
+SHA1:
+  metadata.gz: 9c0001fb2a37e49f309f7c050560a2ca0b809cba
+  data.tar.gz: 23ec574b1a07a169eed85427076150eae6fdf62b
+SHA512:
+  metadata.gz: 1dc0f00e99dbf3d5592024f904dd2a22c65a808b21e4c34357c0f86e0d254027f2612d5cf43547fa941872f70398bf81d2e7c3198effab1e721ea1fce4593670
+  data.tar.gz: 1e7485ca57cf804347732159e6563457a51600548c612b27efa1ef8d3b1da20bb3d1cec817810bad204a4fcfdac1fea0bb32ba186793c6053057dc433753ecc9

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/gem_config.gemspec

@@ -18,4 +18,9 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r(^bin/)).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r(^(test|spec|features)/))
   gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'rake', '>= 0.9.0'
+  gem.add_development_dependency 'rspec', '~> 2.13.0'
+
+  gem.add_runtime_dependency 'activesupport', '~> 3.0'
 end

data/lib/gem_config.rb

@@ -1,6 +1,6 @@
 module GemConfig
 end
 
-require 'gem_config/configuration_rules'
+require 'gem_config/rules'
 require 'gem_config/configuration'
 require 'gem_config/base'

data/lib/gem_config/base.rb

@@ -10,17 +10,11 @@ module GemConfig
       end
 
       def configuration
-        @configuration ||= Configuration.new(configuration_rules)
+        @configuration ||= Configuration.new
       end
 
       def with_configuration(&block)
-        configuration_rules.instance_eval(&block)
-      end
-
-      private
-
-      def configuration_rules
-        @configuration_rules ||= ConfigurationRules.new
+        configuration.rules.instance_eval(&block)
       end
     end
   end

data/lib/gem_config/configuration.rb

@@ -1,30 +1,26 @@
 module GemConfig
   class Configuration
-    def initialize(configuration_rules)
-      @configuration_rules = configuration_rules
-    end
-
     def rules
-      @configuration_rules
+      @rules ||= Rules.new
     end
 
     def current
-      @configuration_rules.keys.each_with_object({}) do |key, hash|
+      self.rules.keys.each_with_object({}) do |key, hash|
         hash[key] = get(key)
       end
     end
 
     def reset
-      @configuration_rules.keys.each do |key|
+      self.rules.keys.each do |key|
         set key, nil
       end
     end
 
     def method_missing(method, *args, &block)
       case
-      when @configuration_rules.keys.include?(method.to_sym)
+      when self.rules.keys.include?(method.to_sym)
         get method
-      when (match = method.to_s.match(/\A(?<key>\w+)=\z/)) && @configuration_rules.keys.include?(match[:key].to_sym)
+      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
@@ -38,7 +34,7 @@ module GemConfig
     end
 
     def get(key)
-      self.instance_variable_get("@#{key}") || @configuration_rules[key.to_sym][:default]
+      self.instance_variable_get("@#{key}") || self.rules[key.to_sym][:default]
     end
   end
 end

data/lib/gem_config/rules.rb

@@ -0,0 +1,46 @@
+require 'active_support/core_ext/hash/keys'
+
+module GemConfig
+  class Rules < Hash
+    def has(key, attrs = {})
+      check_attributes attrs
+      self[key.to_sym] = attrs
+    end
+
+    private
+
+    def check_attributes(attrs)
+      attrs.assert_valid_keys :classes, :values, :default
+
+      if attrs.has_key?(:classes)
+        other_than_class = Array(attrs[:classes]).any? do |value|
+          !value.is_a?(Class)
+        end
+        raise ArgumentError, 'Value of :classes parameter must be a single class or an array of classes.' if other_than_class
+      end
+
+      if attrs.has_key?(:classes) && attrs.has_key?(:values)
+        value_not_in_classes = Array(attrs[:values]).any? do |value|
+          Array(attrs[:classes]).none? do |klass|
+            value.is_a?(klass)
+          end
+        end
+        raise ArgumentError, 'Values of :values parameter must all have the type of one of the defined :classes.' if value_not_in_classes
+      end
+
+      if attrs.has_key?(:default)
+        if attrs.has_key?(:classes)
+          default_not_in_classes = Array(attrs[:classes]).none? do |klass|
+            attrs[:default].is_a?(klass)
+          end
+          raise ArgumentError, 'Value of :default parameter must have the type of one of the defined :classes.' if default_not_in_classes
+        end
+
+        if attrs.has_key?(:values)
+          default_not_in_values = !Array(attrs[:values]).include?(attrs[:default])
+          raise ArgumentError, 'Value of :default parameter must have the type of one of the defined :classes.' if default_not_in_values
+        end
+      end
+    end
+  end
+end

data/lib/gem_config/version.rb

@@ -1,3 +1,3 @@
 module GemConfig
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/spec/features/configuration_spec.rb

@@ -0,0 +1,27 @@
+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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe GemConfig::Configuration do
+  subject do
+    GemConfig::Configuration.new.tap do |configuration|
+      configuration.rules.has :foo
+      configuration.rules.has :count
+      configuration.foo   = 'bar'
+      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: 'bar', count: 123)
+    end
+  end
+
+  describe '#reset' do
+    it 'resets the configuration' do
+      subject.tap(&:reset).current.should eq(foo: nil, count: nil)
+    end
+  end
+end

data/spec/lib/rules_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+
+describe GemConfig::Rules do
+  subject { GemConfig::Rules.new }
+
+  describe '#has' do
+    it 'sets a rule' do
+      subject.has :foo
+      subject.should 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)
+    end
+
+    it 'only allows certain parameters' do
+      expect do
+        subject.has :foo, classes: String
+      end.to_not raise_error(ArgumentError)
+
+      expect do
+        subject.has :foo, values: 'bar'
+      end.to_not raise_error(ArgumentError)
+
+      expect do
+        subject.has :foo, default: 'bar'
+      end.to_not raise_error(ArgumentError)
+
+      expect do
+        subject.has :foo, foo: 'bar'
+      end.to raise_error(ArgumentError)
+    end
+
+    describe 'parameter :classes' 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)
+
+        expect do
+          subject.has :foo, classes: [String, Numeric]
+        end.to_not raise_error(ArgumentError)
+
+        expect do
+          subject.has :foo, classes: 'foo'
+        end.to raise_error(ArgumentError)
+      end
+    end
+
+    describe 'parameter :values' do
+      context 'when :classes are defined' 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)
+
+          expect do
+            subject.has :foo, classes: Numeric, values: 1
+          end.to_not raise_error(ArgumentError)
+
+          expect do
+            subject.has :foo, classes: [String, Numeric], values: ['foo', 1]
+          end.to_not raise_error(ArgumentError)
+
+          expect do
+            subject.has :foo, classes: String, values: ['foo', 1]
+          end.to raise_error(ArgumentError)
+        end
+      end
+    end
+
+    describe 'parameter :default' do
+      context 'when :classes are defined' 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)
+
+          expect do
+            subject.has :foo, classes: Numeric, default: 1
+          end.to_not raise_error(ArgumentError)
+
+          expect do
+            subject.has :foo, classes: [String, Numeric], default: 'foo'
+          end.to_not raise_error(ArgumentError)
+
+          expect do
+            subject.has :foo, classes: Numeric, default: 'foo'
+          end.to raise_error(ArgumentError)
+        end
+      end
+
+      context 'when :values are defined' 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)
+
+          expect do
+            subject.has :foo, values: ['foo', 1], default: 1
+          end.to_not raise_error(ArgumentError)
+
+          expect do
+            subject.has :foo, values: ['foo', 1], default: 'bar'
+          end.to raise_error(ArgumentError)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+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,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: gem_config
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Manuel Meurer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-01 00:00:00.000000000 Z
-dependencies: []
+date: 2013-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: A nifty way to make your gem configurable.
 email: manuel.meurer@gmail.com
 executables: []
@@ -19,12 +61,18 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- Rakefile
 - gem_config.gemspec
 - lib/gem_config.rb
 - lib/gem_config/base.rb
 - lib/gem_config/configuration.rb
-- lib/gem_config/configuration_rules.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/spec_helper.rb
 homepage: https://github.com/krautcomputing/gem_config
 licenses:
 - MIT
@@ -35,18 +83,23 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
 summary: A nifty way to make your gem configurable.
-test_files: []
+test_files:
+- spec/features/configuration_spec.rb
+- spec/lib/base_spec.rb
+- spec/lib/configuration_spec.rb
+- spec/lib/rules_spec.rb
+- spec/spec_helper.rb

data/lib/gem_config/configuration_rules.rb

@@ -1,7 +0,0 @@
-module GemConfig
-  class ConfigurationRules < Hash
-    def has(key, attrs = {})
-      self[key.to_sym] = attrs
-    end
-  end
-end