enumz 1.0.0

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--backtrace
+--default_path spec

data/.simplecov

@@ -0,0 +1,5 @@
+# configure code coverage
+SimpleCov.start do
+  # exclude directories and files
+  add_filter "/spec/"
+end

data/Gemfile

@@ -0,0 +1,14 @@
+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, :test do
+  gem "rdoc", ">= 3.12"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", ">= 1.8.4"
+  gem "rspec", ">= 0"
+  gem "simplecov"
+end

data/Gemfile.lock

@@ -0,0 +1,37 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  jeweler (>= 1.8.4)
+  rdoc (>= 3.12)
+  rspec
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 obie quelland
+
+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.md

@@ -0,0 +1,4 @@
+enumz
+=====
+
+TODO: update content

data/Rakefile

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+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 = "enumz"
+  gem.homepage = "http://github.com/obieq/enumz"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby Enumeration}
+  gem.description = %Q{ Provides enumeration functionality akin to that of C#'s }
+  gem.email = "quelland@gmail.com"
+  gem.authors = ["obie quelland"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "enumz #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Get spec rake tasks working in RSpec 2.0
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/enumz.gemspec

@@ -0,0 +1,67 @@
+# 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 = "enumz"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["obie quelland"]
+  s.date = "2012-09-15"
+  s.description = " Provides enumeration functionality akin to that of C#'s "
+  s.email = "quelland@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".rspec",
+    ".simplecov",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "enumz.gemspec",
+    "lib/enumz.rb",
+    "lib/enumz/base_enumz.rb",
+    "lib/enumz/enumz_factory.rb",
+    "spec/enum_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb",
+    "spec/support/enumz_creation_shared_examples.rb"
+  ]
+  s.homepage = "http://github.com/obieq/enumz"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.19"
+  s.summary = "Ruby Enumeration"
+
+  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<rdoc>, [">= 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.8.4"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rdoc>, [">= 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/enumz.rb

@@ -0,0 +1,15 @@
+require 'enumz/enumz_factory'
+
+module Enumz
+
+  def enum(name, data_elements, options={})
+    EnumzFactory.create(name, data_elements, options)
+  end # enum
+
+end # module Enumz
+
+extend Enumz
+
+Module.module_eval do
+  extend Enumz
+end

data/lib/enumz/base_enumz.rb

@@ -0,0 +1,42 @@
+module BaseEnumz
+  attr_reader :data_elements, :options
+
+  # list of ruby module method names that
+  # cannot be overridden
+  # i.e. overridding enum.class is too destructive
+  RESERVED_METHOD_NAMES = [:class, :object_id, :method_missing,
+                           :instance_eval, :send, :should_not, :nil?,
+                           :const_get, :const_missing, :inspect, :to_s]
+
+  # return list of enum names
+  def names
+    @names ||= data_elements.keys
+  end
+
+  # return list of enum values
+  def values
+    @values ||= data_elements.values
+  end
+
+  # return the corresponding enum name for a given value
+  def [](value)
+    @inverted_data_elements ||= data_elements.invert
+    @inverted_data_elements[value]
+  end
+
+  # create a method for each enum name
+  def method_missing(meth, *args, &block)
+    if data_elements[meth.to_s.to_sym]
+      self.instance_eval <<-EVAL
+        def #{meth}
+          data_elements[:#{meth}]
+        end
+      EVAL
+
+      __send__(meth, *args, &block)
+    else
+      super
+    end
+  end
+
+end # module BaseEnumz

data/lib/enumz/enumz_factory.rb

@@ -0,0 +1,75 @@
+require 'enumz/base_enumz'
+
+module EnumzFactory
+
+  class << self
+
+    def create(name, data_elements, options)
+      name = if name.is_a? Symbol
+        name.to_s.split('_').map(&:capitalize).join
+      else
+        raise ArgumentError, 'name must be of type symbol. e.g., "enum :my_name [:red, "yellow", ..]"'
+      end
+
+      create_module(name, process_data_elements(data_elements), options)
+    end # create
+
+    def process_data_elements(data_elements)
+      data_elements = if data_elements.is_a? Array
+        # if an array, then convert to a hash
+        # 1) the hash keys = array data_elements
+        # 2) the hash data_elements correspond to the array value's index position
+        # 3) the hash keys are symbols
+        Hash[*data_elements.reduce([]) {|result, a| result << a.to_s.to_sym; result << (result.count / 2) + 1 }.flatten]
+      elsif data_elements.is_a? Hash
+        # ensure the values are unique
+        raise ArgumentError, 'values must be unique' unless data_elements.values.count == data_elements.values.uniq.count
+
+        # ensure that the keys are symbols
+        Hash[ data_elements.map { |k, v| [ k.to_s.to_sym, v ] }]
+      else
+        raise ArgumentError, 'data_elements must be either an array or a hash, e.g., "enum :my_name {:red => 1, "yellow" => 2, ..}"'
+      end
+
+      # raise an exception if an enum name is a reserved method name
+      intersection = (data_elements.keys & BaseEnumz::RESERVED_METHOD_NAMES)
+      raise ArgumentError, "enum name #{intersection[0]} is a reserved ruby method name" unless intersection.empty?
+
+      # freeze the hash so no modifications can be made at a later time
+      data_elements.freeze
+    end # process_data_elements
+
+    def create_module(name, data_elements, options)
+      # create a new module
+      mod = Object.const_set(name.to_s, Module.new)
+
+      # grab base methods from the new module,
+      # which we'll delete at the end
+      base_methods = mod.methods.clone.sort
+
+      # the new module extends the BaseEnum module
+      mod.extend BaseEnumz
+
+      # set the data_elements property
+      mod.instance_variable_set('@data_elements', data_elements)
+
+      # set the options property
+      mod.instance_variable_set('@options', options)
+
+      # add a constant for each enum name/value
+      data_elements.each { |k,v| mod.const_set(k.to_s.capitalize, v) }
+
+      # remove all unnecessary defacto ruby module methods
+      # in order to avoid potential conflicts with enum names
+      # EX: module.name vs enum.name
+      #     module.clone vs enum.clone
+      base_methods.each do |m|
+        mod.instance_eval "undef :#{m}" unless (m.match(/^__/)) or BaseEnumz::RESERVED_METHOD_NAMES.include?(m)
+      end
+
+      mod
+    end # create_module
+
+  end # class << self
+
+end # module EnumzFactory

data/spec/enum_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+enum :array_colors, [:yellow, "green", 'blue']
+enum :hash_colors, {:yellow => 2, "green" => 5, 'blue' => 8, :mauve => 20}
+enum :module_method_names, [:name, "display", 'clone']
+
+describe Enumz do
+
+  describe 'creation' do
+
+    describe 'via array' do
+      names = [:yellow, "green", 'blue']
+      values = [1,2,3]
+
+      it_should_behave_like 'a properly created enum', ArrayColors, 3, names, values
+
+      it 'should generate values' do
+        ArrayColors.values.should_not be_nil
+        ArrayColors.values.count.should eq(3)
+        ArrayColors.values.reduce(1) do |counter, value|
+          counter.should eq(value)
+          counter += 1
+        end
+      end
+
+    end # creation
+
+    describe 'via hash' do
+      names = [:yellow, "green", 'blue', :mauve]
+      values = [2,5,8,20]
+
+      it_should_behave_like 'a properly created enum', HashColors, 4, names, values
+    end
+
+  end # via hash
+
+  describe "features" do
+
+    it 'should remove module methods to avoid potential conflicts when creating methods for enum names' do
+      ModuleMethodNames.name.should eq(1)
+      ModuleMethodNames.display.should eq(2)
+      ModuleMethodNames.clone.should eq(3)
+    end
+
+  end
+
+  describe 'exceptions' do
+    module ExceptionsEnum
+      extend Enumz
+    end
+
+    it 'should raise an exception if enum name is not a symbol' do
+      expect { ExceptionsEnum.enum "hi", [] }.to raise_error ArgumentError
+    end
+
+    it 'should raise an exception if enum values is neither a hash nor an array' do
+      expect { ExceptionsEnum.enum :test_enum, :invalid_value }.to raise_error ArgumentError
+    end
+
+    it 'should raise an exception if attempting to access a non-existent enum name' do
+      expect { ArrayColors.invisible }.to raise_error NoMethodError
+    end
+
+    it 'should raise an exception if a duplicate enum value is supplied' do
+      expect { ExceptionsEnum.enum :test_enum, {:yellow => 1, :green => 2, :blue => 1}}.to raise_error ArgumentError
+    end
+
+    it 'should raise an exception when creating an enum with a name that is a ruby reserved method name' do
+      BaseEnumz::RESERVED_METHOD_NAMES.each do |name|
+        expect { ExceptionsEnum.enum :test_enum, [name] }.to raise_error ArgumentError
+      end
+    end
+
+    it 'should raise a read-only exception when trying to update' do
+      expect { ArrayColors.data_elements[:alyssum] = 100 }.to raise_error RuntimeError
+    end
+
+  end # validations
+
+end # Enumz

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--format

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'simplecov'
+require 'rspec'
+
+# require the library files
+Dir["./lib/**/*.rb"].each {|f| require f}
+
+# require the shared example files
+Dir["./spec/support/**/*.rb"].each {|f| require f}

data/spec/support/enumz_creation_shared_examples.rb

@@ -0,0 +1,55 @@
+shared_examples "a properly created enum" do |enum, num_data_elements, names, values|
+
+  it 'should create a module whose name matches that of the enum' do
+    enum.should_not be_nil
+    enum.class.should eq(Module)
+  end
+
+  it 'should be valid' do
+    enum.data_elements.class.should eq(Hash)
+    enum.data_elements.count.should eq(num_data_elements)
+
+    enum.names.count.should eq(num_data_elements)
+    enum.values.count.should eq(num_data_elements)
+
+    # compare actual names w/ expected names
+    enum.names.reduce(0) do |counter, key|
+      names[counter].to_sym.should eq(key)
+      counter += 1
+    end
+
+    # compare actual values w/ expected values
+    enum.values.reduce(0) do |counter, value|
+      values[counter].should eq(value)
+      counter += 1
+    end
+  end
+
+  it 'should symbolize all names' do
+    enum.names.each do |key|
+      key.class.should eq(Symbol)
+    end
+  end
+
+  it 'should access values via methods whose names match those of the enum names' do
+    enum.names.reduce(0) do |counter, key|
+      enum.send("#{key}").should eq(values[counter])
+      counter += 1
+    end
+  end
+
+  it 'should access values via constants whose names match those of the enum names' do
+    enum.names.reduce(0) do |counter, key|
+      enum.const_get(key.to_s.capitalize).should eq(values[counter])
+      counter += 1
+    end
+  end
+
+  it 'should get enum name by value' do
+    values.reduce(0) do |counter, value|
+      enum[value].should eq(names[counter].to_sym)
+      counter += 1
+    end
+  end
+
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: enumz
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- obie quelland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! ' Provides enumeration functionality akin to that of C#''s '
+email: quelland@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .rspec
+- .simplecov
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- enumz.gemspec
+- lib/enumz.rb
+- lib/enumz/base_enumz.rb
+- lib/enumz/enumz_factory.rb
+- spec/enum_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/enumz_creation_shared_examples.rb
+homepage: http://github.com/obieq/enumz
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3518699016868134358
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: Ruby Enumeration
+test_files: []