RubyGems - acts_as_eav_model - Versions diffs - 0.0.0 - Mend

acts_as_eav_model 0.0.0

Files changed (80) hide show

data/.rvmrc +1 -0
data/CHANGELOG +3 -0
data/Gemfile +13 -0
data/Gemfile.lock +92 -0
data/MIT-LICENSE +20 -0
data/README.rdoc +117 -0
data/Rakefile +46 -0
data/SPECDOC +23 -0
data/TODO +0 -0
data/VERSION +1 -0
data/doc/classes/ActiveRecord/Acts/EavModel.html +213 -0
data/doc/classes/ActiveRecord/Acts/EavModel/ClassMethods.html +343 -0
data/doc/classes/ActiveRecord/Acts/EavModel/InstanceMethods.html +474 -0
data/doc/classes/ActiveRecord/Acts/EavModel/InstanceMethods/ClassMethods.html +192 -0
data/doc/classes/ActiveRecord/Base.html +170 -0
data/doc/created.rid +1 -0
data/doc/files/CHANGELOG.html +113 -0
data/doc/files/MIT-LICENSE.html +129 -0
data/doc/files/README_rdoc.html +248 -0
data/doc/files/SPECDOC.html +170 -0
data/doc/files/lib/acts_as_eav_model_rb.html +101 -0
data/doc/fr_class_index.html +31 -0
data/doc/fr_file_index.html +31 -0
data/doc/fr_method_index.html +40 -0
data/doc/index.html +24 -0
data/doc/rdoc-style.css +208 -0
data/init.rb +1 -0
data/install.rb +1 -0
data/lib/acts_as_eav_model.rb +542 -0
data/spec/dummy/Rakefile +7 -0
data/spec/dummy/app/controllers/application_controller.rb +3 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/models/document.rb +7 -0
data/spec/dummy/app/models/person.rb +13 -0
data/spec/dummy/app/models/person_contact_info.rb +2 -0
data/spec/dummy/app/models/post.rb +4 -0
data/spec/dummy/app/models/post_attribute.rb +2 -0
data/spec/dummy/app/models/preference.rb +5 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/config/application.rb +45 -0
data/spec/dummy/config/boot.rb +10 -0
data/spec/dummy/config/database.yml +22 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +26 -0
data/spec/dummy/config/environments/production.rb +49 -0
data/spec/dummy/config/environments/test.rb +35 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/inflections.rb +10 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/secret_token.rb +7 -0
data/spec/dummy/config/initializers/session_store.rb +8 -0
data/spec/dummy/config/locales/en.yml +5 -0
data/spec/dummy/config/routes.rb +58 -0
data/spec/dummy/db/development.sqlite3 +0 -0
data/spec/dummy/db/schema.rb +51 -0
data/spec/dummy/public/404.html +26 -0
data/spec/dummy/public/422.html +26 -0
data/spec/dummy/public/500.html +26 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/dummy/public/javascripts/application.js +2 -0
data/spec/dummy/public/javascripts/controls.js +965 -0
data/spec/dummy/public/javascripts/dragdrop.js +974 -0
data/spec/dummy/public/javascripts/effects.js +1123 -0
data/spec/dummy/public/javascripts/prototype.js +6001 -0
data/spec/dummy/public/javascripts/rails.js +175 -0
data/spec/dummy/public/stylesheets/.gitkeep +0 -0
data/spec/dummy/script/rails +6 -0
data/spec/fixtures/people.yml +4 -0
data/spec/fixtures/person_contact_infos.yml +10 -0
data/spec/fixtures/post_attributes.yml +15 -0
data/spec/fixtures/posts.yml +9 -0
data/spec/fixtures/preferences.yml +10 -0
data/spec/models/eav_model_with_no_arguments_spec.rb +82 -0
data/spec/models/eav_model_with_options_spec.rb +37 -0
data/spec/models/eav_validation_spec.rb +11 -0
data/spec/schema.rb +50 -0
data/spec/spec_helper.rb +38 -0
data/uninstall.rb +1 -0
metadata +213 -0

@@ -0,0 +1,129 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: MIT-LICENSE</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+  <div id="fileHeader">
+    <h1>MIT-LICENSE</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>MIT-LICENSE
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Thu Dec 18 13:10:57 +1300 2008</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+Copyright (c) 2008 Marcus Wyatt
+</p>
+<p>
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+&quot;Software&quot;), 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:
+</p>
+<p>
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+</p>
+<p>
+THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, 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.
+</p>
+    </div>
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/files/README_rdoc.html ADDED

