active_hash 0.7.0 → 0.7.1

data/.gitignore

@@ -3,4 +3,5 @@
 coverage
 rdoc
 pkg
-.idea
+.idea
+junk.*

data/CHANGELOG

@@ -1,3 +1,10 @@
+2009-10-13
+  - added ActiveHash::Base.has_many, which works with ActiveRecord or ActiveHash classes (thanks to baldwindavid)
+  - added ActiveHash::Base.belongs_to, which works with ActiveRecord or ActiveHash classes (thanks to baldwindavid)
+  - added .delete_all method that clears the in-memory array
+  - added support for Hash-style yaml (think, Rails fixtures)
+  - added setter for parent object on belongs_to ( city = City.new; city.state = State.first; city.state_id == State.first.id )
+
 2009-10-12
   - auto-assign fields after calling data= instead of after calling .all
   - remove require 'rubygems', so folks with non-gem setups can still use AH

data/README.md

@@ -100,8 +100,10 @@ ActiveHash gives you ActiveRecord-esque methods like:
 
 It also gives you a few dynamic finder methods.  For example, if you defined :name as a field, you'd get:
 
-    Country.find_by_name "foo"      # => returns the first object matching that name
-    Country.find_all_by_name "foo"  # => returns an array of the objects with matching names
+    Country.find_by_name "foo"                    # => returns the first object matching that name
+    Country.find_all_by_name "foo"                # => returns an array of the objects with matching names
+    Country.find_by_id_and_name 1, "Germany"      # => returns the first object matching that id and name
+    Country.find_all_by_id_and_name 1, "Germany"  # => returns an array of objects matching that name and id
 
 ## Instance Methods
 
@@ -110,7 +112,7 @@ ActiveHash objects implement enough of the ActiveRecord api to satisfy most comm
     Country#id          # => returns the numeric id or nil
     Country#quoted_id   # => returns the numeric id
     Country#to_param    # => returns the id as a string
-    Country#new_record? # => false
+    Country#new_record? # => returns true if is not part of Country.all, false otherwise
     Country#readonly?   # => true
     Country#hash        # => the hash of the id (or the hash of nil)
     Country#eql?        # => compares type and id, returns false if id is nil
@@ -120,9 +122,36 @@ ActiveHash also gives you methods related to the fields you defined.  For exampl
     Country#name        # => returns the passed in name
     Country#name?       # => returns true if the name is not blank
 
-## Integration with Rails
+## Saving in-memory records
 
-You can create .belongs_to associations from rails objects, like so:
+The ActiveHash::Base.all method functions like an in-memory data store.  You can save your records to the the .all array by using standard ActiveRecord create and save methods:
+
+    Country.all             # => []
+    Country.create
+    Country.all             # [ <Country :id => 1> ]
+    country = Country.new
+    country.new_record?     # => true
+    country.save
+    country.new_record?     # => false
+    Country.all             # [ <Country :id => 1>, <Country :id => 2>  ]
+
+Notice that when adding records to the collection, it will auto-increment the id for you by default.  If you use string ids, it will not auto-increment the id.  Available methods are:
+
+    Country.insert( record )
+    Country#save
+    Country#save!
+    Country.create
+    Country.create!
+
+As such, ActiveHash::Base and its descendants should work with Fixjour or FactoryGirl, so you can treat ActiveHash records the same way you would any other ActiveRecord model in tests.
+
+To clear all records from the in-memory array, call delete_all:
+
+    Country.delete_all  # => does not affect the yaml files in any way - just clears the in-memory array which can be useful for testing
+
+## Associations
+
+You can create has_many and belongs_to associations to and from ActiveRecord.  Out of the box, you can create .belongs_to associations from rails objects, like so:
 
     class Country < ActiveHash::Base
     end
@@ -131,10 +160,57 @@ You can create .belongs_to associations from rails objects, like so:
       belongs_to :country
     end
 
