enumerated_type 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in enumerated_type.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Rafer Hazen
+
+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.

data/README.md

@@ -0,0 +1,29 @@
+# Enumeration
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'enumerated_type'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enumerated_type
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/enumerated_type.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enumerated_type/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "enumerated_type"
+  spec.version       = EnumeratedType::VERSION
+  spec.authors       = ["Rafer Hazen"]
+  spec.email         = ["rafer@ralua.com"]
+  spec.description   = %q{Simple enumerated types}
+  spec.summary       = %q{Simple enumerated types}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/enumerated_type.rb

@@ -0,0 +1,69 @@
+require "enumerated_type/version"
+
+module EnumeratedType
+  def self.included(base)
+    base.instance_eval do
+      @all = []
+
+      attr_reader :name, :value
+
+      private_class_method :new
+
+      extend Enumerable
+      extend ClassMethods
+    end
+  end
+
+  private
+
+  def initialize(name, value, options = {})
+    @name  = name
+    @value = value
+
+    options.each { |k, v| send(:"#{k}=", v) }
+  end
+
+  module ClassMethods
+    def each(&block)
+      @all.each(&block)
+    end
+
+    def by_value(value)
+      each { |e| return e if e.value == value }
+      raise ArgumentError, "Unrecognized #{self.name} value #{value.inspect}'"
+    end
+
+    def by_name(name)
+      each { |e| return e if e.name == name }
+      raise ArgumentError, "Unrecognized #{self.name} name #{name.inspect}'"
+    end
+
+    def [](name)
+      by_name(name)
+    end
+
+    private
+
+    def declare(name, options = {})
+      value = options.delete(:value)
+      value ||= (map(&:value).max || 0) + 1
+
+      if map(&:name).include?(name)
+        raise(ArgumentError, "duplicate name #{name.inspect}")
+      end
+
+      if map(&:value).include?(value)
+        raise(ArgumentError, "duplicate :value #{value.inspect}")
+      end
+
+      define_method(:"#{name}?") do
+        self.name == name
+      end
+
+      enumerated = new(name, value, options)
+
+      @all << enumerated
+      const_set(name.to_s.upcase, enumerated)
+    end
+  end
+end

data/lib/enumerated_type/version.rb

@@ -0,0 +1,3 @@
+module EnumeratedType
+  VERSION = "0.0.1"
+end

data/test/enumerated_type_spec.rb

@@ -0,0 +1,95 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+
+require "rubygems"
+require "bundler/setup"
+
+require "minitest"
+require "minitest/pride"
+
+require "enumerated_type"
+
+describe EnumeratedType do
+  class Gender
+    include EnumeratedType
+
+    attr_accessor :planet
+
+    declare(:male, :planet => "mars")
+    declare(:female, :planet => "venus")
+  end
+
+  it "privatizes the constructor" do
+    lambda { Gender.new }.must_raise(NoMethodError, /private method `new' called/)
+  end
+
+  it "is enumerable" do
+    Gender.must_be_kind_of Enumerable
+  end
+
+  it "enumerates over all the declared types" do
+    Gender.entries.must_equal [Gender[:male], Gender[:female]]
+  end
+
+  it "declares an actual constant for each type" do
+    Gender::MALE.must_be_same_as Gender[:male]
+    Gender::FEMALE.must_be_same_as Gender[:female]
+  end
+
+  it "defines a predicate method for each type based on the name" do
+    Gender.entries.map(&:male?).must_equal [true, false]
+    Gender.entries.map(&:female?).must_equal [false, true]
+  end
+
+  describe ".declare" do
+    it "is private" do
+      lambda { Gender.declare }.must_raise(NoMethodError, /private method `declare' called/)
+    end
+
+    it "requires the name to be unique" do
+      duplicate_name = Gender.first.name
+      lambda { Gender.send(:declare, duplicate_name) }.must_raise(ArgumentError, /duplicate name/)
+    end
+
+    it "allows you to specify :value" do
+      gender = Class.new do
+        include EnumeratedType
+        declare :male, :value => 100
+        declare :female, :value => 101
+      end
+
+      gender.map(&:value).must_equal [100, 101]
+    end
+
+    it "requires :value to be unique" do
+      duplicate_value = Gender.first.value
+
+      lambda { Gender.send(:declare, :neuter, :value => duplicate_value ) }.must_raise(ArgumentError, /duplicate :value/)
+    end
+
+    it "assigns extra attributes from .declare" do
+      Gender.map(&:planet).must_equal ["mars", "venus"]
+    end
+  end
+
+  describe ".by_name" do
+    it "returns the type with the given name" do
+      gender = Gender.first
+      Gender.by_name(gender.name).must_equal gender
+    end
+
+    it "raises an error given an unrecognized name" do
+      lambda { Gender.by_name(:neuter) }.must_raise(ArgumentError)
+    end
+  end
+
+  describe ".by_value" do
+    it "returns the type with the given value" do
+      gender = Gender.first
+      Gender.by_value(gender.value).must_equal gender
+    end
+
+    it "raises an error given an unrecognized value" do
+      lambda { Gender.by_value((Gender.map(&:value).max) + 1) }.must_raise(ArgumentError)
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: enumerated_type
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Rafer Hazen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-07-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  prerelease: false
+  type: :development
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 5
+        - 0
+        version: "5.0"
+  prerelease: false
+  type: :development
+  requirement: *id003
+description: Simple enumerated types
+email: 
+- rafer@ralua.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- enumerated_type.gemspec
+- lib/enumerated_type.rb
+- lib/enumerated_type/version.rb
+- test/enumerated_type_spec.rb
+homepage: ""
+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.8.25
+signing_key: 
+specification_version: 3
+summary: Simple enumerated types
+test_files: 
+- test/enumerated_type_spec.rb