renum 0.1.0 → 1.0.0

data/Rakefile

@@ -1,4 +1,7 @@
 require 'config/requirements'
 require 'config/hoe' # setup Hoe + all gem configuration
 
-Dir['tasks/**/*.rake'].each { |rake| load rake }
+Dir['tasks/**/*.rake'].each { |rake| load rake }
+
+Rake::Task[:default].prerequisites.clear
+task :default => :spec

data/lib/renum/enumerated_value_type_factory.rb

@@ -2,14 +2,53 @@ require 'renum/enumerated_value'
 
 module Renum
   module EnumeratedValueTypeFactory
-    def create nest, type_name, values, &block
-      klass = Class.new EnumeratedValue
-      nest.const_set(type_name, klass)
-      klass.class_eval &block if block_given?
-      values.each do |name|
-        klass.const_set(name, klass.new(name))
+    class << self
+      def create nest, type_name, values, &block
+        klass = create_class nest, type_name
+        create_values klass, values, &block
+      end
+    
+      def create_class nest, type_name
+        klass = Class.new EnumeratedValue
+        nest.const_set(type_name, klass)
+        klass
+      end
+    
+      def create_values klass, values, &block
+        setup_for_definition_in_block(klass) if values == :defined_in_block
+        klass.class_eval &block if block_given?
+        if values == :defined_in_block
+          klass.block_defined_values.each do |value_name, init_args|
+            value = klass.new(value_name)
+            klass.const_set(value_name, value)
+            value.init *init_args if init_args.any?
+          end
+          teardown_from_definition_in_block(klass)
+        else
+          values.each do |name|
+            klass.const_set(name, klass.new(name))
+          end
+        end
+      end
+    
+      def setup_for_definition_in_block klass
+        klass.class_eval do
+          def self.block_defined_values
+            @block_defined_values ||= []
+          end
+
+          def self.method_missing value_name, *init_args
+            block_defined_values << [value_name, init_args]
+          end
+        end
+      end
+    
+      def teardown_from_definition_in_block klass
+        class << klass
+          remove_method :block_defined_values
+          remove_method :method_missing
+        end
       end
     end
-    module_function :create
   end
 end

data/lib/renum/version.rb

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

data/lib/renum.rb

@@ -2,7 +2,7 @@ $:.unshift File.dirname(__FILE__)
 require 'renum/enumerated_value_type_factory'
 
 module Renum
-  def enum type_name, values, &block
+  def enum type_name, values = :defined_in_block, &block
     nest = self.is_a?(Module) ? self : Object
     EnumeratedValueTypeFactory.create(nest, type_name, values, &block)
   end

data/spec/renum_spec.rb

@@ -1,24 +1,36 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper.rb')
-if ENV['USE_GEM']
-  require 'rubygems'
-  require 'renum'
-else
-  require File.expand_path(File.dirname(__FILE__) + '/../lib/renum')
-end
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 enum :Status, [ :NOT_STARTED, :IN_PROGRESS, :COMPLETE ]
 
+module MyNamespace
+  enum :FooValue, %w( Bar Baz Bat )
+end
+
 enum :Color, [ :RED, :GREEN, :BLUE ] do
   def abbr
     name[0..0]
   end
 end
 
-module MyNamespace
-  enum :FooValue, [ :Bar, :Baz, :Bat ]
+enum :Size do
+  Small("Really really tiny")
+  Medium("Sort of in the middle")
+  Large("Quite big")
+
+  attr_reader :description
+
+  def init description
+    @description = description
+  end
+end
+
+enum :HairColor do
+  BLONDE()
+  BRUNETTE()
+  RED()
 end
 
-describe "enum" do
+describe "basic enum" do
   
   it "creates a class for the value type" do
     Status.should be_an_instance_of(Class)
@@ -46,10 +58,6 @@ describe "enum" do
     Color::GREEN.index.should == 1
   end
   
-  it "allows an associated block to define instance methods" do
-    Color::RED.abbr.should == "R"
-  end
-  
   it "provides a reasonable to_s for values" do
     Status::NOT_STARTED.to_s.should == "Status::NOT_STARTED"
   end
@@ -57,9 +65,34 @@ describe "enum" do
   it "makes values comparable" do
     Color::RED.should < Color::GREEN
   end
