coded_attribute 0.0.3 → 0.0.4

data/Manifest

@@ -1,41 +1,20 @@
 MIT-LICENSE
 Manifest
 README
+README.rdoc
 Rakefile
-coded_attribute.gemspec
 init.rb
 install.rb
 lib/coded_attribute.rb
-rdoc/CodedAttributes.html
-rdoc/README.html
+rdoc/classes/CodedAttribute.html
 rdoc/created.rid
-rdoc/images/brick.png
-rdoc/images/brick_link.png
-rdoc/images/bug.png
-rdoc/images/bullet_black.png
-rdoc/images/bullet_toggle_minus.png
-rdoc/images/bullet_toggle_plus.png
-rdoc/images/date.png
-rdoc/images/find.png
-rdoc/images/loadingAnimation.gif
-rdoc/images/macFFBgHack.png
-rdoc/images/package.png
-rdoc/images/page_green.png
-rdoc/images/page_white_text.png
-rdoc/images/page_white_width.png
-rdoc/images/plugin.png
-rdoc/images/ruby.png
-rdoc/images/tag_green.png
-rdoc/images/wrench.png
-rdoc/images/wrench_orange.png
-rdoc/images/zoom.png
+rdoc/files/README.html
+rdoc/files/lib/coded_attribute_rb.html
+rdoc/fr_class_index.html
+rdoc/fr_file_index.html
+rdoc/fr_method_index.html
 rdoc/index.html
-rdoc/js/darkfish.js
-rdoc/js/jquery.js
-rdoc/js/quicksearch.js
-rdoc/js/thickbox-compressed.js
-rdoc/lib/coded_attributes_rb.html
-rdoc/rdoc.css
+rdoc/rdoc-style.css
 test/coded_attributes_test.rb
 test/test_helper.rb
 uninstall.rb

data/README

@@ -1,13 +1,89 @@
-CodedAttributes
-===============
+=CodedAttribute
 
-Introduction goes here.
+Two of my favorite MySQL datatypes are ENUMs and SETs. Unfortunately,
+ActiveRecord doesn't appear to support these fields well, or provide a good
+and simple alternative to the problem of coded values. In the past, I used to
+write getters and setters that looked something like this to solve my problem.
 
+  class Article
+    STATUS_CODES => {
+        :deleted => 0, 0 => :deleted
+        :pending => 1, 1 => :pending,
+      :completed => 2, 2 => :completed,
+      :published => 3, 3 => :published
+    }
 
-Example
-=======
+    def status=(value)
+      value = value.to_sym if value.is_a?(String)
+      status_code = STATUS_CODES[value]
+    end
+  
+    def status
+      STATUS_CODES[status_code]
+    end
+  end
 
-Example goes here.
+Doesn't that code look horrible? Wouldn't it be better if it looked like this?!
 