+ActiveHash will also work as a polymorphic parent:
+
+    class Country < ActiveHash::Base
+    end
+
+    class Person < ActiveRecord::Base
+      belongs_to :location, :polymorphic => true
+    end
+
+    person = Person.new
+    person.location = Country.first
+    person.save
+    person.location # => Country.first
+
 You can also use standard rails view helpers, like #collection_select:
 
     <%= collection_select :person, :country_id, Country.all, :id, :name %>
 
+If you include the ActiveHash::Associations module, you can also create associations from your ActiveHash classes, like so:
+
+    class Country < ActiveHash::Base
+      include ActiveHash::Associations
+      has_many :people
+    end
+
+    class Person < ActiveHash::Base
+      include ActiveHash::Associations
+      belongs_to :country
+      has_many :pets
+    end
+
+    class Pet < ActiveRecord::Base
+    end
+
+Once you define a belongs to, you also get the setter method:
+
+    class City < ActiveHash::Base
+      include ActiveHash::Associations
+      belongs_to :state
+    end
+
+    city = City.new
+    city.state = State.first
+    city.state_id             # is State.first.id
+
+NOTE:  You cannot use ActiveHash objects as children of ActiveRecord and I don't plan on adding support for that.  It doesn't really make any sense, since you'd have to hard-code your database ids in your class or yaml files, which is a dependency inversion.
+
+Also, the implementation of has_many and belongs_to is very simple - I hope to add better support for it later - it will only work in the trivial cases for now.
+
+Thanks to baldwindavid for the ideas and code on that one.
+
 ## ActiveYaml
 
 If you want to store your data in YAML files, just inherit from ActiveYaml and specify your path information:
@@ -153,7 +229,26 @@ The above example will look for the file "/u/data/sample.yml".
 
 ActiveYaml, as well as ActiveFile, check the mtime of the file you specified, and reloads the data if the mtime has changed.  So you can replace the data in the files even if your app is running in production mode in rails.
 
-Since ActiveYaml just creates a hash from the YAML file, you will have all fields specified in YAML auto-defined for you once you call all.
+Since ActiveYaml just creates a hash from the YAML file, you will have all fields specified in YAML auto-defined for you once you call all.  You can format your YAML as an array, or as a hash:
+
+    # array style
+    - id: 1
+      name: US
+    - id: 2
+      name: Canada
+    - id: 3
+      name: Mexico
+
+    # hash style
+    us:
+      id: 1
+      name: US
+    canada:
+      id: 2
+      name: Canada
+    mexico:
+      id: 3
+      name: Mexico
 
 ## ActiveFile
 
@@ -191,7 +286,7 @@ NOTE:  By default, .full_path refers to the current working directory.  In a rai
 
 ## Authors
 
-Written by Jeff Dean, Mike Dalessio and Ben Woosley 
+Written by Jeff Dean, Mike Dalessio and Ben Woosley
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.7.1

data/active_hash.gemspec

@@ -1,8 +1,11 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{active_hash}
-  s.version = "0.7.0"
+  s.version = "0.7.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeff Dean", "Mike Dalessio", "Corey Innis", "Peter Jaros"]
@@ -26,21 +29,27 @@ Gem::Specification.new do |s|
      "lib/active_hash.rb",
      "lib/active_hash/base.rb",
      "lib/active_yaml/base.rb",
+     "lib/associations/associations.rb",
      "spec/active_file/base_spec.rb",
      "spec/active_hash/base_spec.rb",
      "spec/active_yaml/base_spec.rb",