-  
-  it "allows enums to be nested in other modules or classes" do
+end
+
+describe "nested enum" do
+  it "is namespaced in the containing module or class" do
     MyNamespace::FooValue::Bar.class.should == MyNamespace::FooValue
   end
+end
+
+describe "enum with a block" do
+  it "can define additional instance methods" do
+    Color::RED.abbr.should == "R"
+  end
+end
+
+describe "enum with no values array and values declared in the block" do
+  it "provides an alternative means of declaring values where extra information can be provided for initialization" do
+    Size::Small.description.should == "Really really tiny"
+  end
+  
+  it "works the same as the basic form with respect to ordering" do
+    Size.values.should == [Size::Small, Size::Medium, Size::Large]
+  end
   
+  it "responds as expected to arbitrary method calls, in spite of using method_missing for value definition" 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
+    HairColor::BLONDE.name.should == "BLONDE"
+  end
 end

data/spec/spec_helper.rb

@@ -4,4 +4,11 @@ rescue LoadError
   require 'rubygems'
   gem 'rspec'
   require 'spec'
-end
+end
+
+if ENV['USE_GEM']
+  require 'rubygems'
+  require 'renum'
+else
+  require File.expand_path(File.dirname(__FILE__) + '/../lib/renum')
+end

data/website/index.html

@@ -33,15 +33,9 @@
     <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">0.1.0</a>
+      <a href="http://rubyforge.org/projects/renum" class="numbers">1.0.0</a>
     </div>
-    <h1>&#x2192; &#8216;renum&#8217;</h1>
-
-
-	<h2>What</h2>
-
-
-	<p>Renum provides a readable but terse enum facility for Ruby.</p>
+    <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>
 
 
 	<h2>Installing</h2>
@@ -56,11 +50,17 @@
 	<p>Renum allows you to do things like this:</p>
 
 
-	<p><pre class='syntax'><span class="ident">enum</span> <span class="symbol">:Status</span><span class="punct">,</span> <span class="punct">[</span> <span class="symbol">:NOT_STARTED</span><span class="punct">,</span> <span class="symbol">:IN_PROGRESS</span><span class="punct">,</span> <span class="symbol">:COMPLETE</span> <span class="punct">]</span>
+	<p><pre class='syntax'><span class="ident">enum</span> <span class="symbol">:Status</span><span class="punct">,</span> <span class="punct">%w(</span><span class="string"> NOT_STARTED IN_PROGRESS COMPLETE </span><span class="punct">)</span>
+
+<span class="ident">enum</span> <span class="symbol">:Size</span> <span class="keyword">do</span>
+  <span class="constant">Small</span><span class="punct">(&quot;</span><span class="string">Really really tiny</span><span class="punct">&quot;)</span>
+  <span class="constant">Medium</span><span class="punct">(&quot;</span><span class="string">Sort of in the middle</span><span class="punct">&quot;)</span>
+  <span class="constant">Large</span><span class="punct">(&quot;</span><span class="string">Quite big</span><span class="punct">&quot;)</span>
 
-<span class="ident">enum</span> <span class="symbol">:Color</span><span class="punct">,</span> <span class="punct">[</span> <span class="symbol">:RED</span><span class="punct">,</span> <span class="symbol">:GREEN</span><span class="punct">,</span> <span class="symbol">:BLUE</span> <span class="punct">]</span> <span class="keyword">do</span>
-  <span class="keyword">def </span><span class="method">abbr</span>
-    <span class="ident">name</span><span class="punct">[</span><span class="number">0</span><span class="punct">..</span><span class="number">0</span><span class="punct">]</span>
+  <span class="ident">attr_reader</span> <span class="symbol">:description</span>
+
+  <span class="keyword">def </span><span class="method">init</span> <span class="ident">description</span>
+    <span class="attribute">@description</span> <span class="punct">=</span> <span class="ident">description</span>
   <span class="keyword">end</span>
 <span class="keyword">end</span>
 
@@ -69,7 +69,7 @@
 <span class="keyword">end</span></pre></p>
 
 
-	<p>Giving you something that satisfies this spec:</p>
+	<p>Giving you something that satisfies this spec, plus a bit more:</p>
 
 
 	<p><pre class='syntax'><span class="ident">describe</span> <span class="punct">&quot;</span><span class="string">enum</span><span class="punct">&quot;</span> <span class="keyword">do</span>
