gem_config 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c0001fb2a37e49f309f7c050560a2ca0b809cba
-  data.tar.gz: 23ec574b1a07a169eed85427076150eae6fdf62b
+  metadata.gz: 0e1e002c0aa0ae05fd05fd299a13669fb1a3c860
+  data.tar.gz: ee74c15d5b3f9103863532ee46219bafcfe3f4b9
 SHA512:
-  metadata.gz: 1dc0f00e99dbf3d5592024f904dd2a22c65a808b21e4c34357c0f86e0d254027f2612d5cf43547fa941872f70398bf81d2e7c3198effab1e721ea1fce4593670
-  data.tar.gz: 1e7485ca57cf804347732159e6563457a51600548c612b27efa1ef8d3b1da20bb3d1cec817810bad204a4fcfdac1fea0bb32ba186793c6053057dc433753ecc9
+  metadata.gz: 8b727372b3882e136e0015f86d68ffd90e641cac46dc694245ddc77cca4de314c5f44da11488412c16d4257729843a7fa5217ef1948f32c8cbf7471e457b9233
+  data.tar.gz: 165e49cc5088dcd039df12d34472506a04481cb29e6639415bc984ad2f95bc57551f41212cc1da07da365da742df44e9d9296f972cc8c991e0b96a50ba083032

data/README.md

@@ -23,7 +23,54 @@ Or install it yourself as:
 
 ## Usage
 
-## TODO
+### As a gem author
+
+Include the gem and add configuration options like this:
+
+```ruby
+# awesomeness.gemspec
+Gem::Specification.new do |gem|
+  ...
+  gem.add_runtime_dependency 'gem_config'
+end
+
+# lib/awesomeness.rb
+module Awesomeness
+  include GemConfig::Base
+
+  with_configuration do
+    has :api_key, classes: String
+    has :format, values: [:json, :xml], default: :json
+    has :region, values: ['us-west', 'us-east', 'eu'], default: 'us-west'
+  end
+end
+```
+
+Access the configuration values in the gem's code like this:
+
+```ruby
+Awesomeness.configuration.api_key # Whatever the user set
+```
+
+### As a gem user
+
+Include and configure a gem like this:
+
+```ruby
+# Gemfile
+gem 'awesomeness'
+
+# config/initializers/awesomeness.rb
+Awesomeness.configure do |config|
+  config.api_key = 'foobarbaz'
+  config.format  = :xml
+  config.region  = 'eu'
+end
+# or
+Awesomeness.configuration.api_key = 'foobarbaz'
+```
+
+Of course configuration values are checked against the allowed `classes` and `values`, and the `default` is used if no value is provided.
 
 ## Contributing
 

data/lib/gem_config/configuration.rb

@@ -12,7 +12,7 @@ module GemConfig
 
     def reset
       self.rules.keys.each do |key|
-        set key, nil
+        unset key
       end
     end
 
@@ -29,12 +29,21 @@ module GemConfig
 
     private
 
+    def unset(key)
+      remove_instance_variable "@#{key}" if instance_variable_defined?("@#{key}")
+    end
+
     def set(key, value)
-      self.instance_variable_set "@#{key}", value
+      self.rules.check(key, value)
+      instance_variable_set "@#{key}", value
     end
 
     def get(key)
-      self.instance_variable_get("@#{key}") || self.rules[key.to_sym][:default]
+      if instance_variable_defined?("@#{key}")
+        instance_variable_get "@#{key}"
+      else
+        self.rules[key.to_sym][:default]
+      end
     end
   end
 end

data/lib/gem_config/rules.rb

@@ -2,11 +2,25 @@ require 'active_support/core_ext/hash/keys'
 
 module GemConfig
   class Rules < Hash
+    InvalidKeyError = Class.new(StandardError)
+
     def has(key, attrs = {})
       check_attributes attrs
       self[key.to_sym] = attrs
     end
 
+    def check(key, value)
+      error_message = case
+      when !self.has_key?(key.to_sym)
+        'no rule found'
+      when self[key.to_sym].has_key?(:classes) && Array(self[key.to_sym][:classes]).none? { |klass| value.is_a?(klass) }
+        "must be an instance of one of the following classes: #{Array(self[key.to_sym][:classes]).join(', ')}"
+      when self[key.to_sym].has_key?(:values) && !Array(self[key.to_sym][:values]).include?(value)
+        "must be one of the following values: #{Array(self[key.to_sym][:values]).join(', ')}"
+      end
+      raise InvalidKeyError, "#{value} is not a valid value for #{key}: #{error_message}" unless error_message.nil?
+    end
+
     private
 
     def check_attributes(attrs)

data/lib/gem_config/version.rb

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

data/spec/lib/configuration_spec.rb

@@ -3,9 +3,10 @@ require 'spec_helper'
 describe GemConfig::Configuration do
   subject do
     GemConfig::Configuration.new.tap do |configuration|
-      configuration.rules.has :foo
+      configuration.rules.has :foo, default: 'bar'
       configuration.rules.has :count
-      configuration.foo   = 'bar'
+      configuration.rules.has :api_key, default: 'foobarbaz'
+      configuration.foo   = 'pelle'
       configuration.count = 123
       configuration
     end
@@ -19,13 +20,53 @@ describe GemConfig::Configuration do
 
   describe '#current' do
     it 'returns the current configuration' do
-      subject.current.should eq(foo: 'bar', count: 123)
+      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: nil, count: nil)
+      subject.tap(&:reset).current.should eq(foo: 'bar', count: nil, api_key: 'foobarbaz')
+    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::Rules::InvalidKeyError)
+      expect do
+        begin
+          subject.foo = 'bar'
+        rescue GemConfig::Rules::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

data/spec/lib/rules_spec.rb

@@ -109,4 +109,40 @@ describe GemConfig::Rules do
       end
     end
   end
+
+  describe '#check' do
+    it "raises an error if the value is not set as a rule" do
+      expect do
+        subject.check :foo, 1
+      end.to raise_error(GemConfig::Rules::InvalidKeyError)
+    end
+
+    it "raises an error if :classes are defined the the value's class is not included in them" do
+      subject.has :foo, classes: String
+      expect do
+        subject.check :foo, 1
+      end.to raise_error(GemConfig::Rules::InvalidKeyError)
+    end
+
+    it 'raises an error if :values are defined the the value is not included in them' do
+      subject.has :foo, values: ['foo', 'bar']
+      expect do
+        subject.check :foo, 'baz'
+      end.to raise_error(GemConfig::Rules::InvalidKeyError)
+    end
+
+    it "does not raise an error if :classes are defined the the value's class is included in them" do
+      subject.has :foo, classes: [String, Numeric]
+      expect do
+        subject.check :foo, 1
+      end.to_not raise_error(GemConfig::Rules::InvalidKeyError)
+    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::Rules::InvalidKeyError)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem_config
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Manuel Meurer