+  class Article
+    coded_attribute :status {
+      0 => :deleted
+      1 => :pending
+      2 => :completed
+      3 => :published
+    end
+  end
 
-Copyright (c) 2010 [name of plugin creator], released under the MIT license
+Or, if we want to get even lazier!
+
+  class MyClass
+    coded_attribute :status, [ :deleted, :active, :pending, :deleted ]
+  end
+
+If so, then you've come to the right place.
+
+This plugin makes doing all of the above super easy. And your code (and other
+programmers) will love you for using it! Like seriously love you!
+
+==Coded Attributes
+
+Lets get down to it. Suppose we have a car, and it can be any one of a variety
+of colors. We can indicate this in the model with the following code:
+
+  class Car < ActiveRecord::Base
+    coded_attribute :color, [ :red, :orange, :yellow, :green, :blue, :indigo, :violet ]
+  end
+
+But we aren't finished just yet. We still need to create a column to store our
+attribute data in. There are two ways to go about this.
+
+===Storing the Coded Value
+
+The easiest way to store the coded value is to create an integer column in the
+database by appending '_code' to the name of the attribute. So in our 'cars'
+table, we could create a 'color_code' integer field. If you do not want to
+name the column in your database 'color_code', you can replace :color, with a
+:method => :column pair, for example:
+
+  class Car < ActiveRecord::Base
+    coded_attribute :color => :color_id, [ :red, orange, :yellow, :green, :blue, :indigo, :violet ]
+  end
+
+==Coded Attribute Sets
+
+If you do not want to use a SET datatype, coded_attribute_set an make use of an
+integer bitmask to store the values.
+
+  class Car < ActiveRecord::Base
+    coded_attribute_set :color, [ :red, :orange, :yellow, :green, :blue, :indigo, :violet ]
+  end
+
+=Planned Features
+
+Future versions should hopefully support auto-detecting and setup of enum and
+set types (so you don't need to even define the coded_attribute, it will be
+done automatically on all classes). 
+
+I also plan on a method added to Migrations that allow you to easily recode data
+
+Copyright (c) 2010 Jaden Carver, released under the MIT license

data/README.rdoc

@@ -0,0 +1,89 @@
+=CodedAttribute
+
+Two of my favorite MySQL datatypes are ENUMs and SETs. Unfortunately,
+ActiveRecord doesn't appear to support these fields well, or provide a good
+and simple alternative to the problem of coded values. In the past, I used to
+write getters and setters that looked something like this to solve my problem.
+
+  class Article
+    STATUS_CODES => {
+        :deleted => 0, 0 => :deleted
+        :pending => 1, 1 => :pending,
+      :completed => 2, 2 => :completed,
+      :published => 3, 3 => :published
+    }
+
+    def status=(value)
+      value = value.to_sym if value.is_a?(String)
+      status_code = STATUS_CODES[value]
+    end
+  
+    def status
+      STATUS_CODES[status_code]
+    end
+  end
+
+Doesn't that code look horrible? Wouldn't it be better if it looked like this?!
+
+  class Article
+    coded_attribute :status {
+      0 => :deleted
+      1 => :pending
+      2 => :completed
+      3 => :published
+    end
+  end
+
+Or, if we want to get even lazier!
+
+  class MyClass
+    coded_attribute :status, [ :deleted, :active, :pending, :deleted ]
+  end
+
+If so, then you've come to the right place.
+
+This plugin makes doing all of the above super easy. And your code (and other
+programmers) will love you for using it! Like seriously love you!
+
+==Coded Attributes
+
+Lets get down to it. Suppose we have a car, and it can be any one of a variety
+of colors. We can indicate this in the model with the following code:
+
+  class Car < ActiveRecord::Base
+    coded_attribute :color, [ :red, :orange, :yellow, :green, :blue, :indigo, :violet ]
+  end
+
+But we aren't finished just yet. We still need to create a column to store our
+attribute data in. There are two ways to go about this.
+
+===Storing the Coded Value
+
+The easiest way to store the coded value is to create an integer column in the
+database by appending '_code' to the name of the attribute. So in our 'cars'
+table, we could create a 'color_code' integer field. If you do not want to
+name the column in your database 'color_code', you can replace :color, with a
+:method => :column pair, for example:
+
+  class Car < ActiveRecord::Base
+    coded_attribute :color => :color_id, [ :red, orange, :yellow, :green, :blue, :indigo, :violet ]
+  end
+
+==Coded Attribute Sets
+
+If you do not want to use a SET datatype, coded_attribute_set an make use of an
+integer bitmask to store the values.
+
+  class Car < ActiveRecord::Base
+    coded_attribute_set :color, [ :red, :orange, :yellow, :green, :blue, :indigo, :violet ]
+  end
+
+=Planned Features
+
+Future versions should hopefully support auto-detecting and setup of enum and
+set types (so you don't need to even define the coded_attribute, it will be
+done automatically on all classes). 
+
+I also plan on a method added to Migrations that allow you to easily recode data
+
+Copyright (c) 2010 Jaden Carver, released under the MIT license

data/Rakefile

@@ -7,13 +7,14 @@ require 'rake/rdoctask'
 desc 'Default: run unit tests.'
 task :default => :test
 
-Echoe.new('coded_attribute', '0.0.3') do |p|
+Echoe.new('coded_attribute', '0.0.4') do |p|
   p.description = "ActiveRecord plugin for storing coded variables"
-  p.url = "http://github.com/windigo77/coded_attribute"
+  p.url = "http://github.com/windigo/coded_attribute"
   p.author = "Jaden Carver"
   p.email = "jaden.carver@gmail.com"
   p.ignore_pattern = ["tmp/*", "script/*"]
-  p.development_dependencies = []
+  p.development_dependencies = [ "activerecord >=3.0.0" ]
+  p.runtime_dependencies = [ "activerecord >=3.0.0" ]
 end
 
 desc 'Test the coded_attributes plugin.'

data/coded_attribute.gemspec

@@ -2,30 +2,36 @@
 
 Gem::Specification.new do |s|
   s.name = %q{coded_attribute}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jaden Carver"]
-  s.date = %q{2010-11-06}
+  s.date = %q{2010-11-10}
   s.description = %q{ActiveRecord plugin for storing coded variables}
   s.email = %q{jaden.carver@gmail.com}
-  s.extra_rdoc_files = ["README", "lib/coded_attribute.rb"]
-  s.files = ["MIT-LICENSE", "Manifest", "README", "Rakefile", "coded_attribute.gemspec", "init.rb", "install.rb", "lib/coded_attribute.rb", "rdoc/CodedAttributes.html", "rdoc/README.html", "rdoc/created.rid", "rdoc/images/brick.png", "rdoc/images/brick_link.png", "rdoc/images/bug.png", "rdoc/images/bullet_black.png", "rdoc/images/bullet_toggle_minus.png", "rdoc/images/bullet_toggle_plus.png", "rdoc/images/date.png", "rdoc/images/find.png", "rdoc/images/loadingAnimation.gif", "rdoc/images/macFFBgHack.png", "rdoc/images/package.png", "rdoc/images/page_green.png", "rdoc/images/page_white_text.png", "rdoc/images/page_white_width.png", "rdoc/images/plugin.png", "rdoc/images/ruby.png", "rdoc/images/tag_green.png", "rdoc/images/wrench.png", "rdoc/images/wrench_orange.png", "rdoc/images/zoom.png", "rdoc/index.html", "rdoc/js/darkfish.js", "rdoc/js/jquery.js", "rdoc/js/quicksearch.js", "rdoc/js/thickbox-compressed.js", "rdoc/lib/coded_attributes_rb.html", "rdoc/rdoc.css", "test/coded_attributes_test.rb", "test/test_helper.rb", "uninstall.rb"]
-  s.homepage = %q{http://github.com/windigo77/coded_attribute}
+  s.extra_rdoc_files = ["README", "README.rdoc", "lib/coded_attribute.rb"]
+  s.files = ["MIT-LICENSE", "Manifest", "README", "README.rdoc", "Rakefile", "init.rb", "install.rb", "lib/coded_attribute.rb", "rdoc/classes/CodedAttribute.html", "rdoc/created.rid", "rdoc/files/README.html", "rdoc/files/lib/coded_attribute_rb.html", "rdoc/fr_class_index.html", "rdoc/fr_file_index.html", "rdoc/fr_method_index.html", "rdoc/index.html", "rdoc/rdoc-style.css", "test/coded_attributes_test.rb", "test/test_helper.rb", "uninstall.rb", "coded_attribute.gemspec"]
+  s.homepage = %q{http://github.com/windigo/coded_attribute}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Coded_attribute", "--main", "README"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{coded_attribute}
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{ActiveRecord plugin for storing coded variables}
-  s.test_files = ["test/test_helper.rb", "test/coded_attributes_test.rb"]
+  s.test_files = ["test/coded_attributes_test.rb", "test/test_helper.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 3.0.0"])
+      s.add_development_dependency(%q<activerecord>, [">= 3.0.0"])
     else
+      s.add_dependency(%q<activerecord>, [">= 3.0.0"])
+      s.add_dependency(%q<activerecord>, [">= 3.0.0"])
     end
   else
+    s.add_dependency(%q<activerecord>, [">= 3.0.0"])
+    s.add_dependency(%q<activerecord>, [">= 3.0.0"])
   end
 end

data/lib/coded_attribute.rb

@@ -1,34 +1,30 @@
 # CodedAttributes
 
 module CodedAttribute
-  VERSION = 0.1
 
-  def coded_attribute(method, *attribute_or_codes)
-    if [String,Symbol].include?(attribute_or_codes.first.class)
-      attribute = attribute_or_codes.shift
-    else
-      attribute = :"#{method}_code"
+  def coded_attribute(*attributes_and_codes)
+    if attributes_and_codes.last.is_a? Hash
+      codes = attributes_and_codes.pop
+    elsif attributes_and_codes.last.is_a? Array
+      codes = attributes_and_codes.pop.inject({}) { |h, v| h.merge! h.keys.count => v }
     end
 
-    if attribute_or_codes.first.class == Hash
-      codes = attribute_or_codes.shift
-      raise ArgumentError, "Too many arguments" unless attribute_or_codes.blank?
-    elsif attribute_or_codes.first.class == Array
-      codes = attribute_or_codes.shift.inject({}) { |h, v| h.merge! h.keys.count => v }
-      raise ArgumentError, "Too many arguments" unless attribute_or_codes.blank?
-    else
-      codes = attribute_or_codes.inject({}) { |h, v| h.merge! h.keys.count => v }
+    attributes = attributes_and_codes.inject({}) do |hash, attribute|
+      hash.merge! attribute.is_a? Hash ? attribute :  { attribute => "#{attribute}_code" }
     end
 
-    class_variable_set :"@@#{method}_codes", codes
-    cattr_reader :"#{method}_codes"
+    attributes.each_pair do |method, attribute|
+      class_variable_set :"@@#{method}_codes", codes
+      cattr_reader :"#{method}_codes"
 
-    define_method :"#{method}" do
-      self.class.class_variable_get("@@#{method}_codes")[read_attribute(attribute)]
-    end
+      define_method :"#{method}" do
+        self.class.class_variable_get("@@#{method}_codes")[read_attribute(attribute)]
+      end
+
+      define_method :"#{method}=" do |value|
+        write_attribute(attribute, self.class.class_variable_get("@@#{method}_codes").key(value.to_sym))
+      end
+    end # attributes.each_pair
+  end # def coded_attribute
 
-    define_method :"#{method}=" do |value|
-      write_attribute(attribute, self.class.class_variable_get("@@#{method}_codes").key(value.to_sym))
-    end
-  end # def coded
 end # module CodedAttributes

data/rdoc/classes/CodedAttribute.html

@@ -0,0 +1,167 @@
+<?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>Module: CodedAttribute</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="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">CodedAttribute</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/coded_attribute_rb.html">
+                lib/coded_attribute.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+CodedAttributes
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000001">coded_attribute</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000001" class="method-detail">
+        <a name="M000001"></a>
+
+        <div class="method-heading">
+          <a href="#M000001" class="method-signature">
+          <span class="method-name">coded_attribute</span><span class="method-args">(*attributes_and_codes)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000001-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/coded_attribute.rb, line 5</span>
+ 5:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">coded_attribute</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">attributes_and_codes</span>)
+ 6:     <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">attributes_and_codes</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Hash</span>
+ 7:       <span class="ruby-identifier">codes</span> = <span class="ruby-identifier">attributes_and_codes</span>.<span class="ruby-identifier">pop</span>
+ 8:     <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">attributes_and_codes</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Array</span>
+ 9:       <span class="ruby-identifier">codes</span> = <span class="ruby-identifier">attributes_and_codes</span>.<span class="ruby-identifier">pop</span>.<span class="ruby-identifier">inject</span>({}) { <span class="ruby-operator">|</span><span class="ruby-identifier">h</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">h</span>.<span class="ruby-identifier">merge!</span> <span class="ruby-identifier">h</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">count</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">v</span> }
+10:     <span class="ruby-keyword kw">end</span>
+11: 
+12:     <span class="ruby-identifier">attributes</span> = <span class="ruby-identifier">attributes_and_codes</span>.<span class="ruby-identifier">inject</span>({}) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">hash</span>, <span class="ruby-identifier">attribute</span><span class="ruby-operator">|</span>
+13:       <span class="ruby-identifier">hash</span>.<span class="ruby-identifier">merge!</span> <span class="ruby-identifier">attribute</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Hash</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">attribute</span> <span class="ruby-operator">:</span>  { <span class="ruby-identifier">attribute</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;#{attribute}_code&quot;</span> }
+14:     <span class="ruby-keyword kw">end</span>
+15: 
+16:     <span class="ruby-identifier">attributes</span>.<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">method</span>, <span class="ruby-identifier">attribute</span><span class="ruby-operator">|</span>
+17:       <span class="ruby-identifier">class_variable_set</span> <span class="ruby-node">&quot;@@#{method}_codes&quot;</span><span class="ruby-node">&quot;@@#{method}_codes&quot;</span>, <span class="ruby-identifier">codes</span>
+18:       <span class="ruby-identifier">cattr_reader</span> <span class="ruby-node">&quot;#{method}_codes&quot;</span><span class="ruby-node">&quot;#{method}_codes&quot;</span>
+19: 
+20:       <span class="ruby-identifier">define_method</span> <span class="ruby-node">&quot;#{method}&quot;</span><span class="ruby-node">&quot;#{method}&quot;</span> <span class="ruby-keyword kw">do</span>
+21:         <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">class_variable_get</span>(<span class="ruby-node">&quot;@@#{method}_codes&quot;</span>)[<span class="ruby-identifier">read_attribute</span>(<span class="ruby-identifier">attribute</span>)]
+22:       <span class="ruby-keyword kw">end</span>
+23: 
+24:       <span class="ruby-identifier">define_method</span> <span class="ruby-node">&quot;#{method}=&quot;</span><span class="ruby-node">&quot;#{method}=&quot;</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
+25:         <span class="ruby-identifier">write_attribute</span>(<span class="ruby-identifier">attribute</span>, <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">class_variable_get</span>(<span class="ruby-node">&quot;@@#{method}_codes&quot;</span>).<span class="ruby-identifier">key</span>(<span class="ruby-identifier">value</span>.<span class="ruby-identifier">to_sym</span>))
+26:       <span class="ruby-keyword kw">end</span>
+27:     <span class="ruby-keyword kw">end</span> <span class="ruby-comment cmt"># attributes.each_pair</span>
+28:   <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>