@@ -85,6 +85,10 @@
   <span class="ident">it</span> <span class="punct">&quot;</span><span class="string">exposes array of values</span><span class="punct">&quot;</span> <span class="keyword">do</span>
     <span class="constant">Status</span><span class="punct">.</span><span class="ident">values</span><span class="punct">.</span><span class="ident">should</span> <span class="punct">==</span> <span class="punct">[</span><span class="constant">Status</span><span class="punct">::</span><span class="constant">NOT_STARTED</span><span class="punct">,</span> <span class="constant">Status</span><span class="punct">::</span><span class="constant">IN_PROGRESS</span><span class="punct">,</span> <span class="constant">Status</span><span class="punct">::</span><span class="constant">COMPLETE</span><span class="punct">]</span>
   <span class="keyword">end</span>
+
+  <span class="ident">it</span> <span class="punct">&quot;</span><span class="string">provides an alternative means of declaring values where extra information can be provided for initialization</span><span class="punct">&quot;</span> <span class="keyword">do</span>
+    <span class="constant">Size</span><span class="punct">::</span><span class="constant">Small</span><span class="punct">.</span><span class="ident">description</span><span class="punct">.</span><span class="ident">should</span> <span class="punct">==</span> <span class="punct">&quot;</span><span class="string">Really really tiny</span><span class="punct">&quot;</span>
+  <span class="keyword">end</span>
   
   <span class="ident">it</span> <span class="punct">&quot;</span><span class="string">enumerates over values</span><span class="punct">&quot;</span> <span class="keyword">do</span>
     <span class="constant">Status</span><span class="punct">.</span><span class="ident">map</span> <span class="punct">{|</span><span class="ident">s</span><span class="punct">|</span> <span class="ident">s</span><span class="punct">.</span><span class="ident">name</span><span class="punct">}.</span><span class="ident">should</span> <span class="punct">==</span> <span class="punct">%w[</span><span class="string">NOT_STARTED IN_PROGRESS COMPLETE</span><span class="punct">]</span>
@@ -92,16 +96,10 @@
   
   <span class="ident">it</span> <span class="punct">&quot;</span><span class="string">indexes values</span><span class="punct">&quot;</span> <span class="keyword">do</span>
     <span class="constant">Status</span><span class="punct">[</span><span class="number">2</span><span class="punct">].</span><span class="ident">should</span> <span class="punct">==</span> <span class="constant">Status</span><span class="punct">::</span><span class="constant">COMPLETE</span>
-    <span class="constant">Color</span><span class="punct">[</span><span class="number">0</span><span class="punct">].</span><span class="ident">should</span> <span class="punct">==</span> <span class="constant">Color</span><span class="punct">::</span><span class="constant">RED</span>
   <span class="keyword">end</span>
   
   <span class="ident">it</span> <span class="punct">&quot;</span><span class="string">provides index lookup on values</span><span class="punct">&quot;</span> <span class="keyword">do</span>
     <span class="constant">Status</span><span class="punct">::</span><span class="constant">IN_PROGRESS</span><span class="punct">.</span><span class="ident">index</span><span class="punct">.</span><span class="ident">should</span> <span class="punct">==</span> <span class="number">1</span>
-    <span class="constant">Color</span><span class="punct">::</span><span class="constant">GREEN</span><span class="punct">.</span><span class="ident">index</span><span class="punct">.</span><span class="ident">should</span> <span class="punct">==</span> <span class="number">1</span>
-  <span class="keyword">end</span>
-  
-  <span class="ident">it</span> <span class="punct">&quot;</span><span class="string">allows an associated block to define instance methods</span><span class="punct">&quot;</span> <span class="keyword">do</span>
-    <span class="constant">Color</span><span class="punct">::</span><span class="constant">RED</span><span class="punct">.</span><span class="ident">abbr</span><span class="punct">.</span><span class="ident">should</span> <span class="punct">==</span> <span class="punct">&quot;</span><span class="string">R</span><span class="punct">&quot;</span>
   <span class="keyword">end</span>
   
   <span class="ident">it</span> <span class="punct">&quot;</span><span class="string">provides a reasonable to_s for values</span><span class="punct">&quot;</span> <span class="keyword">do</span>
