configulations 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.2)
+  rcov
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,26 @@
+Copyright (c) 2011 Leon Gersing
+Copyright (c) 2011 No Spoon Software
+
+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 developers using the software are responsible for having fun.
+It may seem like work, it may seem like the same task that you've
+solved over and over again but it's up to you to shape the experiences
+of your life. Enjoy yourself, it's a celebration.
+
+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/README.rdoc

@@ -0,0 +1,58 @@
+= Configulations - You can have a simple configuration class for Ruby apps!
+
+This is a bare bones, simple way to add configuration files to your ruby
+apps using either json or yml. Then, you can simply call into the configurator like
+any plain ol' Ruby object using the message passing dot syntax rather than
+hash/ordinal accessors.
+
+Included is a module called MagicHash that does all the magic mapping for the object.
+It should be considered pretty dangerous as it augments the expected behavior of Hash.
+To ensure as much flexibility without damaging Hash directly, configurator simply extends
+the instance of the property bag so that we get the power of hash without messing up
+hash for any one that is using it.
+
+== EXAMPLE
+
+by default, Configulations is going to recursively dive into a "config" directory located
+by the location of the executing ruby process. from there, any files ending in .yml or .json
+with the respetive content-types of YAML or JSON will be loaded. The name of the file is 
+the first key and all properties can be fetched from there.
+
+config = Configulations.new #=> finds config/server.json and config/admins.yml
+config.server.host #=> "localhost"
+config.admins.include? User.find_by_name("leon") #=> true
+
+== Known Issues
+
+* Right now data is first in- first out. If you have 2 config files with the same name
+the last one in, wins.
+* There is no inheritence. You can't set global options and then over-ride them with
+another file.
+
+You can however, augment the settings anytime you like. 
+
+config.admins.pop #=> gives one of our admins.
+
+== Future
+
+This is all I needed for now but I'd love to work out those issues mentioned above
+as well as allow for some robust Ruby configuration files that could take advantage
+of run time-evaluation and flow control for those situations when you'd like to let
+configuration be a bit more flexible than a yml, json file would allow.
+
+== Contributing to configulations
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+* This list is from Jeweler. Which is awesome...
+
+== Copyright
+
+Copyright (c) 2011 Leon Gersing. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "configulations"
+  gem.homepage = "http://github.com/leongersing/configurator"
+  gem.license = "MIT"
+  gem.summary = "Simple Config class for Ruby apps."
+  gem.description = "Auto-create configuration objects for your applications from yml and json files."
+  gem.email = "leongersing@gmail.com"
+  gem.authors = ["Leon Gersing"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "configurator #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1,2 @@
+0.1.0
+

data/config/development.yml

@@ -0,0 +1,3 @@
+host: "localhost"
+port: 3000
+boo: true

data/config/foo.json

@@ -0,0 +1,5 @@
+{ "name": "foo"
+, "person": "bar"
+, "people":["frank", "sally"]
+, "other":[{"foo":"bar"},{"bar":"baz"}]
+}

data/config/server.yml

@@ -0,0 +1,7 @@
+host: "localhost"
+port: 8080
+secure: false
+content-types:
+  - "html"
+  - "json"
+  - "xml"

data/configurator.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{configulations}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Leon Gersing"]
+  s.date = %q{2011-07-01}
+  s.description = %q{Auto-create configuration objects for your applications from yml and json files.}
+  s.email = %q{leongersing@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "config/development.yml",
+    "config/foo.json",
+    "config/server.yml",
+    "configulations.gemspec",
+    "lib/configulations.rb",
+    "lib/magic_hash.rb",
+    "spec/configulations_spec.rb",
+    "spec/magic_hash_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/leongersing/configulations}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Simple Config class for Ruby apps.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/configulations.rb

@@ -0,0 +1,37 @@
+require 'yaml'
+require 'json'
+require 'magic_hash'
+
+class Configulations
+  attr_accessor :properties
+
+  def initialize
+    @properties = {}
+    @properties.extend(MagicHash)
+
+    find_yaml_properties
+    find_json_properties
+
+    @properties.objectify
+    yield self if block_given?
+    self
+  end
+
+  def find_json_properties
+    Dir[File.expand_path(".") << "/config/**/*.json"].each do |json_file|
+      @properties[File.basename(json_file, ".json")] = JSON.load(File.read(json_file))
+    end
+  end
+
+  def find_yaml_properties
+    Dir[File.expand_path(".") << "/config/**/*.yml"].each do |yaml_file|
+      @properties[File.basename(yaml_file, ".yml")] = YAML.load(File.read(yaml_file))
+    end
+  end
+
+  def method_missing(message_name, *message_arguments, &optional_block)
+    result = properties.send message_name.to_sym, *message_arguments
+    return result if result
+    super message_name, *message_arguments, &optional_block
+  end
+end

data/lib/magic_hash.rb

@@ -0,0 +1,69 @@
+module MagicHash
+
+  def objectify
+    self.make_keys_valid_message_aliases
+    self.hash_all_keys
+    self
+  end
+
+  def make_keys_valid_message_aliases
+    tmp={}
+    tmp.extend(MagicHash)
+    self.each_pair do |key, value|
+      new_key = key.gsub(/\s|-/,"_").to_sym
+      if(value.is_a? Hash)
+        value.extend(MagicHash) unless value.respond_to? :objectify
+        tmp[new_key] = value.make_keys_valid_message_aliases
+      elsif(value.is_a? Array)
+        tmp[new_key] = value.map do |val|
+          if val.is_a?(Hash)
+            val.extend(MagicHash) unless val.respond_to? :objectify
+            val.make_keys_valid_message_aliases
+          else
+            val
+          end
+        end
+      else
+        tmp[new_key] = value
+      end
+    end
+    self.replace(tmp)
+  end
+
+  def hash_all_keys()
+    tmp = {}
+    tmp.extend(MagicHash)
+    self.each_pair do |k, v|
+      if v.is_a? Hash
+        v.extend(self) unless v.respond_to? :objectify
+        tmp[k.to_sym]= v.hash_all_keys
+      elsif v.is_a? Array
+        v = v.map do |value|
+          if value.is_a?(Hash.class)
+            value.extend(MagicHash) unless value.respond_to? :objectify
+            value.hash_all_keys
+          else
+            value
+          end
+        end
+        tmp[k.to_sym]= v
+      else
+        tmp[k.to_sym]= v
+      end
+    end
+    self.replace(tmp)
+  end
+
+  def method_missing(method_name, *args, &blk)
+    message = method_name.to_s.downcase.gsub(/-/,"_").to_sym
+    if message =~ /=/
+      self[message]= args.flatten.first
+      return
+    else
+      result = self[message]
+      return result if result
+    end
+
+    super(method_name, *args, &blk)
+  end
+end

data/spec/configurator_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe Configulations do
+  describe "looks like an object" do
+    it "allows for dot-style syntax accessors." do
+      c = Configulations.new
+      c.development.boo = true
+      c.development.boo.should == true
+    end
+
+    it "loads yml properties" do
+      c = Configulations.new
+      c.development.host.should == "localhost"
+    end
+
+    it "loads json properties" do
+      c = Configulations.new
+      c.foo.name.should == 'foo'
+    end
+
+    it "loves lazy duck typing" do
+      c = Configulations.new
+      c.server.content_types.should be_a_kind_of Array
+      c.server.content_types.length.should == 3
+    end
+  end
+end
+

data/spec/magic_hash_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+describe(MagicHash) do
+  describe("what makes it magical...") do
+    it "gives dot syntax to Hash." do
+      options ={:foo => "bar"}
+      options.extend(MagicHash)
+      options.foo.should == "bar"
+    end
+
+    it "is a hash when asked." do
+      options ={:foo => "bar"}
+      options.extend(MagicHash)
+      options.kind_of?(Hash).should == true
+      options.is_a?(Hash).should == true
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'configulations'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification 
+name: configulations
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Leon Gersing
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-01 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.2
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: Auto-create configuration objects for your applications from yml and json files.
+email: leongersing@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- config/development.yml
+- config/foo.json
+- config/server.yml
+- configurator.gemspec
+- lib/configulations.rb
+- lib/magic_hash.rb
+- spec/configurator_spec.rb
+- spec/magic_hash_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/leongersing/configurator
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -1373029058140856963
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Simple Config class for Ruby apps.
+test_files: []
+