configarrr 0.1.1

data/README.markdown

@@ -0,0 +1,41 @@
+= configarrr
+
+== Description:
+
+A simple interface for providin' configuration. Not all o' me own creations. Parts borrowed, see Acknowledgements.
+
+== Usage:
+
+    config = Configarrr::Simple.configure do
+      set :key, :value
+      set :hash => { :other_key => :other_value }
+    end
+
+    >> config.key
+    => :value
+    >> config.hash[:other_key]
+    => :other_value
+
+== Acknowledgements:
+
+Sinatra - http://github.com/sinatra/sinatra/blob/master/lib/sinatra/base.rb - borrowed set and metadef.
+
+== License:
+
+(The MIT License)
+
+Copyright (c) 2009 Dylan Egan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the 'Software'), to deal in
+the Software without restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "configarrr"
+    gemspec.summary = "Pirates way of configuring, maties!"
+    gemspec.description = "Actually it's not. It's just a way of handling configuration."
+    gemspec.email = "dylanegan@gmail.com"
+    gemspec.homepage = "http://github.com/abcde/configarrr"
+    gemspec.authors = ["Dylan Egan"]
+    gemspec.files = %w(README.markdown Rakefile VERSION) + Dir.glob("{lib,spec}/**/*")
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/configarrr/base.rb

@@ -0,0 +1,51 @@
+module Configarrr
+  class Base
+    def initialize(options = {})
+      @keys = []
+      parse_options(options)
+    end
+
+    def self.configure(options = {}, &block)
+      config = new(options)
+      config.configure(&block)
+      config
+    end
+
+    def configure(&block)
+      instance_eval(&block)
+    end
+
+    def set(key, value=self)
+      if value.kind_of?(Proc)
+        metadef(key, &value)
+        metadef("#{key}?") { !!__send__(key) }
+        metadef("#{key}=") { |val| set(key, Proc.new{val}) }
+        @keys << key 
+      elsif value == self && key.is_a?(Hash)
+        key.to_hash.each { |k,v| set(k, v) }
+      elsif respond_to?("#{key}=")
+        __send__ "#{key}=", value
+        @keys << key 
+      else
+        set key, Proc.new{value}
+      end
+      self
+    end
+
+    def to_hash
+      @keys.inject({}) do |hash, key|
+        hash[key] = __send__ "#{key}"
+        hash
+      end
+    end
+
+    private
+      def parse_options(options)
+      end
+
+      def metadef(message, &block)
+        (class << self; self; end).
+          send :define_method, message, &block
+      end
+  end
+end

data/lib/configarrr/simple.rb

@@ -0,0 +1,4 @@
+module Configarrr
+  class Simple < Base
+  end
+end

data/lib/configarrr/yaml.rb

@@ -0,0 +1,46 @@
+require 'yaml'
+
+module Configarrr
+  class YAML < Base
+    def initialize(options = {})
+      raise ArgumentError, "Please provide a YAML file location." unless options[:file]
+      super(options)
+      ensure_file_exists
+      @yaml = ::YAML.load_file(@file) || {}
+      set_yaml
+    end
+
+    def defaults
+      {}
+    end
+
+    def set_yaml
+      if @parent
+        @yaml.has_key?(@parent) ? set(defaults.merge(@yaml[@parent])) : raise(Configarrr::OptionError, "Please provide a valid parent value. #{@parent} does not exist.")
+      else
+        set defaults.merge(@yaml)
+      end
+    end
+
+    def save
+      ::File.open(@file, "w") { |file| file << self.to_hash.to_yaml }
+    end
+
+    def to_hash
+      @parent ? @yaml.merge({@parent => super}) : super
+    end
+
+    private
+      def parse_options(options)
+        @file = File.expand_path(options.delete(:file))
+        @parent = options.delete(:parent)
+        super
+      end
+
+      def ensure_file_exists
+        unless ::File.exists?(@file)
+          ::File.open(@file, "w") { |file| file << {}.to_yaml }
+        end
+      end
+  end
+end

data/lib/configarrr.rb

@@ -0,0 +1,7 @@
+$:.unshift File.dirname(__FILE__)
+
+module Configarrr
+  class OptionError < StandardError; end
+end
+
+%w( base simple yaml ).each { |lib| require "configarrr/#{lib}" }

