enumeration 0.0.1 → 1.0.0

data/lib/enumeration.rb

@@ -1,3 +1,45 @@
+module Enumeration; end
+require 'enumeration/collection'
+
 module Enumeration
-  # Your code goes here...
+
+  module ClassMethods
+    def enum(name, map_or_list)
+      # TODO: validate name
+      c = Collection.new(map_or_list)
+
+      # define an anonymous Module to extend on
+      # defining a class level map reader
+      class_methods = Module.new do
+        define_method(name) {|k| class_variable_get("@@#{name}")[k]} if c.map?
+        define_method(name.to_s+'_set') { c.set }
+      end
+
+      # set a class variable to store the enum map (used by above reader)
+      # extend the anonymous module to get tne above class
+      #   level reader for the map
+      class_eval do
+        class_variable_set("@@#{name}", c)
+        extend class_methods
+      end
+
+      # instance writer for the enum value
+      define_method("#{name}=") do |value|
+        c = self.class.send(:class_variable_get, "@@#{name}")
+        instance_variable_set("@#{name}", c[value])
+      end
+
+      # instance reader for the enum value
+      define_method(name) do
+        instance_variable_get("@#{name}")
+      end
+    end
+  end
+
+  class << self
+    def included(receiver)
+      receiver.send :extend, ClassMethods
+    end
+  end
+
 end

data/lib/enumeration/collection.rb

@@ -0,0 +1,35 @@
+module Enumeration
+  class Collection
+
+    def initialize(map_or_list)
+      unless map_or_list.kind_of?(::Hash) || map_or_list.kind_of?(::Array)
+        raise ArgumentError, "please specify the enum collection as a Hash or Array"
+      end
+      @data = map_or_list
+    end
+
+    def [](value)
+      if self.map? && @data.has_key?(value)
+        @data[value]
+      elsif (self.map? && @data.has_value?(value)) ||
+            (@data.include?(value))
+        value
+      else
+        nil
+      end
+    end
+
+    def list?
+      @data.kind_of?(::Array)
+    end
+
+    def map?
+      @data.kind_of?(::Hash)
+    end
+
+    def set
+      self.map? ? @data.keys : @data
+    end
+
+  end
+end

data/lib/enumeration/version.rb

@@ -1,3 +1,3 @@
 module Enumeration
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/test/api__test.rb

@@ -0,0 +1,14 @@
+require "test/helper"
+
+class APITest < Test::Unit::TestCase
+  context "Enumeration mixin" do
+
+    subject { Thing.new }
+    before do
+      Thing.send :include, Enumeration
+    end
+
+    should_have_class_method :enum
+
+  end
+end

data/test/collection_test.rb

@@ -0,0 +1,65 @@
+require "test/helper"
+require "enumeration/collection"
+
+class CollectionAPITest < Test::Unit::TestCase
+  context "Enumeration collection" do
+    subject { Enumeration::Collection.new([]) }
+
+    should_have_instance_methods :set, :map?, :list?, :[]
+
+    should "only be created from Arrays or Hashes" do
+      assert_raises ArgumentError do
+        Enumeration::Collection.new('stuff')
+      end
+      assert_nothing_raised do
+        Enumeration::Collection.new([])
+        Enumeration::Collection.new({})
+      end
+    end
+
+  end
+end
+
+class ListCollectionTest < Test::Unit::TestCase
+  context "List collection" do
+    subject { Enumeration::Collection.new(['one', 'two', 'three']) }
+
+    should "be a list" do
+      assert_equal true, subject.list?
+      assert_equal false, subject.map?
+    end
+
+    should "know it's set" do
+      assert_equal ['one', 'two', 'three'], subject.set
+    end
+
+    should "lookup by value" do
+      assert_equal 'two', subject['two']
+    end
+
+  end
+end
+
+class MapCollectionTest < Test::Unit::TestCase
+  context "Map collection" do
+    subject { Enumeration::Collection.new({ :one => 1, :two => 2, :three => 3}) }
+
+    should "be a map" do
+      assert_equal true, subject.map?
+      assert_equal false, subject.list?
+    end
+
+    should "know it's set" do
+      [:one, :two, :three].each{|n| assert subject.set.include?(n)}
+    end
+
+    should "lookup by key" do
+      assert_equal 2, subject[:two]
+    end
+
+    should "lookup by value" do
+      assert_equal 2, subject[2]
+    end
+
+  end
+end

data/test/helper.rb

