renum 1.0.1 → 1.0.2

data/History.txt

@@ -1,3 +1,8 @@
+== 1.0.2 2008-11-07
+
+* Documentation updates regarding Rails integration
+* Tiny typo fix in specs
+
 == 1.0.0 2008-01-25
 
 * New fancy syntax supporting extra member variables in enums

data/lib/renum/version.rb

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

data/spec/renum_spec.rb

@@ -92,7 +92,7 @@ describe "enum with no values array and values declared in the block" do
     lambda { Size.ExtraLarge() }.should raise_error(NoMethodError)
   end
   
-  it "supprts there being no extra data and no init() method defined, if you don't need them" do
+  it "supports there being no extra data and no init() method defined, if you don't need them" do
     HairColor::BLONDE.name.should == "BLONDE"
   end
 end

data/website/index.html

@@ -33,7 +33,7 @@
     <h1>renum</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/renum"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/renum" class="numbers">1.0.0</a>
+      <a href="http://rubyforge.org/projects/renum" class="numbers">1.0.2</a>
     </div>
     <p>Renum provides a readable but terse enum facility for Ruby.  Enums are sometimes called object constants and are analogous to the type-safe enum pattern in Java, though obviously Ruby&#8217;s flexibility means there&#8217;s no such thing as type-safety.</p>
 
@@ -117,6 +117,46 @@
 <span class="keyword">end</span></pre></p>
 
 
+	<h2><a href="http://www.rubyonrails.com/">Rails</a> Integration</h2>
+
+
+	<p>To use enumerated values as ActiveRecord attribute values, <a href="https://github.com/duelinmarkers/constantize_attribute/tree">use the constantize_attribute plugin</a> (also by me).</p>
+
+
+	<p><pre class='syntax'><span class="keyword">class </span><span class="class">Vehicle</span> <span class="punct">&lt;</span> <span class="constant">ActiveRecord</span><span class="punct">::</span><span class="constant">Base</span>
+  <span class="ident">enum</span> <span class="symbol">:Status</span> <span class="keyword">do</span>
+    <span class="constant">New</span><span class="punct">()</span>
+    <span class="constant">Used</span><span class="punct">()</span>
+    <span class="constant">Salvage</span><span class="punct">(</span><span class="constant">true</span><span class="punct">)</span>
+    
+    <span class="keyword">def </span><span class="method">init</span><span class="punct">(</span><span class="ident">warn</span> <span class="punct">=</span> <span class="constant">false</span><span class="punct">)</span>
+      <span class="attribute">@warn</span> <span class="punct">=</span> <span class="ident">warn</span>
+    <span class="keyword">end</span>
+    
+    <span class="keyword">def </span><span class="method">requires_warning_buyer?</span>
+      <span class="attribute">@warn</span>
+    <span class="keyword">end</span>
+  <span class="keyword">end</span>
+  
+  <span class="ident">constantize_attribute</span> <span class="symbol">:status</span>
+  
+<span class="keyword">end</span>
+
+<span class="ident">v</span> <span class="punct">=</span> <span class="constant">Vehicle</span><span class="punct">.</span><span class="ident">create!</span> <span class="symbol">:status</span> <span class="punct">=&gt;</span> <span class="constant">Vehicle</span><span class="punct">::</span><span class="constant">Status</span><span class="punct">::</span><span class="constant">New</span>
+<span class="comment"># Now the database has the string &quot;Vehicle::Status::New&quot;,</span>
+<span class="comment"># but your record object exposes the Status object:</span>
+<span class="ident">v</span><span class="punct">.</span><span class="ident">status</span><span class="punct">.</span><span class="ident">requires_warning_buyer?</span>          <span class="comment"># =&gt; false</span>
+
+<span class="ident">v</span><span class="punct">.</span><span class="ident">update_attribute</span> <span class="symbol">:status</span><span class="punct">,</span> <span class="constant">Vehicle</span><span class="punct">::</span><span class="constant">Status</span><span class="punct">::</span><span class="constant">Salvage</span>
+<span class="comment"># Now the database has the string &quot;Vehicle::Status::Salvage&quot;.</span>
+<span class="ident">v</span><span class="punct">.</span><span class="ident">status</span><span class="punct">.</span><span class="ident">requires_warning_buyer?</span>          <span class="comment"># =&gt; true</span>
+
+<span class="comment"># Since constantize_attribute also accepts strings, it's easy</span>
+<span class="comment"># to use enumerated values with forms.</span>
+<span class="ident">v</span><span class="punct">.</span><span class="ident">status</span> <span class="punct">=</span> <span class="punct">&quot;</span><span class="string">Vehicle::Status::Used</span><span class="punct">&quot;</span>
+<span class="ident">v</span><span class="punct">.</span><span class="ident">status</span><span class="punct">.</span><span class="ident">requires_warning_buyer?</span>          <span class="comment"># =&gt; false</span></pre></p>
+
+
 	<h2>License</h2>
 
 
@@ -128,7 +168,7 @@
 
 	<p>Renum was created by John D. Hume. Comments are welcome. Send an email to duelin dot markers at gmail or <a href="http://elhumidor.blogspot.com/">contact me via my blog</a>.</p>
     <p class="coda">
-      <a href="http://elhumidor.blogspot.com/">John D. Hume</a>, 25th January 2008<br>
+      <a href="http://elhumidor.blogspot.com/">John D. Hume</a>, 7th November 2008<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -74,6 +74,43 @@ Giving you something that satisfies this spec, plus a bit more:
   
 end</pre>
 
+h2. "Rails":http://www.rubyonrails.com/ Integration
+
+To use enumerated values as ActiveRecord attribute values, "use the constantize_attribute plugin":https://github.com/duelinmarkers/constantize_attribute/tree (also by me).
+
+<pre syntax="ruby">class Vehicle < ActiveRecord::Base
+  enum :Status do
+    New()
+    Used()
+    Salvage(true)
+    
+    def init(warn = false)
+      @warn = warn
+    end
+    
+    def requires_warning_buyer?
+      @warn
+    end
+  end
+  
+  constantize_attribute :status
+  
+end
+
+v = Vehicle.create! :status => Vehicle::Status::New
+# Now the database has the string "Vehicle::Status::New",
+# but your record object exposes the Status object:
+v.status.requires_warning_buyer?          # => false
+
+v.update_attribute :status, Vehicle::Status::Salvage
+# Now the database has the string "Vehicle::Status::Salvage".
+v.status.requires_warning_buyer?          # => true
+
+# Since constantize_attribute also accepts strings, it's easy
+# to use enumerated values with forms.
+v.status = "Vehicle::Status::Used"
+v.status.requires_warning_buyer?          # => false</pre>
+
 h2. License
 
 This code is free to use under the terms of the MIT license. 
@@ -81,4 +118,3 @@ This code is free to use under the terms of the MIT license.
 h2. Contact
 
 Renum was created by John D. Hume. Comments are welcome. Send an email to duelin dot markers at gmail or "contact me via my blog":http://elhumidor.blogspot.com/.
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: renum
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - John Hume
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-05-15 00:00:00 -04:00
+date: 2008-11-07 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -77,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: renum
-rubygems_version: 1.0.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Renum is a Ruby enum implementation