yaml_model 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 Michael Bleigh
+
+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 @@
+= YamlModel
+
+Because sometimes you just don't need to write to your models.
+YamlModel is a simple wrapper that provides some of the functionality
+of an ORM for completely static, YAML-based data.
+
+== 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 Intridea, Inc. and Michael Bleigh. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "yaml_model"
+    gem.summary = %Q{A basic ORM-like setup for reading YAML files.}
+    gem.description = %Q{A basic ORM-like setup for reading YAML files.}
+    gem.email = "michael@intridea.com"
+    gem.homepage = "http://github.com/intridea/yaml_model"
+    gem.authors = ["Michael Bleigh"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  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 = "yaml_model #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/yaml_model.rb

@@ -0,0 +1,80 @@
+require 'yaml'
+
+# YamlModel is a super-lightweight datastore for
+# loading and accessing fixed, infrequently changing
+# sets of data such as currencies or languages.
+class YamlModel
+  attr_reader :key
+  
+  class << self
+    def yaml_file(path_or_file = nil)
+      return @yaml_file unless path_or_file
+      @yaml_file = path_or_file
+    end
+    
+    # The complete hash of existing themes.
+    def collection
+      @collection ||= YAML.load_file(yaml_file).freeze
+    end
+    
+    # The complete instantiated list of models
+    def all
+      @all ||= collection.inject([]){|result, (key, value)| result << self.new(key.to_s, value); result}.freeze
+    end
+    
+    # Reset the collection to be reloaded again from YAML on the next call.
+    def reset!
+      @collection, @all, @instances = nil
+    end
+  
+    # Find the mode
+    def [](key)
+      return nil unless collection.key?(key.to_s)
+      (@instances ||= {})[key.to_s] ||= self.new(key, collection[key.to_s])
+    end
+    alias_method :find, :[]
+    
+    def attribute(name, options = {})
+      (@attributes ||= []) << name.to_s
+      (@defaults ||= {})[name.to_s] = options.delete(:default)
+      
+      class_eval do
+        attr_reader name
+      end
+    end
+    
+    attr_reader :attributes
+    attr_reader :defaults
+  end
+  
+  # Instantiate the model with the provided key and attributes.
+  def initialize(key, attrs = {})
+    attrs = attrs.inject({}){|h,(k,v)| h[k.to_s] = v; h}
+    @key = key.to_s
+    self.class.attributes.each do |attribute|
+      instance_variable_set("@#{attribute}", attrs[attribute.to_s] || self.class.defaults[attribute.to_s])
+    end
+  end
+  
+  def ==(other)
+    other.is_a?(self.class) && self.key == other.key
+  end
+  
+  def <=>(other)
+    -(other <=> self.key)
+  end
+  
+  def < (other); (self <=> other) < 0 end
+  def <= (other); (self <=> other) <= 0 end
+  def >= (other); (self <=> other) >= 0 end
+  def > (other); (self <=> other) > 0 end
+  
+  def to_s
+    key
+  end
+  alias_method :to_yaml, :to_s
+  
+  def to_sym
+    key.to_sym
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

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

data/spec/yaml_model_spec.rb

@@ -0,0 +1,171 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class ExampleYamlModel < YamlModel
+  attribute :name
+  attribute :scheme, :default => 'skeeball'
+end
+
+describe YamlModel do
+  before do 
+    @fixture = {
+      "ABC" => {
+        "name" => "Always Be Coding"
+      },
+
+      "DEF" => {
+        "name" => "Defense Electric Fort",
+        "scheme" => "snowball"
+      },
+      
+      "GHI" => {
+        "name" => "Gordon's Heaving International",
+        "scheme" => "foosball"
+      }
+    }
+    
+    YAML.stub!(:load_file).and_return(@fixture)
+  end
+  
+  describe '.yaml_file' do
+    it 'should set and retrieve a class instance variable' do
+      ExampleYamlModel.yaml_file '/awesome.yml'
+      ExampleYamlModel.yaml_file.should == '/awesome.yml'
+    end
+  end
+  
+  describe '.collection' do
+    it 'should be the YAML loading of config/tableized_model_name.yml with symbolized keys' do
+      YAML.should_receive(:load_file).and_return(@theme_fixture)
+      ExampleYamlModel.collection
+    end
+    
+    it 'should be a hash' do
+      ExampleYamlModel.collection.should be_kind_of(Hash)
+    end
+    
+    it 'should memoize' do
+      YAML.should_receive(:load_file).once.and_return(@theme_fixture)
+      3.times{ExampleYamlModel.collection}
+    end
+  end
+  
+  describe '.all' do
+    it 'should instantiate an array of the example objects' do
+      ExampleYamlModel.all.should be_include(ExampleYamlModel[:GHI])
+    end
+    
+    it 'should be the same length as the collection' do
+      ExampleYamlModel.all.size.should == ExampleYamlModel.collection.size
+    end
+    
+    it 'should initialize with proper attributes' do
+      t = ExampleYamlModel.all.select{|e| e.key == "ABC"}.first
+      t.name.should == "Always Be Coding"
+    end
+    
+    it 'should memoize' do
+      collection = ExampleYamlModel.collection
+      ExampleYamlModel.should_receive(:collection).once.and_return(collection)
+      3.times{ExampleYamlModel.all}
+    end
+  end
+  
+  describe '.reset!' do
+    it 'should clear the collection' do
+      ExampleYamlModel.instance_variable_set(:@collection, "abc")
+      ExampleYamlModel.reset!
+      ExampleYamlModel.instance_variable_get(:@collection).should be_nil
+    end
+    
+    it 'should clear the .all cache' do
+      ExampleYamlModel.instance_variable_set(:@all, "aoisdasd")
+      ExampleYamlModel.reset!
+      ExampleYamlModel.instance_variable_get(:@all).should be_nil
+    end
+  end
+  
+  describe "[]" do
+    it 'should instantiate the theme specified by the key' do
+      ExampleYamlModel[:ABC].name.should == 'Always Be Coding'
+    end
+    
+    it 'should be nil if a non-existent theme is passed' do
+      ExampleYamlModel[:nonexistent].should be_nil
+    end
+    
+    it 'should be indifferent to string/symbol' do
+      ExampleYamlModel["ABC"].should == ExampleYamlModel[:ABC]
+    end
+    
+    it 'should be memoized' do
+      ExampleYamlModel.should_receive(:new).once.with("ABC", "name" => 'Always Be Coding').and_return('wakka')
+      3.times{ExampleYamlModel["ABC"]}
+    end
+  end
+  
+  describe ' sorting' do
+    it ' <=> should compare using the key' do
+      (ExampleYamlModel.new('abc') <=> ExampleYamlModel.new('bed')).should == -1
+      (ExampleYamlModel.new('abc') <=> ExampleYamlModel.new('abc')).should == 0
+      (ExampleYamlModel.new('bed') <=> ExampleYamlModel.new('abc')).should == 1
+    end
+    
+    it 'should use < properly' do 
+      (ExampleYamlModel.new('abc') < ExampleYamlModel.new('bed')).should == true
+      (ExampleYamlModel.new('bed') < ExampleYamlModel.new('abc')).should == false
+      (ExampleYamlModel.new('bed') < ExampleYamlModel.new('bed')).should == false
+    end
+    
+    it 'should use > properly' do 
+      (ExampleYamlModel.new('abc') > ExampleYamlModel.new('bed')).should == false
+      (ExampleYamlModel.new('bed') > ExampleYamlModel.new('abc')).should == true
+      (ExampleYamlModel.new('bed') > ExampleYamlModel.new('bed')).should == false      
+    end
+    
+    it 'should use >= properly' do
+      (ExampleYamlModel.new('abc') >= ExampleYamlModel.new('bed')).should == false
+      (ExampleYamlModel.new('bed') >= ExampleYamlModel.new('abc')).should == true
+      (ExampleYamlModel.new('bed') <= ExampleYamlModel.new('bed')).should == true
+    end
+    
+    it 'should use <= properly' do 
+      (ExampleYamlModel.new('abc') <= ExampleYamlModel.new('bed')).should == true
+      (ExampleYamlModel.new('bed') <= ExampleYamlModel.new('abc')).should == false
+      (ExampleYamlModel.new('bed') <= ExampleYamlModel.new('bed')).should == true
+    end
+  end
+  
+  describe '.attribute' do
+    it 'should add the specified attribute to the attributes list' do
+      ExampleYamlModel.attributes.should be_include('name')
+    end
+    
+    it 'should be able to specify a default' do
+      ExampleYamlModel.new(:test).scheme.should == 'skeeball'
+    end
+  end
+  
+  describe ".find" do
+    it 'should be the same as ExampleYamlModel[]' do
+      ExampleYamlModel.find(:ABC).should == ExampleYamlModel[:ABC]
+    end
+  end
+  
+  describe '#new' do
+    it 'should allow for the attributes to be set' do
+      ExampleYamlModel.new(:test, :name => 'Awesome ExampleYamlModel').name.should == 'Awesome ExampleYamlModel'
+      ExampleYamlModel.new(:test, :scheme => 'bocciball').scheme.should == 'bocciball'
+      ExampleYamlModel.new(:test).key.should == "test"
+    end
+  end
+  
+  describe '#to_s' do
+    it 'should be the string representation of the key' do
+      ExampleYamlModel[:ABC].to_s.should == ExampleYamlModel[:ABC].key.to_s
+    end
+  end
+  
+  after do
+    ExampleYamlModel.reset!
+  end
+end

data/yaml_model.gemspec

@@ -0,0 +1,55 @@
+# 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{yaml_model}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Bleigh"]
+  s.date = %q{2010-04-01}
+  s.description = %q{A basic ORM-like setup for reading YAML files.}
+  s.email = %q{michael@intridea.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/yaml_model.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/yaml_model_spec.rb",
+     "yaml_model.gemspec"
+  ]
+  s.homepage = %q{http://github.com/intridea/yaml_model}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A basic ORM-like setup for reading YAML files.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/yaml_model_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"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: yaml_model
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Bleigh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-01 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: A basic ORM-like setup for reading YAML files.
+email: michael@intridea.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/yaml_model.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/yaml_model_spec.rb
+- yaml_model.gemspec
+has_rdoc: true
+homepage: http://github.com/intridea/yaml_model
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A basic ORM-like setup for reading YAML files.
+test_files: 
+- spec/spec_helper.rb
+- spec/yaml_model_spec.rb