dionysus 0.0.0.pre1 → 0.1.0

data/README.md

@@ -17,6 +17,11 @@ Installation
 
     gem install dionysus
 
+Usage
+-----
+
+First, add "dionysus" to your Gemfile or whatever other dependency system you're using.  Then, you'll need to require each file as you need them.  Dionysus is setup *à la carte* since parts are bound to conflict with something you're using at some point.
+
 Resources
 ---------
 

data/VERSION

@@ -1 +1 @@
-0.0.0.pre1
+0.1.0

data/dionysus.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dionysus}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Travis D. Warlick, Jr."]
+  s.date = %q{2010-03-15}
+  s.email = %q{warlickt@operissystems.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "dionysus.gemspec",
+     "lib/dionysus.rb",
+     "lib/dionysus/configuration.rb",
+     "spec/configuration_spec.rb",
+     "spec/dionysus_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/tekwiz/dionysus}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A helpful set of utility classes, generators, and command-line tools.}
+  s.test_files = [
+    "spec/configuration_spec.rb",
+     "spec/dionysus_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, ["= 3.0.0.beta"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<activesupport>, ["= 3.0.0.beta"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, ["= 3.0.0.beta"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/dionysus.rb

@@ -3,7 +3,7 @@ gem 'activesupport', '3.0.0.beta'
 require 'active_support/all'
 
 ##
-# The top-level for Phoebe
+# The top-level for Dionysus
 module Dionysus
   # The current version
   VERSION = File.read(File.join(File.dirname(__FILE__), '..', 'VERSION')).strip

data/lib/dionysus/configuration.rb

@@ -0,0 +1,193 @@
+##
+# = Configuration
+#
+#     require 'dionysus/configuration'
+#
+# A simple configuration system that can work in a "hard-keys" or "soft-keys"
+# mode. In the "hard-keys" mode, the configuration will only allow a specific
+# set of keys given on initialization.  In "soft-keys" mode, the configuration
+# will accept any keys, at any time, as long as they are valid.
+#
+# == Soft Keys Example:
+#
+#    config = Configuration.new(false, :a_key => 'some value')
+#    config.soft_keys? #=> true
+#    config.hard_keys? #=> false
+#    config.a_key = 'new value'
+#    config.a_key #=> 'new value'
+#    config.another_key = 'some value'
+#    config.anoter_key #=> 'some value'
+#
+# == Hard Keys Example:
+#
+#    config = Configuration.new(:foo, :bar, {:wowsers => 'wow', :foo => 'fooey'})
+#    config.hard_keys? #=> true
+#    config.soft_keys? #=> false
+#    config.a_key #=> raises NoMethodError
+#    config[:a_key]  #=> raises ArgumentError
+#    config.foo = 'fooey'
+#    config.bar #=> nil
+#    config.wowsers #=> 'wow'
+# 
+# == Multi Access
+#
+# Values are accessible through the "magic" methods, get() and set() methods, 
+# and hash brackets. These will all give the same result:
+#    config.a_key
+#    config[:a_key]
+#    config['a_key']
+#    config.get(:a_key)
+#    config.get('a_key')
+#
+# == Object Keys
+#
+# All keys are converted to strings and then to symbols:
+#     o = Object.new
+#     config.set(o, 'foo')
+#     config.get(o) #=> 'foo'
+#     config.keys #=> [:'#<Object:0x190544c>']
+class Configuration
+  # Regex to define a valid key
+  VALID_KEY = '[A-Za-z0-9\-_]+'
+  
+  ##
+  # Create the configuration.
+  #
+  # Soft Keys mode:: Pass +false+ as the first argument.
+  # Hard Keys mode:: Default, or pass +true+ as the first argument.
+  def initialize( *args )
+    defaults = (args.last.is_a?(Hash) ? args.pop : {})
+    
+    if _hard_keys?(defaults, args)
+      @keys = _normalize_hard_keys(defaults, args)
+      raise ArgumentError, 'Cannot have a hard keys configuration with no keys' if @keys.empty?
+    else
+      @keys = nil
+      raise ArgumentError, 'Cannot define hard keys in soft keys mode' if args.any?
+    end
+    
+    _initialize_config(defaults)
+  end
+  
+  ##
+  # +true+ if the configuration is limited to a specific set of keys.
+  def hard_keys?() !!@keys; end
+  
+  ##
+  # +true+ if the configuration is NOT limited to a specific set of keys. 
+  # (Inverse) of +hard_keys?+
+  def soft_keys?() !@keys; end
+  
+  ##
+  # The set of keys for the configuration.  If this is a hard keys 
+  # configuration, it returns the possible keys.  Otherwise, it returns the 
+  # set keys.
+  def keys() @keys || @config.keys; end
+  
+  ##
+  # +false+ if there are any values set.
+  def empty?() @config.empty?; end
+  
+  ##
+  # The number of configurations set.
+  def size() @config.size; end
+  
+  ##
+  # Set the configuration key to the given value.
+  def set(key, value) validate_key(key); @config[_normalize_key(key)] = value; end
+  alias_method :'[]=', :set
+  
+  ##
+  # Get the configuration value.
+  def get(key) validate_key(key); @config[_normalize_key(key)]; end
+  alias_method :'[]', :get
+  
+  ##
+  # Delete the configuration value.
+  def delete(key) @config.delete(key); end
+  
+  ##
+  # Convert the configuration to a hash.
+  def to_hash() @config.to_hash; end
+  
+  ##
+  # +true+ if the key is valid.
+  def valid_key?( key )
+    return false if key.blank?
+    key = _normalize_key(key).to_s
+    key =~ /^#{VALID_KEY}$/ and !self.methods.include?(key)
+  end
+  
+  ##
+  # +true+ if the key is allowed.
+  def allowed_key?( key )
+    @keys.nil? ? true : @keys.include?(_normalize_key(key))
+  end
+  
+  private
+  
+  ##
+  # If the key is invalid, it raises an error.
+  def validate_key( key )
+    return true if valid_key?(key) and allowed_key?(key)
+    raise ArgumentError, "Invalid key: #{key}"
+  end
+  
+  ##
+  # Determine if the set of arguments is requesting a hard keys configuration.
+  #
+  # This is a hard key configuration set if
+  # 1) the first argument is NOT false
+  # 2) there are explicit keys defined
+  # 3) there is a default set of arguments
+  def _hard_keys?( defaults, args )
+    if args.first == true or args.first == false
+      args.shift
+    else
+      args.any? or (defaults and defaults.any?)
+    end
+  end
+  
+  ##
+  # Normalize the keys and keys from the defaults hash into the hard keys 
+  # array.
+  def _normalize_hard_keys( defaults, keys )
+    returning [] do |keys_|
+      (keys + defaults.keys).uniq.collect {|k| k.to_s}.sort.each do |key|
+        raise ArgumentError, "Invalid key: '#{key}'" unless valid_key?(key)
+        keys_ << _normalize_key(key)
+      end
+    end.freeze
+  end
+  
+  ##
+  # Normalize a key by converting it to a string and then a symbol.
+  def _normalize_key( key )
+    key.to_s.to_sym
+  end
+  
+  ##
+  # Initialize the default config hash
+  def _initialize_config( defaults )
+    @config = {}
+    defaults.each { |key, value| set(key, value) }
+    @config
+  end
+  
+  ##
+  # The magic.  Enables +config.foo+ and +config.foo=+ to map to the getters 
+  # and setters.
+  def method_missing( method_name, *args, &block )
+    match = method_name.to_s.match(/^(#{VALID_KEY})(=)??\Z/)
+    key, setter = _normalize_key(match[1]), (match[2] == '=')
+    
+    if allowed_key?(key) and !block_given?
+      if setter and args.length == 1
+        return set(key, args.first)
+      elsif match[1] and match[2].nil? and args.length == 0
+        return get(key)
+      end
+    end
+    super
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,176 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'dionysus/configuration'
+
+describe Configuration do
+  describe "basics" do
+    before(:each) { @c = Configuration.new(false) }
+  
+    it "should be empty when no defaults" do
+      @c.size.should == 0
+      @c.should be_empty
+    end
+  
+    it "should be accessible by hash brackets" do
+      @c[:something] = 'a value'
+      @c['something-else'] = 'b value'
+      @c.should_not be_empty
+      @c[:something].should == 'a value'
+      @c['something'].should == 'a value'
+      @c[:'something-else'].should == 'b value'
+      @c['something-else'].should == 'b value'
+    end
+  
+    it "should be accessible by method name" do
+      @c.something = 'a value'
+      @c.should_not be_empty
+      @c.something.should == 'a value'
+    end
+  
+    it "should be accessible by get/set methods" do
+      @c.set(:something, 'a value')
+      @c.set('something-else', 'b value')
+      @c.should_not be_empty
+      @c.get(:something).should == 'a value'
+      @c.get('something').should == 'a value'
+      @c.get(:'something-else').should == 'b value'
+      @c.get('something-else').should == 'b value'
+    end
+    
+    it "should not allow keys with the same name as defined methods." do
+      lambda { @c.set(:set, 'wowsers') }.should raise_error(ArgumentError, "Invalid key: set")
+      @c.to_hash[:set].should be_nil
+      lambda { @c[:set] = 'wowsers' }.should raise_error(ArgumentError, "Invalid key: set")
+      @c.to_hash[:set].should be_nil
+      lambda { @c.set = 'wowsers' }.should raise_error(ArgumentError, "Invalid key: set")
+      @c.to_hash[:set].should be_nil
+    end
+    
+    it "should not allow keys that do not conform to the allowed regex." do
+      lambda { @c.set('^&^&*^&*', 'wowsers') }.should raise_error(ArgumentError, "Invalid key: ^&^&*^&*")
+      lambda { @c.set('', 'wowsers') }.should raise_error(ArgumentError, "Invalid key: ")
+      lambda { @c.set(nil, 'wowsers') }.should raise_error(ArgumentError, "Invalid key: ")
+      lambda { @c.set(Object.new, 'wowsers') }.should raise_error(ArgumentError, /^Invalid key: #<Object:0x[a-fA-F0-9]+>$/)
+    end
+    
+    it "should revert to the normal method_missing with a block" do
+      lambda { @c.not_a_key { 1+1 } }.should raise_error(NoMethodError)
+    end
+    
+    it "should revert to the normal method_missing with any arguments" do
+      lambda { @c.not_a_key('fooey') }.should raise_error(NoMethodError)
+      lambda { @c.not_a_key(nil) }.should raise_error(NoMethodError)
+    end
+    
+    it "should revert to normal method_missing with a setter and more than 1 argument" do
+      lambda { @c.send(:not_a_key=, 'fooey', nil) }.should raise_error(NoMethodError)
+    end
+  end
+  
+  describe "with soft keys" do
+    before(:each) { @c = Configuration.new(false) }
+    
+    it 'should be soft keys' do
+      @c.should be_soft_keys
+    end
+    
+    it 'should initialize empty' do
+      @c.size.should == 0
+      @c.should be_empty
+    end
+  
+    it "should take defaults" do
+      @c = Configuration.new(false, :a_val => 'some value')
+      @c.should be_soft_key
+      @c.a_val.should == 'some value'
+      @c.size.should == 1
+      @c.should_not be_empty
+    end
+    
+    it "should remove the key on delete" do
+      @c.foo = 'fooey'
+      @c.keys.should == [:foo]
+    
+      @c.delete :foo
+      @c.foo.should be_nil
+      @c.keys.should be_empty
+    end
+  
+    it "should not remove the key on set nil" do
+      @c.foo = 'fooey'
+      @c.keys.should == [:foo]
+      
+      @c.foo = nil
+      @c.foo.should be_nil
+      @c.keys.should == [:foo]
+    end
+    
+    it "should allow any key" do
+      @c.allowed_key?('fjdasfiodsaifo').should be_true
+      @c.allowed_key?('^&*%^*9789').should be_true
+      @c.allowed_key?(Object.new).should be_true
+    end
+    
+    it "should not allow setting hard keys" do
+      lambda { @c = Configurat.new(false, :a_hard_key, :a_val => 'some_value') }.should
+        raise_error(ArgumentError, 'Cannot define hard keys in soft keys mode')
+      
+    end
+  end
+  
+  describe "with hard keys" do
+    before(:each) { @c = Configuration.new(:foo, :bar) }
+    
+    it "should be hard keys" do
+      @c.should be_hard_keys
+    end
+    
+    it "should initialize empty" do
+      @c.size.should == 0
+      @c.should be_empty
+      @c.keys.should == [:bar, :foo]
+    end
+    
+    it "should take defaults" do
+      @c = Configuration.new(:foo, :bar, {'wowsers' => 'wow', :bar => 'fooey'})
+      @c.keys.should == [:bar, :foo, :wowsers]
+      @c.size.should == 2
+      @c.foo.should == nil
+      @c.bar.should == 'fooey'
+      @c[:wowsers].should == 'wow'
+    end
+    
+    it "should not remove the key on delete" do
+      @c.foo = 'fooey'
+      @c.keys.should include(:foo)
+      @c.size.should == 1
+    
+      @c.delete :foo
+      @c.foo.should be_nil
+      @c.keys.should include(:foo)
+      @c.size.should == 0
+    end
+  
+    it "should not remove the key on set nil" do
+      @c.foo = 'fooey'
+      @c.keys.should include(:foo)
+      @c.size.should == 1
+      
+      @c.foo = nil
+      @c.foo.should be_nil
+      @c.keys.should include(:foo)
+      @c.size.should == 1
+    end
+    
+    it "should allow only the hard keys" do
+      @c.allowed_key?('fjdasfiodsaifo').should be_false
+      @c.allowed_key?('^&*%^*9789').should be_false
+      @c.allowed_key?(Object.new).should be_false
+      @c.allowed_key?(:foo).should be_true
+      @c.allowed_key?('foo').should be_true
+    end
+    
+    it "should revert to the normal method_missing an unallowed key" do
+      lambda { @c.not_a_key }.should raise_error(NoMethodError)
+    end
+  end
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: dionysus
 version: !ruby/object:Gem::Version 
-  prerelease: true
+  prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 0
-  - pre1
-  version: 0.0.0.pre1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Travis D. Warlick, Jr.
@@ -63,7 +62,10 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- dionysus.gemspec
 - lib/dionysus.rb
+- lib/dionysus/configuration.rb
+- spec/configuration_spec.rb
 - spec/dionysus_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -85,13 +87,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: 
@@ -100,5 +100,6 @@ signing_key:
 specification_version: 3
 summary: A helpful set of utility classes, generators, and command-line tools.
 test_files: 
+- spec/configuration_spec.rb
 - spec/dionysus_spec.rb
 - spec/spec_helper.rb