confiture 0.0.1 → 0.1.0

data/.travis.yml

@@ -1,10 +1,5 @@
 script: "bundle exec rake"
 rvm:
-  - 1.8.7
   - 1.9.2
   - 1.9.3
-  - rbx
-  - rbx-2.0
-  - ree
   - ruby-head
-  - jruby

data/Gemfile.lock

@@ -6,7 +6,13 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
+    coderay (1.0.6)
     diff-lcs (1.1.3)
+    method_source (0.7.1)
+    pry (0.9.9.6)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
     rake (0.9.2.2)
     rspec (2.7.0)
       rspec-core (~> 2.7.0)
@@ -16,6 +22,7 @@ GEM
     rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.7.0)
+    slop (2.4.4)
 
 PLATFORMS
   java
@@ -23,5 +30,6 @@ PLATFORMS
 
 DEPENDENCIES
   confiture!
-  rake (~> 0.9.2.2)
-  rspec (~> 2.7.0)
+  pry (~> 0.9.9)
+  rake (~> 0.9.2)
+  rspec (~> 2.7)

data/README.md

@@ -0,0 +1,49 @@
+## Infos
+
+![Status](http://stillmaintained.com/phoet/confiture.png "Status")
+![Build](http://travis-ci.org/phoet/confiture.png "Build")
+
+## Installation
+
+    gem install confiture
+
+or in your Gemfile:
+
+    gem "confiture"
+
+## Usage
+
+In order to use confiture, just include it into a configuration klass:
+
+    module Your
+      class Configuration
+        include Confiture::Configuration
+        
+        confiture_allowed_keys(:secret, :key)
+        confiture_defaults(secret: 'SECRET_STUFF', key: 'EVEN_MOAR_SECRET')
+      end
+    end
+
+Rails style initializer (config/initializers/asin.rb):
+
+    Your::Configuration.configure do |config|
+      config.secret = 'your-secret'
+      config.key    = 'your-key'
+    end
+
+YAML style configuration:
+
+    Your::Configuration.configure :yaml => 'config/some.yml'
+
+Inline style configuration:
+
+    Your::Configuration.configure :secret => 'your-secret', :key => 'your-key'
+    # or
+    client.configure :secret => 'your-secret', :key => 'your-key'
+
+## License
+
+"THE BEER-WARE LICENSE" (Revision 42):
+ps@nofail.de[mailto:ps@nofail.de] wrote this file. As long as you retain this notice you
+can do whatever you want with this stuff. If we meet some day, and you think
+this stuff is worth it, you can buy me a beer in return Peter Schröder

data/confiture.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency('rake',       '~> 0.9.2.2')
-  s.add_development_dependency('rspec',      '~> 2.7.0')
+  s.add_development_dependency('rake',  '~> 0.9.2')
+  s.add_development_dependency('rspec', '~> 2.7')
+  s.add_development_dependency('pry',   '~> 0.9.9')
 end

data/lib/confiture/configuration.rb

@@ -1,49 +1,45 @@
 require "yaml"
-require 'logger'
 
 module Confiture
-  class Configuration
-    class << self
+  module Configuration
+    def self.included(base)
+      base.extend ClassExtension
+    end
 
-      attr_accessor :secret, :key
+    module ClassExtension
+      def confiture_defaults(defaults)
+        @defaults = defaults
+      end
 
-      # Rails initializer configuration.
-      #
-      # Expects at least +secret+ and +key+ for the API call:
+      def confiture_allowed_keys(*allowed_keys)
+        @allowed_keys = allowed_keys
+      end
+
+      # Rails initializer configuration:
       #
-      #   ASIN::Configuration.configure do |config|
+      #   Confiture::Configuration.configure do |config|
       #     config.secret = 'your-secret'
       #     config.key    = 'your-key'
       #   end
       #
-      # With the latest version of the Product Advertising API you need to include your associate_tag[https://affiliate-program.amazon.com/gp/advertising/api/detail/api-changes.html].
-      #
       # You may pass options as a hash as well:
       #
-      #   ASIN::Configuration.configure :secret => 'your-secret', :key => 'your-key'
+      #   Confiture::Configuration.configure :secret => 'your-secret', :key => 'your-key'
       #
       # Or configure everything using YAML:
       #
-      #   ASIN::Configuration.configure :yaml => 'config/asin.yml'
+      #   Confiture::Configuration.configure :yaml => 'config/asin.yml'
       #
-      #   ASIN::Configuration.configure :yaml => 'config/asin.yml' do |config, yml|
-      #     config.key = yml[Rails.env]['aws_access_key']
+      #   Confiture::Configuration.configure :yaml => 'config/asin.yml' do |config, yml|
+      #     config.key = yml[Rails.env]['key']
       #   end
       #
       # ==== Options:
       #
-      # [secret] the API secret key (required)
-      # [key] the API access key (required)
-      # [associate_tag] your Amazon associate tag. Default is blank (required in latest API version)
-      # [host] the host, which defaults to 'webservices.amazon.com'
-      # [logger] a different logger than logging to STDERR (nil for no logging)
-      # [version] a custom version of the API calls. Default is 2010-11-01
-      # [item_type] a different class for SimpleItem, use :mash / :rash for Hashie::Mash / Hashie::Rash or :raw for a plain hash
-      # [cart_type] a different class for SimpleCart, use :mash / :rash for Hashie::Mash / Hashie::Rash or :raw for a plain hash
-      # [node_type] a different class for SimpleNode, use :mash / :rash for Hashie::Mash / Hashie::Rash or :raw for a plain hash
+      # [yaml|yml] path to a yaml file with configuration
       #
-      def configure(options={})
-        init_config
+      def configure(options={},reset=false)
+        init_config(reset)
         if yml_path = options[:yaml] || options[:yml]
           yml = File.open(yml_path) { |file| YAML.load(file) }
           if block_given?
@@ -63,26 +59,52 @@ module Confiture
         self
       end
 
+      def with_config(options={})
+        current_data = data
+        configure(options, true)
+      ensure
+        self.data = current_data
+      end
+
       # Resets configuration to defaults
       #
-      def reset
+      def reset!
         init_config(true)
       end
 
-      # Check if a key is set
-      #
-      def blank?(key)
-        val = self.send :key
-        val.nil? || val.empty?
+      private
+
+      def data
+        Thread.current[:confiture]
       end
 
-      private
+      def data=(data)
+        Thread.current[:confiture] = data
+      end
 
       def init_config(force=false)
         return if @init && !force
-        @init          = true
-        @secret        = ''
-        @key           = ''
+        @init = true
+        self.data = Data.new(@defaults)
+      end
+
+      def method_missing(meth, *args)
+        meth = "#{meth}"
+        if meth =~ /.+=/ && args.size == 1
+          key = meth[0..-2].to_sym
+          check_key!(key)
+          data.options[key] = args.last
+        elsif args.size == 0
+          key = meth.to_sym
+          check_key!(key)
+          data.options[key]
+        else
+          super
+        end
+      end
+
+      def check_key!(key)
+        raise ArgumentError.new("#{key} is not allowed, use one of #{@allowed_keys}") if @allowed_keys && !@allowed_keys.include?(key)
       end
     end
   end

data/lib/confiture/data.rb

@@ -0,0 +1,10 @@
+module Confiture
+  class Data
+    attr_accessor :options
+
+    def initialize(defaults)
+      @options = defaults.dup if defaults
+      @options ||= {}
+    end
+  end
+end

data/lib/confiture/version.rb

@@ -1,3 +1,3 @@
 module Confiture
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/confiture.rb

@@ -1,4 +1,5 @@
 module Confiture
   require 'confiture/version'
+  require 'confiture/data'
   require 'confiture/configuration'
 end

data/spec/configuration_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+module Confiture
+  class Config
+    include Confiture::Configuration
+  end
+
+  class Allowed
+    include Confiture::Configuration
+    confiture_allowed_keys(:key)
+  end
+
+  class Default
+    include Confiture::Configuration
+    confiture_defaults(:key => 'value')
+  end
+
+  describe Confiture do
+    context "defaults" do
+      it "should have default settings" do
+        Default.configure.key.should eql('value')
+      end
+
+      it "should restore defaults" do
+        Default.configure.key.should eql('value')
+        Default.configure(:key => 'bla').key.should eql('bla')
+        Default.reset!
+        Default.configure.key.should eql('value')
+      end
+    end
+    context "allowed_keys" do
+      it "should have access to allowed fields" do
+        Allowed.configure do |config|
+          config.key = 'bla'
+        end.key.should eql('bla')
+      end
+
+      it "should raise an error for not allowed keys" do
+        expect do
+          Allowed.configure do |config|
+            config.not_allowed_key = 'bla'
+          end
+        end.should raise_error(ArgumentError, "not_allowed_key is not allowed, use one of [:key]")
+      end
+
+      it "should access any field if not restricted" do
+        Config.configure do |config|
+          config.not_allowed_key = 'bla'
+        end.not_allowed_key.should eql('bla')
+      end
+    end
+
+    context "configuration" do
+      it "should work with a configuration block" do
+        Config.configure do |config|
+          config.key = 'bla'
+        end.key.should eql('bla')
+      end
+
+      it "should read configuration from yml" do
+        config = Config.configure :yaml => 'spec/config.yml'
+        config.secret.should eql('secret_yml')
+        config.key.should eql('key_yml')
+      end
+
+      it "should read configuration from yml with block" do
+        conf = Config.configure :yaml => 'spec/config.yml' do |config, yml|
+          config.secret = nil
+          config.key = yml['secret']
+        end
+        conf.secret.should be_nil
+        conf.key.should eql('secret_yml')
+      end
+    end
+
+    context "with_config" do
+      it "should have a config on a per block basis" do
+        config = Config.configure(:key => "value")
+        config.with_config(:key => "bla") do
+          Config.key.should eql("bla")
+        end
+        Config.key.should eql("value")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,7 +2,7 @@ $:.unshift File.join(File.dirname(__FILE__),'..','..','lib')
 
 require 'rspec'
 require 'confiture'
-require 'pp'
+require 'pry'
 
 RSpec.configure do |config|
   config.mock_with :rspec

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: confiture
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,30 +9,41 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-11 00:00:00.000000000 Z
+date: 2012-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70363265328940 !ruby/object:Gem::Requirement
+  requirement: &70276619699480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.2.2
+        version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70363265328940
+  version_requirements: *70276619699480
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70363265328440 !ruby/object:Gem::Requirement
+  requirement: &70276619698980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: '2.7'
   type: :development
   prerelease: false
-  version_requirements: *70363265328440
+  version_requirements: *70276619698980
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70276619698520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :development
+  prerelease: false
+  version_requirements: *70276619698520
 description: Confiture helps with configuring your gem.
 email:
 - phoetmail@googlemail.com
@@ -47,14 +58,15 @@ files:
 - CHANGELOG.rdoc
 - Gemfile
 - Gemfile.lock
-- README.rdoc
+- README.md
 - confiture.gemspec
 - lib/confiture.rb
 - lib/confiture/configuration.rb
+- lib/confiture/data.rb
 - lib/confiture/version.rb
 - rakefile.rb
 - spec/config.yml
-- spec/config_spec.rb
+- spec/configuration_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/phoet/confiture
 licenses: []
@@ -82,5 +94,5 @@ specification_version: 3
 summary: Confiture helps with configuring your gem.
 test_files:
 - spec/config.yml
-- spec/config_spec.rb
+- spec/configuration_spec.rb
 - spec/spec_helper.rb

data/README.rdoc

@@ -1,51 +0,0 @@
-== Infos
-
-Status: http://stillmaintained.com/phoet/asin.png
-Build: http://travis-ci.org/phoet/asin.png
-
-
-== Installation
-
-  gem install confiture
-
-or in your Gemfile:
-
-  gem "confiture"
-
-== Usage
-
-Rails style initializer (config/initializers/asin.rb):
-
-  ASIN::Configuration.configure do |config|
-    config.secret = 'your-secret'
-    config.key    = 'your-key'
-  end
-
-YAML style configuration:
-
-  ASIN::Configuration.configure :yaml => 'config/asin.yml'
-
-Inline style configuration:
-
-  ASIN::Configuration.configure :secret => 'your-secret', :key => 'your-key'
-  # or
-  client.configure :secret => 'your-secret', :key => 'your-key'
-
-Have a look at ASIN::Configuration class for all the details.
-
-===API Changes
-
-With the latest version of the Product Advertising API you need to include your associate_tag[https://affiliate-program.amazon.com/gp/advertising/api/detail/api-changes.html].
-
-  ASIN::Configuration.configure do |config|
-    config.secret        = 'your-secret'
-    config.key           = 'your-key'
-    config.associate_tag = 'your-tag'
-  end
-
-== License
-
-"THE BEER-WARE LICENSE" (Revision 42):
-ps@nofail.de[mailto:ps@nofail.de] wrote this file. As long as you retain this notice you
-can do whatever you want with this stuff. If we meet some day, and you think
-this stuff is worth it, you can buy me a beer in return Peter Schröder

data/spec/config_spec.rb

@@ -1,33 +0,0 @@
-require 'spec_helper'
-
-module Confiture
-  describe Confiture do
-    context "configuration" do
-      it "should fail with wrong configuration key" do
-        lambda { @helper.configure :wrong => 'key' }.should raise_error(NoMethodError)
-      end
-
-      it "should work with a configuration block" do
-        conf = Confiture::Configuration.configure do |config|
-          config.key = 'bla'
-        end
-        conf.key.should eql('bla')
-      end
-
-      it "should read configuration from yml" do
-        config = Confiture::Configuration.configure :yaml => 'spec/config.yml'
-        config.secret.should eql('secret_yml')
-        config.key.should eql('key_yml')
-      end
-
-      it "should read configuration from yml with block" do
-        conf = Confiture::Configuration.configure :yaml => 'spec/config.yml' do |config, yml|
-          config.secret = nil
-          config.key = yml['secret']
-        end
-        conf.secret.should be_nil
-        conf.key.should eql('secret_yml')
-      end
-    end
-  end
-end