@@ -0,0 +1,248 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: README.rdoc</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+  <div id="fileHeader">
+    <h1>README.rdoc</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>README.rdoc
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Thu Dec 18 11:13:37 +1300 2008</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+ActsAsEavModel
+</p>
+<h6>========</h6>
+<p>
+ActsAsEavModel allow for the Entity-attribute-value model (EAV), also known
+as object-attribute-value model and open schema on any of your ActiveRecord
+models.
+</p>
+<h1>What is Entity-attribute-value model?</h1>
+<p>
+Entity-attribute-value model (EAV) is a data model that is used in
+circumstances where the number of attributes (properties, parameters) that
+can be used to describe a thing (an &quot;entity&quot; or
+&quot;object&quot;) is potentially very vast, but the number that will
+actually apply to a given entity is relatively modest.
+</p>
+<h1>Typical Problem</h1>
+<p>
+A good example of this is where you need to store lots (possible hundreds)
+of optional attributes on an object. My typical reference example is when
+you have a User object. You want to store the user&#8216;s preferences
+between sessions. Every search, sort, etc in your application you want to
+keep track of so when the user visits that section of the application again
+you can simply restore the display to how it was.
+</p>
+<p>
+So your controller might have:
+</p>
+<pre>
+  Project.find :all, :conditions =&gt; current_user.project_search,
+    :order =&gt; current_user.project_order
+</pre>
+<p>
+But there could be hundreds of these little attributes that you really
+don&#8216;t want to store directly on the user object. It would make your
+table have too many columns so it would be too much of a pain to deal with.
+Also there might be performance problems. So instead you might do something
+like this:
+</p>
+<pre>
+  class User &lt; ActiveRecord::Base
+    has_many :preferences
+  end
+  class Preferences &lt; ActiveRecord::Base
+    belongs_to :user
+  end
+</pre>
+<p>
+Now simply give the Preference model a &quot;name&quot; and
+&quot;value&quot; column and you are set.&#8230;. except this is now too
+complicated. To retrieve a attribute you will need to do something like:
+</p>
+<pre>
+  Project.find :all,
+    :conditions =&gt; current_user.preferences.find_by_name('project_search').value,
+    :order =&gt; current_user.preferences.find_by_name('project_order').value
+</pre>
+<p>
+Sure you could fix this through a few methods on your model. But what about
+saving?
+</p>
+<pre>
+  current_user.preferences.create :name =&gt; 'project_search',
+    :value =&gt; &quot;lastname LIKE 'jones%'&quot;
+  current_user.preferences.create :name =&gt; 'project_order',
+    :value =&gt; &quot;name&quot;
+</pre>
+<p>
+Again this seems to much. Again we could add some methods to our model to
+make this simpler but do we want to do this on every model. NO! So instead
+we use this plugin which does everything for us.
+</p>
+<h1>Capabilities</h1>
+<p>
+The ActsAsEavModel plugin is capable of modeling this problem in a
+intuitive way. Instead of having to deal with a related model you treat all
+attributes (both on the model and related) as if they are all on the model.
+The plugin will try to save all attributes to the model (normal
+ActiveRecord behavior) but if there is no column for an attribute it will
+try to save it to a related model whose purpose is to store these many
+sparsely populated attributes.
+</p>
+<p>
+The main design goals are:
+</p>
+<ul>
+<li>Have the eav attributes feel like normal attributes. Simple gets and sets
+will add and remove records from the related model.
+</li>
+<li>Allow for more than one related model. So for example on my User model I
+might have some eav behavior going into a contact_info table while others
+are going in a user_preferences table.
+</li>
+<li>Allow a model to determine what a valid eav attribute is for a given
+related model so our model still can generate a NoMethodError.
+</li>
+</ul>
+<p>
+Example
+</p>
+<h6>=</h6>
+<p>
+Will make the current class have eav behaviour.
+</p>
+<pre>
+  class Post &lt; ActiveRecord::Base
+    has_eav_behavior
+  end
+  post = Post.find_by_title 'hello world'
+  puts &quot;My post intro is: #{post.intro}&quot;
+  post.teaser = 'An awesome introduction to the blog'
+  post.save
+</pre>
+<p>
+The above example should work even though &quot;intro&quot; and
+&quot;teaser&quot; are not attributes on the Post model.
+</p>
+<h1>Installation</h1>
+<pre>
+    ./script/plugin install acts_as_eav_model
+</pre>
+<h1>RUNNING UNIT TESTS</h1>
+<h2>Creating the test database</h2>
+<p>
+The test databases will be created from the info specified in
+test/database.yml. Either change that file to match your database or change
+your database to match that file.
+</p>
+<h2>Running with Rake</h2>
+<p>
+The easiest way to run the unit tests is through Rake. By default sqlite3
+will be the database run. Just change your env variable DB to be the
+database adaptor (specified in database.yml) that you want to use. The
+database and permissions must already be setup but the tables will be
+created for you from schema.rb.
+</p>
+<p>
+Copyright (c) 2008 Marcus Wyatt, released under the MIT license
+</p>
+    </div>
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/files/SPECDOC.html ADDED

@@ -0,0 +1,170 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: SPECDOC</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+  <div id="fileHeader">
+    <h1>SPECDOC</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>SPECDOC
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Thu Dec 18 13:47:02 +1300 2008</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+ActiveRecord Model annotated with &#8216;has_eav_behavior&#8217; with no
+options in declaration
+</p>
+<ul>
+<li>should have many attributes
+</li>
+<li>should create new attribute on save
+</li>
+<li>should delete attribute
+</li>
+<li>should write eav attributes to attributes table
+</li>
+<li>should return nil when attribute does not exist
+</li>
+<li>should use method missing to make attribute seem as native property
+</li>
+<li>should read attributes using subscript notation
+</li>
+<li>should read the attribute when invoking &#8216;read_attribute&#8216;
+</li>
+</ul>
+<p>
+ActiveRecord Model annotated with &#8216;has_eav_behavior&#8217; with
+options in declaration
+</p>
+<ul>
+<li>should be &#8216;has_many&#8217; association on both sides
+</li>
+<li>should only allow restricted fields when specified (:fields =&gt; %w(phone
+aim icq))
+</li>
+<li>should raise &#8216;NoMethodError&#8217; when attribute not in
+&#8216;eav_attributes&#8217; method array
+</li>
+<li>should raise &#8216;NoMethodError&#8217; when attribute does not satisfy
+&#8216;is_eav_attribute?&#8217; method
+</li>
+</ul>
+<p>
+Validations on ActiveRecord Model annotated with
+&#8216;has_eav_behavior&#8216;
+</p>
+<ul>
+<li>should execute as normal (validates_presence_of)
+</li>
+</ul>
+<p>
+Finished in 0.239663 seconds
+</p>
+<p>
+13 examples, 0 failures
+</p>
+    </div>
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>