static_model 0.1.0 → 0.1.3

data/Manifest.txt

@@ -7,10 +7,16 @@ config/hoe.rb
 config/requirements.rb
 lib/static_model.rb
 lib/static_model/base.rb
+lib/static_model/associations.rb
+lib/static_model/active_record.rb
+lib/static_model/comparable.rb
 lib/static_model/errors.rb
 lib/static_model/rails.rb
 lib/static_model/version.rb
 setup.rb
 test/books.yml
+test/authors.yml
+test/publishers.yml
 test/test_helper.rb
-test/test_static_model.rb
+test/test_static_model.rb
+test/test_static_model_associations.rb

data/README.txt

@@ -13,6 +13,7 @@ ActiveRecord like functionalities for reading from YAML with a simple class impl
 == REQUIREMENTS:
 
 	YAML 
+	activesupport >= 2.1.0
 
 == INSTALL:
 

data/config/hoe.rb

@@ -8,7 +8,7 @@ RUBYFORGE_PROJECT = 'quirkey' # The unix name for your project
 HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
 DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
 EXTRA_DEPENDENCIES = [
-#  ['activesupport', '>= 1.3.1']
+  ['activesupport', '>= 2.1.0']
 ]    # An array of rubygem dependencies [name, version]
 
 @config_file = "~/.rubyforge/user-config.yml"

data/lib/static_model/active_record.rb

@@ -0,0 +1,11 @@
+module StaticModel
+  module ActiveRecord
+    # Stubbing out ActiveRecord methods so that associations work
+    
+    def new_record?
+      false
+    end
+    
+
+  end
+end

data/lib/static_model/associations.rb

@@ -0,0 +1,82 @@
+module StaticModel
+  module Associations
+
+    def self.included(klass)
+      klass.extend MacroMethods
+    end
+
+    module MacroMethods
+
+      def associations
+        @associations ||= {}
+      end
+
+      def has_many(association_name, options = {})
+        self.associations[association_name.to_sym] = HasManyAssociation.new(self, association_name.to_sym, {:foreign_key => "#{self.to_s.foreign_key}"}.merge(options))
+      end
+      
+      def belongs_to(association_name, options = {})
+        self.associations[association_name.to_sym] = BelongsToAssociation.new(self, association_name.to_sym, {:foreign_key => "#{association_name.to_s.foreign_key}"}.merge(options))
+      end
+
+    end
+
+
+    class Association
+      attr_reader :klass, :name, :options, :foreign_key
+
+      def initialize(klass, name, options = {})
+        @klass = klass
+        @name = name
+        @options = options
+        @reflection_klass_name = @options[:class_name] || @name.to_s.classify
+        @foreign_key = @options[:foreign_key]
+        define_association_methods
+      end
+      
+      def reflection_klass
+        Object.const_get(@reflection_klass_name)
+      rescue 
+        eval <<-EOT
+          class #{@reflection_klass_name}; end;
+          #{@reflection_klass_name}
+        EOT
+      end
+
+      def define_association_methods
+        raise 'Should only use descendants of Association'
+      end
+    end
+
+    class HasManyAssociation < Association
+
+      def define_association_methods
+        if reflection_klass.respond_to?(:scoped)
+          klass.module_eval <<-EOT
+            def #{name}
+              #{reflection_klass}.scoped(:conditions => {:#{foreign_key} => id})
+            end
+          EOT
+        else
+          klass.module_eval <<-EOT
+          def #{name}
+            #{reflection_klass}.send(:find_all_by_#{foreign_key}, id)
+          end
+          EOT
+        end
+      end
+    end
+
+    class BelongsToAssociation < Association
+      
+      def define_association_methods
+        klass.module_eval <<-EOT
+          def #{name}
+            #{reflection_klass}.send(:find, #{foreign_key})
+          end
+        EOT
+      end
+    end
+
+  end
+end

data/lib/static_model/base.rb

@@ -1,6 +1,9 @@
 module StaticModel  
   class Base
