renum 1.0.2 → 1.2.0

data/{website/index.txt → README.textile}

@@ -115,6 +115,25 @@ h2. License
 
 This code is free to use under the terms of the MIT license. 
 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), 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:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", 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.
+
 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/.

data/Rakefile

@@ -1,7 +1,22 @@
-require 'config/requirements'
-require 'config/hoe' # setup Hoe + all gem configuration
+require 'rubygems'
+require 'spec/rake/spectask'
 
-Dir['tasks/**/*.rake'].each { |rake| load rake }
+Spec::Rake::SpecTask.new do |t|
+end
 
-Rake::Task[:default].prerequisites.clear
-task :default => :spec
+task :default => :spec
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "renum"
+    s.summary = "provides a readable but terse enum facility for Ruby"
+    s.email = "duelin.markers@gmail.com"
+    s.homepage = "http://github.com/duelinmarkers/renum"
+    s.description = "provides a readable but terse enum facility for Ruby"
+    s.authors = ["John Hume"]
+    s.rubyforge_project = "renum"
+  end
+rescue LoadError
+  puts "Jeweler or a dependency not available. To install: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+1.2.0

data/lib/renum.rb

@@ -1,7 +1,14 @@
 $:.unshift File.dirname(__FILE__)
 require 'renum/enumerated_value_type_factory'
 
+# Requiring 'renum' mixes the Renum module into both the main Object and 
+# Module, so it can be called from anywhere that you might reasonably 
+# define an enumeration with an implicit receiver.
 module Renum
+
+  # Figures out whether the new enumeration will live in Object or the 
+  # receiving Module, then delegates to EnumeratedValueTypeFactory#create for 
+  # all the real work.
   def enum type_name, values = :defined_in_block, &block
     nest = self.is_a?(Module) ? self : Object
     EnumeratedValueTypeFactory.create(nest, type_name, values, &block)

data/lib/renum/enumerated_value.rb

@@ -1,6 +1,11 @@
 require 'forwardable'
 
 module Renum
+
+  # This is the superclass of all enumeration classes. 
+  # An enumeration class is Enumerable over its values and also delegates [] 
+  # to the values array.
+  # Values are also comparable, sorting into the order in which they're declared.
   class EnumeratedValue
     
     class << self
@@ -9,6 +14,7 @@ module Renum
       
       def_delegators :values, :each, :[]
       
+      # Returns an array of values in the order they're declared.
       def values
         @values ||= []
       end
@@ -25,10 +31,14 @@ module Renum
       self.class.values << self
     end
     
+    # Returns the fully qualified constant referring to this value.
+    # Don't override this if you're using Renum with the constantize_attribute 
+    # plugin, which relies on this behavior.
     def to_s
       "#{self.class}::#{name}"
     end
     
+    # Sorts enumerated values into the order in which they're declared.
     def <=> other
       index <=> other.index
     end

data/lib/renum/enumerated_value_type_factory.rb

@@ -18,10 +18,11 @@ module Renum
         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|
+          klass.block_defined_values.each do |value_name, init_args, instance_block|
             value = klass.new(value_name)
             klass.const_set(value_name, value)
-            value.init *init_args if init_args.any?
+            value.instance_eval &instance_block if instance_block
+            value.init *init_args if value.respond_to? :init
           end
           teardown_from_definition_in_block(klass)
         else
@@ -37,8 +38,8 @@ module Renum
             @block_defined_values ||= []
           end
 
-          def self.method_missing value_name, *init_args
-            block_defined_values << [value_name, init_args]
+          def self.method_missing value_name, *init_args, &instance_block
+            block_defined_values << [value_name, init_args, instance_block]
           end
         end
       end

data/renum.gemspec

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{renum}
+  s.version = "1.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Hume"]
+  s.date = %q{2009-09-01}
+  s.description = %q{provides a readable but terse enum facility for Ruby}
+  s.email = %q{duelin.markers@gmail.com}
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    "README.textile",
+     "Rakefile",
+     "VERSION",
+     "lib/renum.rb",
+     "lib/renum/enumerated_value.rb",
+     "lib/renum/enumerated_value_type_factory.rb",
+     "renum.gemspec",
+     "spec/renum_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/duelinmarkers/renum}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{renum}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{provides a readable but terse enum facility for Ruby}
+  s.test_files = [
+    "spec/renum_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/renum_spec.rb

@@ -2,34 +2,6 @@ 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
-
-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 "basic enum" do
   
   it "creates a class for the value type" do
@@ -67,25 +39,54 @@ describe "basic enum" do
   end
 end
 
+module MyNamespace
+  enum :FooValue, %w( Bar Baz Bat )
+end
+
 describe "nested enum" do
   it "is namespaced in the containing module or class" do
     MyNamespace::FooValue::Bar.class.should == MyNamespace::FooValue
   end
 end
 
+enum :Color, [ :RED, :GREEN, :BLUE ] do
+  def abbr
+    name[0..0]
+  end
+end
+
 describe "enum with a block" do
   it "can define additional instance methods" do
     Color::RED.abbr.should == "R"
   end
 end
 
+enum :Size do
+  Small("Really really tiny")
+  Medium("Sort of in the middle")
+  Large("Quite big")
+  Unknown()
+
+  attr_reader :description
+
+  def init description = nil
+    @description = description || "NO DESCRIPTION GIVEN"
+  end
+end
+
+enum :HairColor do
+  BLONDE()
+  BRUNETTE()
+  RED()
+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
+  it "provides another way to declare values where an init method can take extra params" 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]
+    Size.values.should == [Size::Small, Size::Medium, Size::Large, Size::Unknown]
   end
   
   it "responds as expected to arbitrary method calls, in spite of using method_missing for value definition" do