@@ -109,7 +107,7 @@
   <span class="keyword">end</span>
   
   <span class="ident">it</span> <span class="punct">&quot;</span><span class="string">makes values comparable</span><span class="punct">&quot;</span> <span class="keyword">do</span>
-    <span class="constant">Color</span><span class="punct">::</span><span class="constant">RED</span><span class="punct">.</span><span class="ident">should</span> <span class="punct">&lt;</span> <span class="constant">Color</span><span class="punct">::</span><span class="constant">GREEN</span>
+    <span class="constant">Status</span><span class="punct">::</span><span class="constant">NOT_STARTED</span><span class="punct">.</span><span class="ident">should</span> <span class="punct">&lt;</span> <span class="constant">Status</span><span class="punct">::</span><span class="constant">COMPLETE</span>
   <span class="keyword">end</span>
   
   <span class="ident">it</span> <span class="punct">&quot;</span><span class="string">allows enums to be nested in other modules or classes</span><span class="punct">&quot;</span> <span class="keyword">do</span>
@@ -130,7 +128,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>, 2nd November 2007<br>
+      <a href="http://elhumidor.blogspot.com/">John D. Hume</a>, 25th January 2008<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -1,27 +1,26 @@
 h1. renum
 
-h1. → 'renum'
-
-
-h2. What
-
-Renum provides a readable but terse enum facility for Ruby.
-
+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's flexibility means there's no such thing as type-safety.
 
 h2. Installing
 
 <pre syntax="ruby">sudo gem install renum</pre>
 
-
 h2. Demonstration of usage
 
 Renum allows you to do things like this:
 
-<pre syntax="ruby">enum :Status, [ :NOT_STARTED, :IN_PROGRESS, :COMPLETE ]
+<pre syntax="ruby">enum :Status, %w( NOT_STARTED IN_PROGRESS COMPLETE )
+
+enum :Size do
+  Small("Really really tiny")
+  Medium("Sort of in the middle")
+  Large("Quite big")
 
-enum :Color, [ :RED, :GREEN, :BLUE ] do
-  def abbr
-    name[0..0]
+  attr_reader :description
+
+  def init description
+    @description = description
   end
 end
 
@@ -29,7 +28,7 @@ module MyNamespace
   enum :FooValue, [ :Bar, :Baz, :Bat ]
 end</pre>
 
-Giving you something that satisfies this spec:
+Giving you something that satisfies this spec, plus a bit more:
 
 <pre syntax="ruby">describe "enum" do
   
@@ -44,6 +43,10 @@ Giving you something that satisfies this spec:
   it "exposes array of values" do
     Status.values.should == [Status::NOT_STARTED, Status::IN_PROGRESS, Status::COMPLETE]
   end
+
+  it "provides an alternative means of declaring values where extra information can be provided for initialization" do
+    Size::Small.description.should == "Really really tiny"
+  end
   
   it "enumerates over values" do
     Status.map {|s| s.name}.should == %w[NOT_STARTED IN_PROGRESS COMPLETE]
@@ -51,16 +54,10 @@ Giving you something that satisfies this spec:
   
   it "indexes values" do
     Status[2].should == Status::COMPLETE
-    Color[0].should == Color::RED
   end
   
   it "provides index lookup on values" do
     Status::IN_PROGRESS.index.should == 1
-    Color::GREEN.index.should == 1
-  end
-  
-  it "allows an associated block to define instance methods" do
-    Color::RED.abbr.should == "R"
   end
   
   it "provides a reasonable to_s for values" do
@@ -68,7 +65,7 @@ Giving you something that satisfies this spec:
   end
   
   it "makes values comparable" do
-    Color::RED.should < Color::GREEN
+    Status::NOT_STARTED.should < Status::COMPLETE
   end
   
   it "allows enums to be nested in other modules or classes" do

data/website/stylesheets/screen.css

@@ -1,5 +1,5 @@
 body {
-  background-color: #E1D1F1;
+  background-color: #eee;
   font-family: "Georgia", sans-serif;
   font-size: 16px;
   line-height: 1.6em;

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: renum
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - John Hume
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-01-11 00:00:00 -05:00
+date: 2008-01-25 00:00:00 -05:00
 default_executable: 
 dependencies: []