-
+    include StaticModel::Associations
+    include StaticModel::ActiveRecord
+    include StaticModel::Comparable
+    
     @@load_path = File.join('config', 'data')
 
     attr_reader :id
@@ -39,8 +42,7 @@ module StaticModel
       end
 
       def find_by_id(id)
-        load
-        record = @@records.detect {|r| r.id == id }
+        record = records.detect {|r| r.id == id }
         raise(StaticModel::RecordNotFound, "Could not find record with id = #{id}") unless record
         record
       end
@@ -50,50 +52,54 @@ module StaticModel
       end
 
       def find_all
-        load
-        @@records
+        records
       end
       alias_method :all, :find_all
 
       def find_first
-        load
-        @@records[0]
+        records[0]
       end
       alias_method :first, :find_first
 
       def find_all_by(attribute, value)
-        load
-        records = @@records.find_all {|r| r.send(attribute) == value }
+        records.find_all {|r| r.send(attribute) == value }
       end
 
       def find_first_by(attribute, value)
-        load
-        records = @@records.find {|r| r.send(attribute) == value }
+        records.find {|r| r.send(attribute) == value }
       end
 
       def load(reload = false)
         return if loaded? && !reload
         raise(StaticModel::DataFileNotFound, "You must set a data file to load from") unless File.readable?(data_file) 
         records = YAML::load_file(data_file)
-        @@records = records.dup.collect {|r| new(r) }
-        @@loaded = true
+        @records = records.dup.collect {|r| new(r) }
+        @loaded = true
       end
 
       def loaded?
-        @@loaded ||= false
+        @loaded ||= false
       end
 
       def data_file
-        @@data_file ||= default_data_file_path
+        @data_file ||= default_data_file_path
       end
 
       def set_data_file(file_path)
         raise(StaticModel::DataFileNotFound, "Could not find data file #{file_path}") unless File.readable?(file_path)
-        @@data_file = file_path
+        @data_file = file_path
+        # force reload
+        @loaded = false
+        @records = nil
       end
     
       def count
-        @@records.length
+        records.length
+      end
+      
+      def records
+        load
+        @records
       end
 
       protected

data/lib/static_model/comparable.rb

@@ -0,0 +1,14 @@
+module StaticModel
+  module Comparable
+    include ::Comparable
+
+    def <=>(other)
+      if self.class == other.class 
+        self.id <=> other.id
+      else
+        -1
+      end
+    end
+    
+  end
+end

data/lib/static_model/version.rb

@@ -2,7 +2,7 @@ module StaticModel #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 0
+    TINY  = 3
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/static_model.rb

@@ -2,6 +2,13 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 require 'yaml'
+
+require 'active_support/inflector'
+require 'active_support/core_ext/string'
+
 require 'static_model/errors'
+require 'static_model/associations'
+require 'static_model/active_record'
+require 'static_model/comparable'
 require 'static_model/base'
 require 'static_model/rails'

data/test/authors.yml

@@ -0,0 +1,10 @@
+---
+  - id: 1
+    publisher_id: 1
+    name: Michael Pollan
+  - id: 2
+    publisher_id:
+    name: Piers Anthony
+  - id: 3
+    publisher_id: 2
+    name: Chuck Palahniuk 

data/test/books.yml

@@ -2,17 +2,21 @@
   - id: 1
     title: The Omnivore's Dilemma
     author: Michael Pollan
+    author_id: 1
     genre: Non-Fiction
   - id: 2
     title: In Defense of Food
     author: Michael Pollan
+    author_id: 1
     genre: Non-Fiction
   - id: 3
     title: Omnivore (Of Man and Manta)
     author: Piers Anthony
+    author_id: 2
     genre: Fantasy
   - id: 4
     title: Choke
     author: Chuck Palahniuk 
+    author_id: 3
     genre: Humor
     

data/test/publishers.yml

@@ -0,0 +1,5 @@
+---
+  - id: 1
+    name: Phaidon
+  - id: 2
+    name: Penguin

data/test/test_helper.rb

