@@ -20,13 +20,13 @@ Download PassiveRecord from Github: http://github.com/artofmission/passive_recor
== Example
- class Name < PassiveRecord
- define_attributes [:first_name, :middle_name, :last_name]
+ class Name < PassiveRecord::Base
+ define_fields [:first_name, :middle_name, :last_name]
end
...will create a new Name model with id, address, and location attributes.
- class Person < PassiveRecord
+ class Person < PassiveRecord::Base
has_many :names
end
@@ -39,8 +39,8 @@ This would a Person object that has many names. You can now access the names has
You can serialize a PassiveRecord object into another database object for storage:
- class Address < PassiveRecord
- define_attributes [:street, :city, :state, :postal_code, :country]
+ class Address < PassiveRecord::Base
+ define_fields [:street, :city, :state, :postal_code, :country]
end
class Company < ActiveRecord
README.rdoc
@@ -1,5 +1,5 @@
# Include hook code here
require 'passive_record'
-# require 'define_attributes'
+# require 'define_fields'
# PassiveRecord.class_eval { include DefineAttributes }
init.rb
@@ -1,64 +1,67 @@
-class PassiveRecord
+module PassiveRecord
+ class Base
- # Assign values to each of the attributes passed in the params hash
- def initialize(params = {})
- params.each { |k, v| send("#{k}=", v)}
- end
+ # Assign values to each of the attributes passed in the params hash
+ def initialize(params = {})
+ params.each { |k, v| send("#{k}=", v)}
+ end
- # Date accessors to be consistent with ActiveRecord:
- attr_accessor :created_at, :updated_at
+ # Date accessors to be consistent with ActiveRecord:
+ attr_accessor :created_at, :updated_at
- # Return a hash of the class's attribute names and values
- # @name.attributes => {:first_name=>"Dima", :last_name=>"Dozen"}
- def attributes
- @attributes = {}
- self.class.attributes.flatten.each {|att| @attributes[att] = self.send(att) }
- @attributes
- end
+ # Return a hash of the class's attribute names and values
+ # @name.attributes => {:first_name=>"Dima", :last_name=>"Dozen"}
+ def attributes
+ @attributes = {}
+ self.class.fields.flatten.each {|att| @attributes[att] = self.send(att) }
+ @attributes
+ end
+ class_inheritable_accessor :fields
- # Compare this object with another object of the same class.
- # Returns true if the attributes and values are identical.
- # @name === @name #=> true
- # @name === @name2 #=> false
- def ===(other)
- self.attributes == other.attributes
- end
+ # Compare this object with another object of the same class.
+ # Returns true if the attributes and values are identical.
+ # @name === @name #=> true
+ # @name === @name2 #=> false
+ def ===(other)
+ self.attributes == other.attributes
+ end
- class << self
- # Provide some basic ActiveRecord-like methods for working with non-ActiveRecord objects
- # class Person < PassiveRecord
- # has_many :names, :addresses, :phone_numbers
- # end
- def has_many(*associations)
- # Simply sets up an attr_accessor for each item in the list
- @associations = associations
- associations.each {|association| attr_accessor association}
- end
+ class << self
+ # Provide some basic ActiveRecord-like methods for working with non-ActiveRecord objects
+ # class Person < PassiveRecord::Base
+ # has_many :names, :addresses, :phone_numbers
+ # end
+ def has_many(*associations)
+ # Simply sets up an attr_accessor for each item in the list
+ @associations = associations
+ associations.each {|association| attr_accessor association}
+ end
- # Creates instance methods for each item in the list. Expects an array
- # class Address < PassiveRecord
- # define_attributes [:street, :city, :state, :postal_code, :country]
- # end
- def define_attributes(attrs)
- @attributes = attrs
- # Assign attr_accessor for each attribute in the list
- attrs.each {|att| attr_accessor att}
- end
+ # Creates instance methods for each item in the list. Expects an array
+ # class Address < PassiveRecord::Base
+ # define_fields [:street, :city, :state, :postal_code, :country]
+ # end
+ def define_fields(attrs)
+ self.fields = attrs
+ # Assign attr_accessor for each attribute in the list
+ attrs.each {|att| attr_accessor att}
+ end
- # Return the list of available attributes for the class
- #
- # Name.attributes #=> [:id, :first_name, :last_name]
- def attributes
- @attributes
- end
+ # Return the list of available fields for the class
+ #
+ # Name.fields #=> [:id, :first_name, :last_name]
+ # def fields
+ # @fields
+ # end
- # Returns the list of available has_many associations
- #
- # Model.associations #=> [:names, :addresses]
- def associations
- @associations
+ # Returns the list of available has_many associations
+ #
+ # Model.associations #=> [:names, :addresses]
+ def associations
+ @associations
+ end
end
- end
+ end
end
\ No newline at end of file
lib/passive_record.rb
@@ -90,7 +90,7 @@
<a href="#M000007">associations</a>
<a href="#M000002">attributes</a>
<a href="#M000006">attributes</a>
- <a href="#M000005">define_attributes</a>
+ <a href="#M000005">define_fields</a>
<a href="#M000004">has_many</a>
<a href="#M000001">new</a>
</div>
@@ -204,7 +204,7 @@ href="PassiveRecord.html#M000002">attributes</a> for the class
<div class="method-heading">
<a href="#M000005" class="method-signature">
- <span class="method-name">define_attributes</span><span class="method-args">(attrs)</span>
+ <span class="method-name">define_fields</span><span class="method-args">(attrs)</span>
</a>
</div>
@@ -214,7 +214,7 @@ Creates instance methods for each item in the list. Expects an array
</p>
<pre>
class Address < PassiveRecord
- define_attributes [:street, :city, :state, :postal_code, :country]
+ define_fields [:street, :city, :state, :postal_code, :country]
end
</pre>
<p><a class="source-toggle" href="#"
@@ -222,7 +222,7 @@ Creates instance methods for each item in the list. Expects an array
<div class="method-source-code" id="M000005-source">
<pre>
<span class="ruby-comment cmt"># File lib/passive_record.rb, line 43</span>
-43: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">define_attributes</span>(<span class="ruby-identifier">attrs</span>)
+43: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">define_fields</span>(<span class="ruby-identifier">attrs</span>)
44: <span class="ruby-ivar">@attributes</span> = <span class="ruby-identifier">attrs</span>
45: <span class="ruby-comment cmt"># Assign attr_accessor for each attribute in the list</span>
46: <span class="ruby-identifier">attrs</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">att</span><span class="ruby-operator">|</span> <span class="ruby-identifier">attr_accessor</span> <span class="ruby-identifier">att</span>}
rdoc/classes/PassiveRecord.html
@@ -99,7 +99,7 @@ href="http://github.com/artofmission/passive_record">github.com/artofmission/pas
<h2>Example</h2>
<pre>
class Name < PassiveRecord
- define_attributes [:first_name, :middle_name, :last_name]
+ define_fields [:first_name, :middle_name, :last_name]
end
</pre>
<p>
@@ -127,7 +127,7 @@ database object for storage:
</p>
<pre>
class Address < PassiveRecord
- define_attributes [:street, :city, :state, :postal_code, :country]
+ define_fields [:street, :city, :state, :postal_code, :country]
end
class Company < ActiveRecord
rdoc/files/README_rdoc.html
@@ -24,7 +24,7 @@
<a href="classes/PassiveRecord.html#M000007">associations (PassiveRecord)</a><br />
<a href="classes/PassiveRecord.html#M000002">attributes (PassiveRecord)</a><br />
<a href="classes/PassiveRecord.html#M000006">attributes (PassiveRecord)</a><br />
- <a href="classes/PassiveRecord.html#M000005">define_attributes (PassiveRecord)</a><br />
+ <a href="classes/PassiveRecord.html#M000005">define_fields (PassiveRecord)</a><br />
<a href="classes/PassiveRecord.html#M000004">has_many (PassiveRecord)</a><br />
<a href="classes/PassiveRecord.html#M000001">new (PassiveRecord)</a><br />
</div>
rdoc/fr_method_index.html
98c8bc1da3ecd8a32b94eb98be44fa46c0e0858f
Ryan Heneise
ryan@artofmission.com
http://github.com/artofmission/passive_record/commit/9cfc9d324c2f888aa762fcbb8246a00f2954bc2c
9cfc9d324c2f888aa762fcbb8246a00f2954bc2c
2009-05-26T12:25:02-07:00
2009-05-26T12:25:02-07:00
Enabled subclass inheritance for PassiveRecord models. Now you can do things like FellowshipOne::Address < Address, and all the fields and attributes will be inherited.
56dedee3b994055a894c9943dccf55b414a241e3
Ryan Heneise
ryan@artofmission.com