typed-enum 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Chris Tucker
+
+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.

data/README.rdoc

@@ -0,0 +1,47 @@
+= typed-enum
+
+A TypedEnum offers an enumeration facility allowing for the expression of a constrained set of (enumerated) values of a user-defined class, akin to Java's concept of enum.  It supports listing the available enumerated values and serializing/deserializing instances to/from string representations.  It is *not* thread safe (though it could be made so relatively easily).
+
+== Basic Usage
+
+A TypedEnum can be used to represent a typed, enumerated set of values.  A TypedEnum offers the following features:
+
+* Instances are restricted (in the absence of class-opening) to the set of instances defined in
+  the class definition
+* Available values can be enumerated in a consistent order via a call to the #values class method
+* Instances can be retrieved via class constants
+* Instances can be retrieved by parsing a string/symbol
+* Instances can be serialized to a string
+
+Basic usage example:
+   class Color
+     @enum = lambda {[
+       RED   = self.new(:red),
+       GREEN = self.new(:green),
+       BLUE  = self.new(:blue)
+     ]}
+     include TypedEnum
+   end
+
+   Color::RED => #<Color:0x163d59f8 @name=:red>
+   Color.from_name(:red) => #<Color:0x163d59f8 @name=:red>
+   Color.from_name('red') => #<Color:0x163d59f8 @name=:red>
+   Color::RED.name => :red
+   Color.values => [#<Color:0x163d59f8 @name=:red>, #<Color:0x163d59a8 @name=:green>, #<Color:0x163d5980 @name=:blue>]
+   
+
+== Contributing to typed-enum
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Chris Tucker. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "typed-enum"
+  gem.homepage = "http://github.com/ctucker/typed-enum"
+  gem.license = "MIT"
+  gem.summary = %Q{Typed, restricted enumerated set of values}
+  gem.description = %Q{A type-safe(ish) way to provide a constrained set of enumerated values that support basic enumeration, serialization/deserialization, and comparison}
+  gem.email = "ctucker@glyde.com"
+  gem.authors = ["Chris Tucker"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "typed-enum #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/typed_enum.rb

@@ -0,0 +1,104 @@
+# A TypedEnum can be used to represent a typed, enumerated set of values.  A
+# TypedEnum offers the following features:
+#
+#  * Instances are restricted (in the absence of class-opening) to the set of instances defined in
+#    the class definition
+#  * Available values can be enumerated in a consistent order via a call to the 
+#  * #values class method
+#  * Instances can be retrieved via class constants
+#  * Instances can be retrieved by parsing a string/symbol
+#  * Instances can be serialized to a string
+#
+# Basic usage example:
+#   class Color
+#     @enum = lambda {[
+#       RED   = self.new(:red),
+#       GREEN = self.new(:green),
+#       BLUE  = self.new(:blue)
+#     ]}
+#     include TypedEnum
+#   end
+#
+#   Color::RED => #<Color:0x163d59f8 @name=:red>
+#   Color.from_name(:red) => #<Color:0x163d59f8 @name=:red>
+#   Color.from_name('red') => #<Color:0x163d59f8 @name=:red>
+#   Color::RED.name => :red
+#   Color.values => [#<Color:0x163d59f8 @name=:red>, #<Color:0x163d59a8 @name=:green>, #<Color:0x163d5980 @name=:blue>]
+#   
+module TypedEnum
+
+  attr_reader :name
+  def initialize(name)
+    @name = name
+  end
+
+  def clone
+    raise TypeError, "Can't clone instance of TypedEnum #{self.class}"
+  end
+  def dup
+    raise TypeError, "Can't dup instance of TypedEnum #{self.class}"
+  end
+  def dump(depth=-1)
+    @name.to_s
+  end
+end
+
+class << TypedEnum
+  module TypedEnumClassMethods
+    def from_name(sym)
+      inverse_map[sym.to_sym] or raise NameError.new("No mapping for symbol #{sym} to vertical")
+    end
+
+    def parse(token)
+      sym = token.to_sym
+      from_symbol(sym)
+    end
+
+    def values
+      @@values
+    end
+
+    def _load(str)
+      parse(str.to_sym)
+    end
+
+    @initialized = false
+    def init
+      if !@initialized
+        @initialized = true
+        @@values = @enum.call
+      else
+        raise "Attempt to re-initialize typed enum #{self.class}"
+      end
+    end
+
+    private
+
+    def inverse_map
+      @@inverse_map ||= values.inject({}) { |m, v| m[v.name] = v; m }
+    end
+
+  end
+
+  def TypedEnum.included(klass)
+    super
+    klass.extend TypedEnumClassMethods
+    klass.init
+    klass.private_class_method :new, :allocate
+  end
+end
+
+if __FILE__ == $0
+
+  class Foo
+    @enum = lambda { [BOOKS = self.new(:books), GAMES = self.new(:games)] }
+    include TypedEnum
+  end
+
+  require 'pp'
+
+  pp (Foo.methods - Object.methods).sort
+
+  pp Foo.values
+
+end

data/test/helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'typed_enum'
+
+class Test::Unit::TestCase
+end

data/test/test_typed_enum.rb

@@ -0,0 +1,38 @@
+require 'helper'
+require 'typed_enum'
+
+class TestTypedEnum < Test::Unit::TestCase
+  
+  class Color
+    @enum = lambda {[
+      RED = self.new(:red),
+      GREEN = self.new(:green),
+      BLUE = self.new(:blue)
+      ]}
+    include TypedEnum
+  end
+  
+  
+  def test_get_name
+    assert_equal :red, Color::RED.name
+  end
+  
+  def test_from_name_by_symbol_gets_right_instance
+    assert_equal Color::RED, Color.from_name(:red)
+  end
+  
+  def test_from_name_by_string_gets_right_instance
+    assert_equal Color::BLUE, Color.from_name('blue')
+  end
+  
+  def test_missing_constant_raises_error
+    assert_raise NameError do
+      Color::PURPLE
+    end
+  end
+  
+  def test_get_values_returns_values_in_order
+    assert_equal [Color::RED, Color::GREEN, Color::BLUE], Color.values
+  end  
+  
+end

data/typed-enum.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{typed-enum}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Tucker"]
+  s.date = %q{2011-04-07}
+  s.description = %q{A type-safe(ish) way to provide a constrained set of enumerated values that support basic enumeration, serialization/deserialization, and comparison}
+  s.email = %q{ctucker@glyde.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/typed_enum.rb",
+    "test/helper.rb",
+    "test/test_typed_enum.rb",
+    "typed-enum.gemspec"
+  ]
+  s.homepage = %q{http://github.com/ctucker/typed-enum}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.7.2}
+  s.summary = %q{Typed, restricted enumerated set of values}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_typed_enum.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification 
+name: typed-enum
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chris Tucker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-07 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  prerelease: false
+  type: :development
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  prerelease: false
+  type: :development
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  prerelease: false
+  type: :development
+  requirement: *id003
+description: A type-safe(ish) way to provide a constrained set of enumerated values that support basic enumeration, serialization/deserialization, and comparison
+email: ctucker@glyde.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/typed_enum.rb
+- test/helper.rb
+- test/test_typed_enum.rb
+- typed-enum.gemspec
+homepage: http://github.com/ctucker/typed-enum
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Typed, restricted enumerated set of values
+test_files: 
+- test/helper.rb
+- test/test_typed_enum.rb