@@ -1,9 +1,75 @@
 require 'test/unit'
 require 'rubygems'
 require 'shoulda'
+require 'mocha'
 
 require File.dirname(__FILE__) + '/../lib/static_model'
 
 class Book < StaticModel::Base
   set_data_file File.join(File.dirname(__FILE__), 'books.yml')
 end
+
+unless defined?(ActiveRecord::Base)
+  module ActiveRecord
+    class Base
+      def self.scoped(*args)
+      end
+    end
+  end
+end
+
+class Article < ActiveRecord::Base
+end
+
+class Publisher < StaticModel::Base
+  set_data_file File.join(File.dirname(__FILE__), 'publishers.yml')
+  
+  has_many :authors
+end
+
+class Author < StaticModel::Base
+  set_data_file File.join(File.dirname(__FILE__), 'authors.yml')
+  has_many :books
+  has_many :articles
+  belongs_to :publisher
+end
+
+
+
+
+class Test::Unit::TestCase
+  
+  def assert_all(collection)
+    collection.each do |one|
+      assert yield(one), "#{one} is not true"
+    end
+  end
+
+
+  def assert_any(collection, &block)
+    has = collection.any? do |one|
+      yield(one)
+    end
+    assert has
+  end
+
+  def assert_ordered(array_of_ordered_items, message = nil, &block)
+    raise "Parameter must be an Array" unless array_of_ordered_items.is_a?(Array)
+    message ||= "Items were not in the correct order"
+    i = 0
+    # puts array_of_ordered_items.length
+    while i < (array_of_ordered_items.length - 1)
+      # puts "j"
+      a, b = array_of_ordered_items[i], array_of_ordered_items[i+1]
+      comparison = yield(a,b)
+      # raise "#{comparison}"
+      assert(comparison, message + " - #{a}, #{b}")
+      i += 1
+    end
+  end
+  
+  def assert_set_of(klass, set)
+    assert set.respond_to?(:each), "#{set} is not a set (does not include Enumerable)"
+    assert_all(set) {|a| a.is_a?(klass) }
+  end
+end

data/test/test_static_model.rb

@@ -40,10 +40,51 @@ class TestStaticModel < Test::Unit::TestCase
             assert_equal @book.inspect, @book.to_s
           end
         end
+        
+        context "comparing" do
+          
+          should "be equal to an instance of the same class with same id" do
+            assert_equal @book, Book.new(book_params)
+          end
+          
+          should "not be equal to an instance with the same class with different ids" do
+            assert_not_equal Book[1], @book
+          end
+          
+          should "not be equal to an instance with different classes and the same ids" do
+            assert_not_equal Book[1], Author[1]
+          end
+        end
 
       end
 
       context "on the class" do
+        context "set data file" do
+          context "After the class is defined" do
+            
+            setup do
+              @book = Book.find(1)
+              @author = Author.find(1)
+              @original_data_file = Book.data_file
+              @data_file = File.join(File.dirname(__FILE__), 'authors.yml')
+              Book.set_data_file @data_file
+              @new_book = Book.find(1)
+            end
+            
+            should "set the @data_file" do
+              assert_equal @data_file, Book.data_file
+            end
+                        
+            should "reload with next find" do
+              assert @author.attributes, @new_book.attributes
+            end
+            
+            teardown do
+              Book.set_data_file @original_data_file
+            end
+          end
+        end
+        
         context "find" do
 
           context "with an integer" do
@@ -70,13 +111,13 @@ class TestStaticModel < Test::Unit::TestCase
             end
           end
         end
-        
+
         context "[]" do
           should "be an alias for find by id" do
             assert_equal Book.find(1), Book[1]
           end
         end
-        
+
         context "find(:all)" do
           should "be an alias for find_all" do
             assert_equal Book.find_all, Book.find(:all)
@@ -195,15 +236,14 @@ class TestStaticModel < Test::Unit::TestCase
             assert_equal Book.find_all_by(:genre, 'Non-Fiction'), Book.find_all_by_genre('Non-Fiction')
           end
         end
