configurize 0.0.1

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Scott Burton
+
+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/README.rdoc

@@ -0,0 +1,17 @@
+= configurize
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Scott Burton. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "configurize"
+    gem.summary = %Q{Configurize makes your ruby class configurable}
+    gem.description = %Q{Configurize makes your Ruby class configurable by providing a read-write interface to a flat YAML file stored in your application's config directory.}
+    gem.email = "scottburton11@gmail.com"
+    gem.homepage = "http://github.com/scottburton11/configurize"
+    gem.authors = ["Scott Burton"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "facets"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "configurize #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/configurize.gemspec

@@ -0,0 +1,58 @@
+# 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{configurize}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott Burton"]
+  s.date = %q{2010-01-21}
+  s.description = %q{Configurize makes your Ruby class configurable by providing a read-write interface to a flat YAML file stored in your application's config directory.}
+  s.email = %q{scottburton11@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "configurize.gemspec",
+     "lib/configurize.rb",
+     "spec/configurize_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/scottburton11/configurize}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Configurize makes your ruby class configurable}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/configurize_spec.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_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<facets>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<facets>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<facets>, [">= 0"])
+  end
+end
+

data/lib/configurize.rb

@@ -0,0 +1,57 @@
+require 'yaml'
+require 'facets/string'
+require 'facets/hash'
+
+module Configurize
+  def [](key)
+    config[key.to_sym]
+  end
+
+  def []=(key, value) 
+    config[key.to_sym] = value
+    write_config
+  end
+
+  def config
+    @config ||= load_config
+  end
+
+  def to_s
+    "#{self.name}: #{printable_config}"
+  end
+
+  private
+
+  def printable_config
+    array = []
+    config.each {|k,v| array << ":#{k} => \'#{v}\'" }
+    array.join(", ")
+  end
+
+  def config_file_path
+    if defined?(Rails)
+      File.expand_path(Rails.root + "/config/#{config_file_name}")
+    else
+      File.expand_path(__FILE__ + "/../../config/#{config_file_name}")
+    end
+  end
+
+  def config_file_name
+    "#{self.name.underscore}.yml"
+  end
+
+  def load_config
+    if File.exists?(config_file_path)
+      YAML.load_file(config_file_path).symbolize_keys
+    else
+      {}
+    end
+  end
+
+  def write_config
+    File.open(config_file_path, "w") do |file|
+      YAML.dump(config.stringify_keys, file)
+    end
+  end
+
+end

data/spec/configurize_spec.rb

@@ -0,0 +1,55 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+module ConfigurableThing
+  extend Configurize
+end
+
+module ConfigHelpers
+  def sample_config
+    {:one => "two", :three => 4}
+  end
+end
+
+describe Configurize, "using the hash key literal" do
+  include ConfigHelpers
+  
+  before(:each) do
+    ConfigurableThing.should_receive(:config).and_return(sample_config)
+  end
+
+  it "returns the value identified by the key provided" do
+    ConfigurableThing[:one].should eql("two")
+  end
+
+end
+
+describe Configurize, "using the hash key assignment literal" do
+
+  before(:each) do
+    ConfigurableThing.should_receive(:load_config).and_return({})
+    ConfigurableThing.should_receive(:write_config).and_return(true)
+  end
+
+  it "writes the value to the key provided" do
+    ConfigurableThing[:foo] = "bar"
+    ConfigurableThing[:foo].should eql("bar")
+  end
+
+end
+
+describe Configurize, "config file" do
+  include ConfigHelpers
+
+  it "name is determined by the mixed-in class" do
+    ConfigurableThing.send(:config_file_name).should eql("configurable_thing.yml")
+  end
+
+  it "is provided to YAML.load_file" do
+    File.stub!(:exists?).and_return(true)
+    ConfigurableThing.stub!(:config_file_path).and_return("/config/configurable_thing.yml")
+    YAML.should_receive(:load_file).with("/config/configurable_thing.yml").and_return(sample_config)
+    ConfigurableThing.send(:load_config)
+  end
+
+end
+

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'configurize'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: configurize
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Scott Burton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-21 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: facets
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Configurize makes your Ruby class configurable by providing a read-write interface to a flat YAML file stored in your application's config directory.
+email: scottburton11@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- configurize.gemspec
+- lib/configurize.rb
+- spec/configurize_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/scottburton11/configurize
+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: Configurize makes your ruby class configurable
+test_files: 
+- spec/spec_helper.rb
+- spec/configurize_spec.rb