data/spec/configarrr/base_spec.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+class MyConfig < Configarrr::Base
+  attr_accessor :my_option
+end
+
+describe Configarrr::Base do
+  before do
+    @config = Configarrr::Base.new
+  end
+
+  context "when inherited" do
+    before do
+      @my_config = MyConfig.configure do
+        set :my_option, :my_value
+      end
+    end
+
+    it "should work with defined attributes in child class" do
+      @my_config.my_option.should == :my_value
+    end
+
+    it "should track defined attributes in child class" do
+      @my_config.to_hash.keys.should include(:my_option)
+    end
+  end
+
+  it_should_behave_like "a Configarrr implementation"
+end

data/spec/configarrr/yaml_spec.rb

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+class YAMLWithDefaults < Configarrr::YAML
+  def defaults
+    { 'first_key' => 1234, 'third_key' => 1234 }
+  end
+end
+
+describe Configarrr::YAML do
+  before do
+    @config = Configarrr::YAML.new(:file => SPEC_DIR + '/fixtures/config.yml')
+  end
+
+  context "initialising" do
+    it "raises without a file being provided" do
+      lambda { Configarrr::YAML.new }.should raise_error(ArgumentError, "Please provide a YAML file location.")
+    end
+
+    it "creates the file if necessary" do
+      file = SPEC_DIR + '/fixtures/config.created.yml'
+      FileUtils.rm(file) if File.exists?(file)
+      Configarrr::YAML.new(:file => file)
+      File.exists?(file).should be_true
+    end
+
+    it "sets options from the file" do
+      @config.first_key.should == "first_value"
+    end
+  end
+
+  context "choosing a parent scalar" do
+    before do
+      @yaml_parent = Configarrr::YAML.new(:file => SPEC_DIR + '/fixtures/config.yml', :parent => 'parent')
+    end
+
+    it "should return the parents children" do
+      @yaml_parent.first_key.should == "first_parent_value"
+    end
+
+    it "should save all of the yaml, not just the parent scalar" do
+      @yaml_parent.to_hash.should == @config.to_hash
+    end
+
+    context "when it doesn't exist" do
+      it "should raise an Configarrr::OptionError" do
+        lambda { Configarrr::YAML.new(:file => SPEC_DIR + '/fixtures/config.yml', :parent => 'non_existant_parent') }.should raise_error(Configarrr::OptionError, "Please provide a valid parent value. non_existant_parent does not exist.")
+      end
+    end
+  end
+
+  context "providing default settings" do
+    before do
+      @yaml_with_defaults = YAMLWithDefaults.new(:file => SPEC_DIR + '/fixtures/config.yml')
+    end
+
+    it "should not override provided settings" do
+      @yaml_with_defaults.first_key.should_not == 1234
+    end
+
+    it "should provide setting if not provided" do
+      @yaml_with_defaults.third_key.should == 1234
+    end
+  end
+
+  it_should_behave_like "a Configarrr implementation"
+
+  after :all do
+    %w( created parent ).each do |file|
+      File.unlink(SPEC_DIR + "/fixtures/config.#{file}.yml") if File.exists?(SPEC_DIR + "/fixtures/config.#{file}.yml")
+    end
+  end
+end

data/spec/fixtures/config.yml

@@ -0,0 +1,3 @@
+first_key: first_value
+parent:
+  first_key: first_parent_value

data/spec/shared.rb

@@ -0,0 +1,13 @@
+shared_examples_for "a Configarrr implementation" do
+  context "configure" do
+    before :each do
+      @config.configure do
+        set :key, :value
+      end
+    end
+
+    it "should allow you to set values" do
+      @config.key.should == :value
+    end
+  end  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+-f o -c

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'spec'
+
+SPEC_DIR = File.dirname(__FILE__) unless defined? SPEC_DIR
+$:<< SPEC_DIR
+ 
+require File.join(SPEC_DIR, '..', 'lib', 'configarrr')
+
+require File.dirname(__FILE__) + '/shared'

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: configarrr
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Dylan Egan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-30 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: Actually it's not. It's just a way of handling configuration.
+email: dylanegan@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- VERSION
+- lib/configarrr.rb
+- lib/configarrr/base.rb
+- lib/configarrr/simple.rb
+- lib/configarrr/yaml.rb
+- spec/configarrr/base_spec.rb
+- spec/configarrr/yaml_spec.rb
+- spec/fixtures/config.yml
+- spec/shared.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/abcde/configarrr
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Pirates way of configuring, maties!
+test_files: 
+- spec/configarrr/base_spec.rb
+- spec/configarrr/yaml_spec.rb
+- spec/shared.rb
+- spec/spec_helper.rb