-        
+
         context "count" do
           should "return the count of all records" do
             assert_equal Book.all.length, Book.count
           end
         end
-        
+
       end
-    
     end
   end
 
@@ -211,4 +251,6 @@ class TestStaticModel < Test::Unit::TestCase
   def book_params
     {:id => 15, :title => 'Lord of the Rings', :author => 'J.R. Tolkien', :genre => 'Fantasy'}
   end
-end
+  
+
+end

data/test/test_static_model_associations.rb

@@ -0,0 +1,93 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestStaticModelAssociations < Test::Unit::TestCase
+
+  context "a static model class" do
+
+    context "with a has many association" do
+      context "to another static model" do
+        # Author has many books
+        setup do
+          @author = Author.find(1)
+        end
+
+        should "respond to association name" do
+          assert @author.books
+        end
+
+        should "return an array of association instances if association is a StaticModel" do
+          assert_set_of Book, @author.books
+        end
+
+        should "find books by foreign_key" do
+          assert_equal Book.find_all_by_author_id(@author.id), @author.books
+        end
+
+        should "add association to associations" do
+          assert Author.associations.has_key?(:books)
+        end
+
+        should "have HasManyAssociation in associations" do
+          assert Author.associations[:books].is_a?(StaticModel::Associations::HasManyAssociation)
+        end
+      end
+
+      context "to an active record model" do
+        setup do
+          @author = Author.find(1)
+          Article.expects(:scoped).returns([Article.new, Article.new])
+        end
+
+        should "respond to association name" do
+          assert @author.articles
+        end
+
+        should "return an array of association instances if association is a StaticModel" do
+          assert_set_of Article, @author.articles
+        end
+
+      end
+    end
+
+
+    context "with a belongs to association" do
+      context "to another static model" do
+        # Author belongs to publisher
+        setup do
+          @author = Author.find(1)
+        end
+
+        should "respond to association name" do
+          assert @author.publisher
+        end
+
+        should "return a single instance" do
+          assert @author.publisher.is_a?(Publisher)
+        end
+
+        should "find publisher by foreign key" do
+          assert_equal Publisher.find(1), @author.publisher
+        end
+
+        should "add association to associations" do
+          assert Author.associations.has_key?(:publisher)
+        end
+
+        should "have BelongsTo association in associations" do
+          assert Author.associations[:publisher].is_a?(StaticModel::Associations::BelongsToAssociation)
+        end
+
+        context "when foreign key is nil" do
+          setup do
+            @author = Author.find(2)
+          end
+
+          should "respond to association name and return nil" do
+            assert_nil @author.publisher
+          end
+        end
+      end
+    end
+
+  end
+end

data/test/test_static_model_scope.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestStaticModelScope < Test::Unit::TestCase
+
+  context "a static model class" do
+    context "A class with scope" do
+      
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: static_model
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors: 
 - Aaron Quint
@@ -9,10 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-09 00:00:00 -04:00
+date: 2008-08-01 00:00:00 -04:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
 description: ActiveRecord like functionalities for reading from YAML with a simple class implementation
 email: 
 - aaron@quirkey.com
@@ -35,13 +44,19 @@ files:
 - config/requirements.rb
 - lib/static_model.rb
 - lib/static_model/base.rb
+- lib/static_model/associations.rb
+- lib/static_model/active_record.rb
+- lib/static_model/comparable.rb
 - lib/static_model/errors.rb
 - lib/static_model/rails.rb
 - lib/static_model/version.rb
 - setup.rb
 - test/books.yml
+- test/authors.yml
+- test/publishers.yml
 - test/test_helper.rb
 - test/test_static_model.rb
+- test/test_static_model_associations.rb
 has_rdoc: true
 homepage: http://quirkey.rubyforge.org
 post_install_message: ""
@@ -72,3 +87,5 @@ summary: ActiveRecord like functionalities for reading from YAML with a simple c
 test_files: 
 - test/test_helper.rb
 - test/test_static_model.rb
+- test/test_static_model_associations.rb
+- test/test_static_model_scope.rb