@@ -1,5 +1,4 @@
 require 'rubygems'
 require 'test_belt'
 require 'test/env'
-
-# TODO: setup your test environment here
+require 'test/thing'

data/test/list_enum_test.rb

@@ -0,0 +1,42 @@
+require "test/helper"
+
+class ListEnumTest < Test::Unit::TestCase
+  context "instance" do
+
+    subject { Thing.new }
+    before do
+      Thing.send :include, Enumeration
+      Thing.send(:enum, :word, %w{aye bee see})
+    end
+
+    should_have_class_method :word_set
+    should_have_accessor :word
+
+    should "not have a class level lookup method" do
+      assert_raises NoMethodError do
+        Thing.word
+      end
+    end
+
+    should "provide class level access to the enum set" do
+      words = Thing.word_set
+      assert words
+      assert_kind_of ::Array, words
+      assert !words.empty?
+      assert_equal 3, words.size
+      assert_equal ['aye', 'bee', 'see'], Thing.word_set
+    end
+
+    should "write by value and read by value" do
+      subject.word = "see"
+      assert_equal "see", subject.word
+    end
+
+    should "write nil for values that aren't in the enum" do
+      subject.word = "bady-bad"
+      assert_equal nil, subject.word
+    end
+
+  end
+end
+

data/test/map_enum_test.rb

@@ -0,0 +1,58 @@
+require "test/helper"
+
+class MapEnumTest < Test::Unit::TestCase
+  context "instance" do
+
+    subject { Thing.new }
+    before do
+      Thing.send :include, Enumeration
+      Thing.send(:enum, :stuff, {
+        :a => "aye",
+        :b => "bee",
+        :c => "see"
+      })
+    end
+
+    should_have_class_methods :stuff, :stuff_set
+    should_have_accessor :stuff
+
+    should "provide class level access to the enum set" do
+      stuffs = Thing.stuff_set
+      assert stuffs
+      assert_kind_of ::Array, stuffs
+      assert !stuffs.empty?
+      assert_equal 3, stuffs.size
+      [:a, :b, :c].each{|t| assert Thing.stuff_set.include?(t)}
+    end
+
+    should "provide class level lookup of the enum" do
+      assert_equal "aye", Thing.stuff(:a)
+    end
+
+    should "write by key and read by value" do
+      subject.stuff = :b
+      assert_equal "bee", subject.stuff
+    end
+
+    should "write by value and read by value" do
+      subject.stuff = "see"
+      assert_equal "see", subject.stuff
+    end
+
+    should "not read by key" do
+      subject.stuff = :c
+      assert_not_equal :c, subject.stuff
+    end
+
+    should "write nil for keys that aren't in the enum" do
+      subject.stuff = :bad
+      assert_equal nil, subject.stuff
+    end
+
+    should "write nil for values that aren't in the enum" do
+      subject.stuff = "bady-bad"
+      assert_equal nil, subject.stuff
+    end
+
+  end
+end

data/test/thing.rb

@@ -0,0 +1,3 @@
+class Thing
+  attr_accessor :one, :two, :three
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: enumeration
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 23
   prerelease: false
   segments: 
+  - 1
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors: 
 - Kelly D. Redding
@@ -65,10 +65,15 @@ files:
 - Rakefile
 - enumeration.gemspec
 - lib/enumeration.rb
+- lib/enumeration/collection.rb
 - lib/enumeration/version.rb
-- test/enumeration_test.rb
+- test/api__test.rb
+- test/collection_test.rb
 - test/env.rb
 - test/helper.rb
+- test/list_enum_test.rb
+- test/map_enum_test.rb
+- test/thing.rb
 has_rdoc: true
 homepage: http://github.com/kelredd/enumeration
 licenses: []
@@ -104,6 +109,10 @@ signing_key:
 specification_version: 3
 summary: add enumerated value attributes to your ruby classes
 test_files: 
-- test/enumeration_test.rb
+- test/api__test.rb
+- test/collection_test.rb
 - test/env.rb
 - test/helper.rb
+- test/list_enum_test.rb
+- test/map_enum_test.rb
+- test/thing.rb

data/test/enumeration_test.rb

@@ -1,13 +0,0 @@
-require "test/helper"
-
-class EnumerationTest < Test::Unit::TestCase
-
-  context "An instance of the Enumeration class" do
-
-    should "flunk" do
-      flunk "Please provide some tests"
-    end
-
-  end
-
-end