attr_enum 0.1.0

data/Manifest

@@ -0,0 +1,6 @@
+Manifest
+README.rdoc
+Rakefile
+attr_enum.gemspec
+lib/attr_enum.rb
+test/attr_enum_test.rb

data/README.rdoc

@@ -0,0 +1,24 @@
+= attr_enum
+
+A class macro to define an enumeration variable. See http://en.wikipedia.org/wiki/Enumerated_type for more information.
+
+== Usage
+
+   class Card
+     attr_enum :suit, %w( clubs hearts diamonds spades )
+   end
+   
+   c = Card.new
+   c.suit = 'clubs'
+   c.suit
+   => 'clubs'
+   c.suit = 'jack' 
+   => EnumeratedTypeError, Card#suit must be one of clubs, hearts, diamonds, spades.
+   
+== Installation
+
+From rubyforge:
+  gem install attr_enum
+  
+From github:
+  gem install kmcd-attr_enum --source http://gems.github.com

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rake'
+require 'rake/testtask'
+require 'echoe'
+
+task :default => [:test]
+
+Echoe.new('attr_enum', '0.1.0') do |gem|
+  gem.description = 'Enumerated type macro for Ruby'
+  gem.url         = 'http://github.com/kmcd/attr_enum'
+  gem.author      = 'Keith McDonnell'
+  gem.email       = 'keith@dancingtext.com'
+  gem.ignore_pattern = ['tmp/*', 'script/*']
+  gem.development_dependencies = []                    
+end

data/attr_enum.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{attr_enum}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Keith McDonnell"]
+  s.date = %q{2010-10-08}
+  s.description = %q{Enumerated type macro for Ruby}
+  s.email = %q{keith@dancingtext.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/attr_enum.rb"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "attr_enum.gemspec", "lib/attr_enum.rb", "test/attr_enum_test.rb"]
+  s.homepage = %q{http://github.com/kmcd/attr_enum}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Attr_enum", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{attr_enum}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Enumerated type macro for Ruby}
+  s.test_files = ["test/attr_enum_test.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
+    else
+    end
+  else
+  end
+end

data/lib/attr_enum.rb

@@ -0,0 +1,63 @@
+# = attr_enum
+# A macro to define an enumeration variable
+# See http://en.wikipedia.org/wiki/Enumerated_type for more info
+# = Usage
+#   require 'rubygems'
+#   require 'attr_enum'
+# 
+#   class Card
+#     attr_enum :suit, %w( clubs hearts diamonds spades )
+#   end
+# 
+#   c = Card.new
+#   c.suit = 'clubs'                                                                    
+#   c.suit
+#   => 'clubs'
+#   m.suit = 'jack' 
+#   => EnumeratedTypeError, Card.suit must be one of clubs, hearts, diamonds, spades.
+
+class Module                                  
+  
+  # Declare an enumerated type which creates:
+  # * a class constant
+  # * a reader attribute
+  # * a writer with type constraint
+  # === Arguments
+  # +name+:: the name of the enumerated type, e.g :suit                                      
+  # +types+:: an array of valid types, e.g. %w( clubs hearts diamonds spades )
+  # === Example
+  #   class Card
+  #     attr_enum :suit, %w( clubs hearts diamonds spades )
+  #   end
+  # ==== Class constant
+  #   Card::SUITS
+  #   => ["clubs", "hearts", "diamonds", "spades"]
+  # ==== reader/writer attributes
+  #   c = Card.new
+  #   c.suit = 'clubs'
+  #   c.suit
+  #   => 'clubs'
+  # ==== Error handling:
+  #   Card.new.suit = 'spades' 
+  #   => EnumeratedTypeError, Card.suit must be one of clubs, hearts, diamonds, spades.                                               
+  def attr_enum(name, types)
+    attr_reader name                                                                  
+                                                                                                          
+    class_eval do
+      # Create a class constant                                                          
+      const_set :"#{name.to_s.upcase}_TYPES", types
+      
+      define_method(:"#{name}=") do |type|
+        # Add type constraint to setter method                                          
+        if self.class.const_get(:"#{name.to_s.upcase}_TYPES").include?(type)
+          instance_variable_set :"@#{name}", type
+        else
+          raise EnumeratedTypeError, "Invalid type; must be one of #{types.join(', ')}."
+        end
+      end
+    end
+  end
+end
+
+class EnumeratedTypeError < StandardError
+end

data/test/attr_enum_test.rb

@@ -0,0 +1,39 @@
+require 'attr_enum'
+require 'test/unit'
+
+begin
+  require 'rubygems'
+  require 'redgreen'
+rescue
+end
+
+class EnumeratedTypeTest < Test::Unit::TestCase
+  SUITS = %w( clubs hearts diamonds spades )
+  class Card
+    attr_enum :suit, SUITS
+  end
+
+  def setup
+    @card = Card.new
+  end
+  
+  def test_should_have_getter
+    assert @card.suit.nil?
+  end
+  
+  def test_should_have_class_constant
+    assert_equal SUITS, Card::SUIT_TYPES
+  end
+  
+  def test_should_have_setter
+    Card::SUIT_TYPES.each do |suit|
+      @card.suit = suit
+      assert_equal suit, @card.suit
+    end
+  end
+  
+  def test_should_have_type_constraint_on_setter
+    error = assert_raise(EnumeratedTypeError) { @card.suit = 'spadez' }
+    assert_match /Invalid type; must be one of #{SUITS.join ', ' }\./, error.message
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: attr_enum
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Keith McDonnell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-08 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Enumerated type macro for Ruby
+email: keith@dancingtext.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/attr_enum.rb
+files: 
+- Manifest
+- README.rdoc
+- Rakefile
+- attr_enum.gemspec
+- lib/attr_enum.rb
+- test/attr_enum_test.rb
+has_rdoc: true
+homepage: http://github.com/kmcd/attr_enum
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Attr_enum
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: attr_enum
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Enumerated type macro for Ruby
+test_files: 
+- test/attr_enum_test.rb