@@ -95,14 +96,56 @@ describe "enum with no values array and values declared in the block" 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
+  
+  it "calls the init method even if no arguments are provided" do
+    Size::Unknown.description.should == "NO DESCRIPTION GIVEN"
+  end
+end
+
+enum :Rating do
+  NotRated()
+  
+  ThumbsDown do
+    def description
+      "real real bad"
+    end
+  end
+  
+  ThumbsUp do
+    def description
+      "so so good"
+    end
+    
+    def thumbs_up_only_method
+      "this method is only defined on ThumbsUp"
+    end
+  end
+  
+  def description
+    raise NotImplementedError
+  end
 end
 
-# It was reported on my blog that <=> was causing segfaults.
-# I'd love to figure out why, but first I'd love to fix that. 
-describe "digging into this segfault/illegal instruction issue, renum" do
+describe "an enum with instance-specific method definitions" do
+  it "allows each instance to have its own behavior" do
+    Rating::ThumbsDown.description.should == "real real bad"
+    Rating::ThumbsUp.description.should == "so so good"
+  end
+  
+  it "uses the implementation given at the top level if no alternate definition is given for an instance" do
+    lambda { Rating::NotRated.description }.should raise_error(NotImplementedError)
+  end
+  
+  it "allows definition of a method on just one instance" do
+    Rating::ThumbsUp.thumbs_up_only_method.should == "this method is only defined on ThumbsUp"
+    lambda { Rating::NotRated.thumbs_up_only_method }.should raise_error(NoMethodError)
+  end
+end
+
+describe "<=> comparison issue that at one time was causing segfaults on MRI" do
   it "doesn't cause the ruby process to bomb!" do
     Color::RED.should < Color::GREEN
     Color::RED.should_not > Color::GREEN
     Color::RED.should < Color::BLUE
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: renum
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: 1.2.0
 platform: ruby
 authors: 
 - John Hume
@@ -9,57 +9,33 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-07 00:00:00 -05:00
+date: 2009-09-01 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
-description: Renum is a Ruby enum implementation
-email: duelin dot markers at gmail
+description: provides a readable but terse enum facility for Ruby
+email: duelin.markers@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- License.txt
-- Manifest.txt
-- README.txt
-- website/index.txt
+- README.textile
 files: 
-- History.txt
-- License.txt
-- Manifest.txt
-- README.txt
+- README.textile
 - Rakefile
-- config/hoe.rb
-- config/requirements.rb
+- VERSION
 - lib/renum.rb
 - lib/renum/enumerated_value.rb
 - lib/renum/enumerated_value_type_factory.rb
-- lib/renum/version.rb
-- log/debug.log
-- script/destroy
-- script/generate
-- script/txt2html
-- setup.rb
+- renum.gemspec
 - spec/renum_spec.rb
-- spec/spec.opts
 - spec/spec_helper.rb
-- tasks/deployment.rake
-- tasks/environment.rake
-- tasks/rspec.rake
-- tasks/website.rake
-- website/index.html
-- website/index.txt
-- website/javascripts/rounded_corners_lite.inc.js
-- website/stylesheets/screen.css
-- website/template.rhtml
 has_rdoc: true
-homepage: http://renum.rubyforge.org
+homepage: http://github.com/duelinmarkers/renum
 post_install_message: 
 rdoc_options: 
-- --main
-- README.txt
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -77,9 +53,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: renum
-rubygems_version: 1.2.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: Renum is a Ruby enum implementation
-test_files: []
-
+summary: provides a readable but terse enum facility for Ruby
+test_files: 
+- spec/renum_spec.rb
+- spec/spec_helper.rb

data/History.txt

@@ -1,23 +0,0 @@
-== 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
-
-== 0.1.0 ???
-
-* Add in a missing require
-
-== 0.0.3 2007-11-02
-
-* Support nesting enums inside other modules.
-* Add Comparable
-
-== 0.0.1 2007-11-01
-
-* 1 major enhancement:
-  * Initial release
-