-     "spec/active_yaml/sample.yml",
+     "spec/associations/associations_spec.rb",
+     "spec/fixtures/array_rows.yml",
+     "spec/fixtures/cities.yml",
+     "spec/fixtures/countries.yml",
+     "spec/fixtures/states.yml",
      "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/zilkey/active_hash}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.3}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{An ActiveRecord-like model that uses a hash or file as a datasource}
   s.test_files = [
     "spec/active_file/base_spec.rb",
      "spec/active_hash/base_spec.rb",
      "spec/active_yaml/base_spec.rb",
+     "spec/associations/associations_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/geminstaller.yml

@@ -9,3 +9,5 @@ gems:
   version: >= 1.2.8
 - name: fixjour
   version: 0.2.0
+- name: jeweler
+  version: 1.2.1

data/lib/active_hash.rb

@@ -2,3 +2,4 @@ require 'activesupport'
 require 'active_hash/base'
 require 'active_file/base'
 require 'active_yaml/base'
+require 'associations/associations'

data/lib/active_hash/base.rb

@@ -7,7 +7,12 @@ module ActiveHash
       def data=(array_of_hashes)
         @records = nil
         write_inheritable_attribute(:data, array_of_hashes)
-        auto_assign_fields( array_of_hashes )
+        if array_of_hashes
+          auto_assign_fields( array_of_hashes )
+          array_of_hashes.each do |hash|
+            insert new(hash)
+          end
+        end
       end
 
       def insert(record)
@@ -25,24 +30,20 @@ module ActiveHash
         end
       end
 
-      def create(attributes)
+      def create(attributes = {})
         record = new(attributes)
         record.save
         record
       end
 
-      def create!(attributes)
+      def create!(attributes = {})
         record = new(attributes)
         record.save!
         record
       end
 
       def all
-        unless @records
-          records = read_inheritable_attribute(:data) || []
-          @records = records.collect {|hash| new(hash)}
-        end
-        @records
+        @records || []
       end
 
       def count
@@ -55,6 +56,10 @@ module ActiveHash
 
       end
 
+      def delete_all
+        @records = []
+      end
+
       def find(id, *args)
         case id
           when :all

data/lib/active_yaml/base.rb

@@ -3,6 +3,14 @@ module ActiveYaml
   class Base < ActiveFile::Base
     class << self
       def load_file
+        if (data = raw_data).is_a?(Array)
+          data
+        else
+          data.values
+        end
+      end
+
+      def raw_data
         YAML.load_file(full_path)
       end
 
@@ -13,4 +21,4 @@ module ActiveYaml
     end
   end
 
-end
+end

data/lib/associations/associations.rb

@@ -0,0 +1,40 @@
+module ActiveHash
+  module Associations
+
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+    end
+
+    module ClassMethods
+      def has_many(association_id, options = {})
+
+        define_method(association_id) do
+          options = {
+            :class_name => association_id.to_s.classify,
+            :foreign_key => self.class.to_s.foreign_key
+          }.merge(options)
+
+          options[:class_name].constantize.send("find_all_by_#{options[:foreign_key]}", id)
+        end
+
+      end
+
+      def belongs_to(association_id, options = {})
+
+        options = {
+          :class_name => association_id.to_s.classify,
+          :foreign_key => association_id.to_s.foreign_key
+        }.merge(options)
+
+        define_method(association_id) do
+          options[:class_name].constantize.find(send(options[:foreign_key]))
+        end
+
+        define_method("#{association_id}=") do |new_value|
+          attributes[ options[:foreign_key].to_sym ] = new_value.id
+        end
+
+      end
+    end
+  end
+end

data/spec/active_hash/base_spec.rb

@@ -54,17 +54,17 @@ describe ActiveHash, "Base" do
       end
     end
 
-    it "populates the object with data" do
+    it "populates the object with data and auto-assigns keys" do
       Country.data = [{:name => "US"}, {:name => "Canada"}]
-      Country.data.should == [{:name => "US"}, {:name => "Canada"}]
+      Country.data.should == [{:name => "US", :id => 1}, {:name => "Canada", :id => 2}]
     end
 
     it "allows each of it's subclasses to have it's own data" do
       Country.data = [{:name => "US"}, {:name => "Canada"}]
       Region.data = [{:description => "A big region"}, {:description => "A remote region"}]
 
-      Country.data.should == [{:name => "US"}, {:name => "Canada"}]
-      Region.data.should == [{:description => "A big region"}, {:description => "A remote region"}]
+      Country.data.should == [{:name => "US", :id => 1}, {:name => "Canada", :id => 2}]
+      Region.data.should == [{:description => "A big region", :id => 1}, {:description => "A remote region", :id => 2}]
     end
   end
 
@@ -567,7 +567,7 @@ describe ActiveHash, "Base" do
       Country.all.should be_empty
       country = Country.new :id => 1, :name => "foo"
       country.save.should be_true
-      Country.all.should == [country] 
+      Country.all.should == [country]
     end
 
     it "adds the new object to the data collection" do
@@ -585,6 +585,12 @@ describe ActiveHash, "Base" do
       Country.field :name
     end
 
+    it "works with no args" do
+      Country.all.should be_empty
+      country = Country.create
+      country.id.should == 1
+    end
+
     it "adds the new object to the data collection" do
       Country.all.should be_empty
       country = Country.create :id => 1, :name => "foo"
@@ -648,7 +654,7 @@ describe ActiveHash, "Base" do
     it "returns false when the object is already part of the collection" do
       Country.new(:id => 1).should_not be_new_record
     end
-    
+
     it "returns true when the object is not part of the collection" do
       Country.new(:id => 2).should be_new_record
     end
@@ -683,6 +689,18 @@ describe ActiveHash, "Base" do
 
   end
 
+  describe ".delete_all" do
+
+    it "clears out all record" do
+      country1 = Country.create
+      country2 = Country.create
+      Country.all.should == [country1, country2]
+      Country.delete_all
+      Country.all.should be_empty
+    end
+
+  end
+
   describe "using with Fixjour" do
 
     before do

data/spec/active_yaml/base_spec.rb

@@ -2,19 +2,55 @@ require 'spec/spec_helper'
 
 describe ActiveYaml::Base do
 
-  describe ".all" do
-    it "loads the data from the yml file" do
-      class SomeArbitraryClass < ActiveYaml::Base
-        set_root_path File.dirname(__FILE__)
-        set_filename "sample"
-        field :name
+  before do
+    ActiveYaml::Base.set_root_path File.expand_path(File.dirname(__FILE__) + "/../fixtures")
+
+    class ArrayRow < ActiveYaml::Base
+    end
+
+    class City < ActiveYaml::Base
+    end
+
+    class State < ActiveYaml::Base
+    end
+  end
+
+  after do
+    Object.send :remove_const, :ArrayRow
+    Object.send :remove_const, :City
+    Object.send :remove_const, :State
+  end
+
+  describe ".raw_data" do
+
+    it "returns the raw hash data loaded from yaml hash-formatted files" do
+      City.raw_data.should be_kind_of(Hash)
+      City.raw_data.keys.should include("albany", "portland")
+    end
+
+    it "returns the raw array data loaded from yaml array-formatted files" do
+      ArrayRow.raw_data.should be_kind_of(Array)
+    end
+
+  end
+
+  describe ".load_file" do
+
+    describe "with array data" do
+      it "returns an array of hashes" do
+        ArrayRow.load_file.should be_kind_of(Array)
+        ArrayRow.load_file.should include({"name" => "Row 1", "id" => 1})
       end
+    end
 
-      records = SomeArbitraryClass.all
-      records.length.should == 3
-      records.should =~ [SomeArbitraryClass.new(:id => 1), SomeArbitraryClass.new(:id => 2), SomeArbitraryClass.new(:id => 3)]
-      records.first.name.should == "US"
+    describe "with hash data" do
+      it "returns an array of hashes" do
+        City.load_file.should be_kind_of(Array)
+        City.load_file.should include({"state" => :new_york, "name" => "Albany", "id" => 1})
+        City.all.should include( City.new(:id => 1) )
+      end
     end
+
   end
 
 end

data/spec/associations/associations_spec.rb

@@ -0,0 +1,102 @@
+require 'spec/spec_helper'
+
+describe ActiveHash::Base, "associations" do
+
+  before do
+    build_model :countries do
+    end
+
+    class City < ActiveHash::Base
+      field :country_id
+      include ActiveHash::Associations
+    end
+
+    class Author < ActiveHash::Base
+      include ActiveHash::Associations
+      field :publisher_id
+      field :city_id
+    end
+
+    build_model :books do
+      integer :author_id
+    end
+  end
+
+  after do
+    Object.send :remove_const, :Author
+  end
+
+  describe "#has_many" do
+
+    context "with ActiveRecord children" do
+      before do
+        @included_book_1  = Book.create! :author_id => 1
+        @included_book_2  = Book.create! :author_id => 1
+        @excluded_book    = Book.create! :author_id => 2
+      end
+
+      it "find the correct records" do
+        Author.has_many :books
+        author = Author.create :id => 1
+        author.books.should =~ [@included_book_1, @included_book_2]
+      end
+    end
+
+    context "with ActiveHash children" do
+      before do
+        @included_author_1  = Author.create :city_id => 1
+        @included_author_2  = Author.create :city_id => 1
+        @excluded_author    = Author.create :city_id => 2
+      end
+
+      it "find the correct records" do
+        City.has_many :authors
+        city = City.create :id => 1
+        city.authors.should =~ [@included_author_1, @included_author_2]
+      end
+
+      it "uses the correct class name when passed" do
+        City.has_many :writers, :class_name => "Author"
+        city = City.create :id => 1
+        city.writers.should =~ [@included_author_1, @included_author_2]
+      end
+    end
+
+  end
+
+  describe "#belongs_to" do
+
+    context "with an ActiveRecord parent" do
+      it "find the correct records" do
+        City.belongs_to :country
+        country = Country.create
+        city = City.create :country_id => country.id
+        city.country.should == country
+      end
+    end
+
+    context "with an ActiveHash parent" do
+      it "find the correct records" do
+        Author.belongs_to :city
+        city = City.create
+        author = Author.create :city_id => city.id
+        author.city.should == city
+      end
+    end
+
+    describe "#parent=" do
+      before do
+        Author.belongs_to :city
+        @city = City.create :id => 1
+      end
+
+      it "sets the underlying id of the parent" do
+        author = Author.new
+        author.city = @city
+        author.city_id.should == @city.id
+      end
+    end
+
+  end
+
+end

data/spec/fixtures/array_rows.yml

@@ -0,0 +1,4 @@
+- id: 1
+  name: Row 1
+- id: 2
+  name: Row 2

data/spec/fixtures/cities.yml

@@ -0,0 +1,8 @@
+albany:
+  id: 1
+  state: :new_york
+  name: Albany
+portland:
+  id: 2
+  state: Oregon
+  name: Portland

data/spec/fixtures/states.yml

@@ -0,0 +1,6 @@
+new_york:
+  id: 1
+  name: New York
+oregon:
+  id: 2
+  name: Oregon

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: active_hash
 version: !ruby/object:Gem::Version 
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors: 
 - Jeff Dean
@@ -48,10 +48,15 @@ files:
 - lib/active_hash.rb
 - lib/active_hash/base.rb
 - lib/active_yaml/base.rb
+- lib/associations/associations.rb
 - spec/active_file/base_spec.rb
 - spec/active_hash/base_spec.rb
 - spec/active_yaml/base_spec.rb
-- spec/active_yaml/sample.yml
+- spec/associations/associations_spec.rb
+- spec/fixtures/array_rows.yml
+- spec/fixtures/cities.yml
+- spec/fixtures/countries.yml
+- spec/fixtures/states.yml
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/zilkey/active_hash
@@ -77,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.3
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: An ActiveRecord-like model that uses a hash or file as a datasource
@@ -85,4 +90,5 @@ test_files:
 - spec/active_file/base_spec.rb
 - spec/active_hash/base_spec.rb
 - spec/active_yaml/base_spec.rb
+- spec/associations/associations_spec.rb
 - spec/spec_helper.rb