renum 1.2.0 → 1.3.1

data/Rakefile

@@ -15,8 +15,8 @@ begin
     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
+  Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler or a dependency not available. To install: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+  puts "Jeweler or a dependency not available. To install: sudo gem install jeweler"
 end

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.1

data/lib/renum.rb

@@ -1,4 +1,3 @@
-$:.unshift File.dirname(__FILE__)
 require 'renum/enumerated_value_type_factory'
 
 # Requiring 'renum' mixes the Renum module into both the main Object and 

data/lib/renum/enumerated_value.rb

@@ -3,45 +3,55 @@ 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.
+  # An enumeration class is Enumerable over its values and exposes them by numeric index via [].
   # Values are also comparable, sorting into the order in which they're declared.
   class EnumeratedValue
-    
+
     class << self
       include Enumerable
       extend Forwardable
-      
+
       def_delegators :values, :each, :[]
-      
+
       # Returns an array of values in the order they're declared.
       def values
         @values ||= []
       end
-      
+
+      def with_name name
+        values_by_name[name]
+      end
+
+      def values_by_name
+        @values_by_name ||= values.inject({}) do |memo, value|
+          memo[value.name] = value
+          memo
+        end.freeze
+      end
+
     end
-    
+
     include Comparable
-    attr_reader :name
-    attr_reader :index
-    
+
+    attr_reader :name, :index
+
     def initialize name
-      @name = name.to_s
+      @name = name.to_s.freeze
       @index = self.class.values.size
       self.class.values << self
     end
-    
-    # Returns the fully qualified constant referring to this value.
+
+    # Returns the fully qualified name of the 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
-    
+
   end
-end
+end

data/lib/renum/enumerated_value_type_factory.rb

@@ -7,13 +7,13 @@ module Renum
         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?
@@ -30,8 +30,9 @@ module Renum
             klass.const_set(name, klass.new(name))
           end
         end
+        klass.values.freeze
       end
-    
+
       def setup_for_definition_in_block klass
         klass.class_eval do
           def self.block_defined_values
@@ -43,7 +44,7 @@ module Renum
           end
         end
       end
-    
+
       def teardown_from_definition_in_block klass
         class << klass
           remove_method :block_defined_values
@@ -52,4 +53,4 @@ module Renum
       end
     end
   end
-end
+end

data/renum.gemspec

@@ -1,12 +1,15 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{renum}
-  s.version = "1.2.0"
+  s.version = "1.3.1"
 
   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.date = %q{2010-08-17}
   s.description = %q{provides a readable but terse enum facility for Ruby}
   s.email = %q{duelin.markers@gmail.com}
   s.extra_rdoc_files = [
@@ -23,12 +26,10 @@ Gem::Specification.new do |s|
      "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.rubygems_version = %q{1.3.7}
   s.summary = %q{provides a readable but terse enum facility for Ruby}
   s.test_files = [
     "spec/renum_spec.rb",
@@ -37,11 +38,12 @@ Gem::Specification.new do |s|
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
     else
     end
   else
   end
 end
+

data/spec/renum_spec.rb

@@ -3,37 +3,43 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 enum :Status, [ :NOT_STARTED, :IN_PROGRESS, :COMPLETE ]
 
 describe "basic enum" do
-  
+
   it "creates a class for the value type" do
     Status.should be_an_instance_of(Class)
   end
-  
+
   it "makes each value an instance of the value type" do
     Status::NOT_STARTED.should be_an_instance_of(Status)
   end
-  
+
   it "exposes array of values" do
     Status.values.should == [Status::NOT_STARTED, Status::IN_PROGRESS, Status::COMPLETE]
   end
-  
+
   it "enumerates over values" do
     Status.map {|s| s.name}.should == %w[NOT_STARTED IN_PROGRESS COMPLETE]
   end
-  
+
   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 "provides name lookup on values" do
+    Status.with_name('IN_PROGRESS').should == Status::IN_PROGRESS
+    Color.with_name('GREEN').should == Color::GREEN
+    Color.with_name('IN_PROGRESS').should be_nil
+  end
+
   it "provides a reasonable to_s for values" do
     Status::NOT_STARTED.to_s.should == "Status::NOT_STARTED"
   end
-  
+
   it "makes values comparable" do
     Color::RED.should < Color::GREEN
   end
@@ -84,19 +90,19 @@ describe "enum with no values array and values declared in the block" 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::Unknown]
   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 "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
@@ -104,23 +110,23 @@ 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
@@ -131,11 +137,11 @@ describe "an enum with instance-specific method definitions" 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)
@@ -149,3 +155,17 @@ describe "<=> comparison issue that at one time was causing segfaults on MRI" do
     Color::RED.should < Color::BLUE
   end
 end
+
+describe "prevention of subtle and annoying bugs" do
+  it "prevents you modifying the values array" do
+    lambda { Color.values << 'some crazy value' }.should raise_error(TypeError, /can't modify frozen/)
+  end
+
+  it "prevents you modifying the name hash" do
+    lambda { Color.values_by_name['MAGENTA'] = 'some crazy value' }.should raise_error(TypeError, /can't modify frozen/)
+  end
+
+  it "prevents you modifying the name of a value" do
+    lambda { Color::RED.name << 'dish-Brown' }.should raise_error(TypeError, /can't modify frozen/)
+  end
+end

data/spec/spec_helper.rb

@@ -8,7 +8,5 @@ end
 
 if ENV['USE_GEM']
   require 'rubygems'
-  require 'renum'
-else
-  require File.expand_path(File.dirname(__FILE__) + '/../lib/renum')
 end
+require 'renum'

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: renum
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
+  hash: 25
+  prerelease: false
+  segments: 
+  - 1
+  - 3
+  - 1
+  version: 1.3.1
 platform: ruby
 authors: 
 - John Hume
@@ -9,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-01 00:00:00 -04:00
+date: 2010-08-17 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -33,29 +39,37 @@ files:
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/duelinmarkers/renum
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: renum
-rubygems_version: 1.3.1
+rubyforge_project: 
+rubygems_version: 1.3.7
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: provides a readable but terse enum facility for Ruby
 test_files: 
 - spec/renum_spec.rb