ruby_enum 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c6a72a675c8fb1c4a85809100aec69936f5a817
-  data.tar.gz: 860b5ca16bada4964b91e6d254cec40e517c69cb
+  metadata.gz: 657f62ea2a5ad4d1de5127994577fed1718f6818
+  data.tar.gz: b2e13247e031052801b3a655b56f66384e1163e7
 SHA512:
-  metadata.gz: 5134691adf41fa028d5276548228ee7df8de5788052cffc1748730c39f55954ae5c85f0d04a31c458e96fa8af368e735d342771e868bf2a69d3afc8050b8e58f
-  data.tar.gz: 70e290e118a5700ba880daed557ed9a6678eecdcf55b4fec46b60e5c8ecc00b72e1652e08d8e264c3807fdfcbfb9e2f5a21042b8a8e54de177c2502744898f54
+  metadata.gz: 61772d63201ff017e9fa501edf8072a1e54db44deff03a0dfac12894dff8ee1fbc3a6e821d2810b5fd87cdbe41073fbb6951109036e0299497981df2c988589c
+  data.tar.gz: ce4300b106bb90bdbcfa257a7dad0684b2551b08168aaf81d1046975941a292175fb07dc318bb2af708eaf0708b1284d9ee9ea07bdfdc33adee955b17e3b6712

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle/
+pkg/
+.idea
+.yardoc
+*~
+*.swp
+tags
+gems.tags

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_enum (0.1.0)
+    ruby_enum (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,6 @@
 # RubyEnum
 
-A simple enumeration type for ruby classes.
+A simple enumeration type for ruby.
 
 ## Installation
 
@@ -20,7 +20,8 @@ Or install it yourself as:
 
 ## Usage
 
-To create an enumeration type simply include the `RubyEnum` module and define the enumeration values as follows:
+To create an enumeration type simply include the `RubyEnum` module in your
+enumeration class and provide the enumeration's values as follows:
 ```ruby
 class Coordinates
   include RubyEnum
@@ -31,7 +32,33 @@ class Coordinates
   enum :east
 ```
 
-Including `RubyEnum` in any class will make it a singleton. This means that you can't use `new`, `allocate`, `clone` or `dup` on that class. You can access enumeration values however as follows:
+Including `RubyEnum` in any class will make it a singleton. This means that you
+can't create new instances of your class using `new`, `allocate`, `clone` or
+`dup`. You can access an enumeration's value instances in three different ways:
+
+1. Using a class method that matches the provided name of the enumeration
+value:
+```ruby
+north = Coordinates.north
+```
+
+2. Using a constant:
+```ruby
+north = Coordinates::NORTH
+```
+
+3. Treating your enumeration class as a dictionary:
+```ruby
+north = Coordinates[:north]
+```
+
+All three approaches are equivalent and subject to personal style.
+
+To retrieve all values of an enumeration, simply invoke `all` method on your
+enumeration class:
+```ruby
+coordinates = Coordinates.all
+```
 
 ## Development
 

data/lib/ruby_enum/rspec.rb

@@ -0,0 +1,25 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :be_an_enumeration do
+  match do |actual|
+    actual.ancestors.include? RubyEnum
+  end
+end
+
+RSpec::Matchers.define :define_enumeration_value do |name, value|
+  match do |actual|
+    enum_value = actual.send name
+    if value
+      enum_value.name == name && enum_value.value == value
+    else
+      enum_value.name == name
+    end
+  end
+  description do
+    if value
+    "define enumeration #{name} with value #{value}"
+    else
+    "define enumeration #{name}"
+    end
+  end
+end

data/lib/ruby_enum/version.rb

@@ -1,3 +1,3 @@
 module RubyEnum
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/ruby_enum.rb

@@ -11,11 +11,32 @@ module RubyEnum
 
   module InstanceMethods
 
+    def method_missing(method, *args, &block)
+      if method.to_s =~ /^(.*)\?/
+        enum_names = self.class.all.map(&:name)
+        expected_name = $1.to_sym
+        if enum_names.include?(expected_name)
+          return name == expected_name
+        end
+      end
+    end
+
+    def respond_to?(method)
+      if method.to_s =~ /^(.*)\?/
+        enum_names = self.class.all.map(&:name)
+        return enum_names.include? $1.to_sym
+      end
+    end
+
     # the value associated with the enumeration instance
-    def raw_value
+    def value
       @_value
     end
 
+    def name
+      @_name
+    end
+
     def clone
       raise TypeError, "can't clone instance of enum #{self.class}"
     end
@@ -26,7 +47,8 @@ module RubyEnum
 
     private
 
-    def initialize(value)
+    def initialize(name, value)
+      @_name = name
       @_value = value
     end
   end
@@ -40,8 +62,6 @@ module RubyEnum
 
     # defines enumeration values
     def enum(name, value = nil)
-      @_instances ||= {}
-
       normalized_name = normalize name
       if self[normalized_name]
         raise ArgumentError, "An enumeration value for #{normalized_name} has " \
@@ -49,20 +69,24 @@ module RubyEnum
       else
         value = normalized_name.to_s unless value
         define_instance_accessor_for normalized_name
-        @_instances[normalized_name] = new value
+        enumeration_values[normalized_name] = new(normalized_name, value)
       end
     end
 
     def [](name)
-      @_instances[normalize(name)]
+      enumeration_values[normalize(name)]
     end
 
     def all
-      @_instances.map { |_, instance| instance }
+      enumeration_values.map { |_, instance| instance }
     end
 
     private
 
+    def enumeration_values
+      @_instances ||= {}
+    end
+
     def define_instance_accessor_for(name)
       self.class.instance_eval do
         define_method(name) { return self[name] }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_enum
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Lefteris Laskaridis
@@ -59,6 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -67,6 +68,7 @@ files:
 - bin/console
 - bin/setup
 - lib/ruby_enum.rb
+- lib/ruby_enum/rspec.rb
 - lib/ruby_enum/version.rb
 - ruby_enum.gemspec
 - tags