ruby-enum 0.1.0 → 0.2.1

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 0.3.0 (Next Release)
+
+* Your contribution here.
+
+### 0.2.1 (5/15/2013)
+
+* Added `Ruby::Enum#values`, `Ruby::Enum#keys` and `Ruby::Enum#to_h` - [@dblock](https://github.com/dblock).
+* A `Ruby::Enum::Errors::UninitializedConstantError` will now be raised when referencing an undefined enum - [@dblock](https://github.com/dblock).
+
 ### 0.1.0 (5/14/2013)
 
-* Initial public release - [@dblock](https://github.com/dblock).
+* Initial public release, live-coded during [May 2013 NYC.rb](http://code.dblock.org/your-first-ruby-gem) - [@dblock](https://github.com/dblock).

data/Gemfile

@@ -3,4 +3,4 @@ source "http://rubygems.org"
 gemspec
 
 gem "rspec"
-gem "rake"
+gem "rake"

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    ruby-enum (0.2.1)
+      i18n
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    i18n (0.6.4)
+    rake (10.0.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec
+  ruby-enum!

data/README.md

@@ -3,9 +3,9 @@ Ruby::Enum
 
 [![Build Status](https://travis-ci.org/dblock/ruby-enum.png)](https://travis-ci.org/dblock/ruby-enum)
 
-A handy library for defining enums in Ruby.
+Enum-like behavior for Ruby, heavily inspired by [this](http://www.rubyfleebie.com/enumerations-and-ruby) and improved upon [another blog post](http://code.dblock.org/how-to-define-enums-in-ruby).
 
-### Usage
+## Usage
 
 ``` ruby
 class Colors
@@ -16,18 +16,37 @@ class Colors
 end
 ```
 
-### Contributing
+### Referencing
+
+``` ruby
+Colors::RED # "red"
+Colors::GREEN # "green"
+Colors::UNDEFINED # raises Ruby::Enum::Errors::UninitializedConstantError
+Colors.keys # [ :RED, :GREEN ]
+Colors.values # [ "red", "green" ]
+Colors.to_h # { :RED => "red", :GREEN => "green" }
+```
+
+### Iterating
+
+``` ruby
+Colors.each do |key, enum|
+  # key and enum.key is :RED, :GREEN
+  # enum.value is "red", "green"
+end
+```
+
+## Contributing
 
 You're encouraged to contribute to this gem.
 
 * Fork this project.
 * Make changes, write tests.
-* Updated CHANGELOG.
+* Updated [CHANGELOG](CHANGELOG.md).
 * Make a pull request, bonus points for topic branches.
 
-### Copyright and License
-
-Copyright Daniel Doubrovkine and Contributors, 2013
+## Copyright and License
 
-[MIT License](LICENSE.md)
+Copyright (c) 2013, Daniel Doubrovkine and [Contributors](CHANGELOG.md).
 
+This project is licensed under the [MIT License](LICENSE.md).

data/lib/config/locales/en.yml

@@ -0,0 +1,14 @@
+en:
+  ruby:
+    enum:
+      errors:
+        messages:
+          uninitialized_constant:
+            message: "Uninitialized constant."
+            summary: "The constant %{name}::%{key} has not been defined."
+            resolution: "The enumerated value could not be found in class %{name}. Use 'define' to declare it.\n
+            \_Example:\n
+            \_\_module %{name}\n
+            \_\_\_include Ruby::Enum\n
+            \_\_\_define %{key}, 'value'\n
+            \_\_end"

data/lib/ruby-enum.rb

@@ -1,3 +1,10 @@
+require 'i18n'
+
 require 'ruby-enum/version'
 require 'ruby-enum/enum'
 
+I18n.load_path << File.join(File.dirname(__FILE__), 'config', 'locales', 'en.yml')
+
+require 'ruby-enum/errors/base'
+require 'ruby-enum/errors/uninitialized_constant_error'
+

data/lib/ruby-enum/enum.rb

@@ -2,7 +2,7 @@ module Ruby
   module Enum
 
     attr_reader :key, :value
-    
+
     def initialize(key, value)
       @key = key
       @value = value
@@ -14,36 +14,65 @@ module Ruby
 
     module ClassMethods
 
+      # Define an enumerated value.
+      #
+      # === Parameters
+      # [key] Enumerator key.
+      # [value] Enumerator value.
       def define(key, value)
-        @hash ||= {}
-        @hash[key] = self.new(key, value)
+        @_enum_hash ||= {}
+        @_enum_hash[key] = self.new(key, value)
       end
 
       def const_missing(key)
-        if @hash[key]
-          @hash[key].value
+        if @_enum_hash[key]
+          @_enum_hash[key].value
         else
           raise Ruby::Enum::Errors::UninitializedConstantError.new({ :name => name, :key => key })
         end
       end
 
+      # Iterate over all enumerated values.
+      # Yields a key and an enumerated instance.
       def each(&block)
-        @hash.each do |key, value|
+        @_enum_hash.each do |key, value|
           yield key, value
         end
       end
 
+      # Attempt to parse an enumerated value.
+      #
+      # === Parameters
+      # [s] The string to parse.
+      #
+      # Returns an enumerated value or nil.
       def parse(s)
         s = s.to_s.upcase
-        each do |key, value|
+        each do |key, enum|
           if key.to_s.upcase == s
-            return value.value
+            return enum.value
           end
         end
         nil
-      end      
+      end
+
+      # Returns all enum keys.
+      def keys
+        @_enum_hash.values.map(&:key)
+      end
+
+      # Returns all enum values.
+      def values
+        @_enum_hash.values.map(&:value)
+      end
+
+      def to_h
+        Hash[@_enum_hash.map do |key, enum|
+          [ key, enum.value ]
+        end]
+      end
 
     end
 
   end
-end
+end

data/lib/ruby-enum/errors/base.rb

@@ -0,0 +1,81 @@
+module Ruby
+  module Enum
+    module Errors
+      class Base < StandardError
+
+        # Problem occurred.
+        attr_reader :problem
+
+        # Summary of the problem.
+        attr_reader :summary
+
+        # Suggested problem resolution.
+        attr_reader :resolution
+
+        # Compose the message.
+        # === Parameters
+        # [key] Lookup key in the translation table.
+        # [attributes] The objects to pass to create the message.
+        def compose_message(key, attributes = {})
+          @problem = create_problem(key, attributes)
+          @summary = create_summary(key, attributes)
+          @resolution = create_resolution(key, attributes)
+
+          "\nProblem:\n  #{@problem}"+
+          "\nSummary:\n  #{@summary}"+
+          "\nResolution:\n  #{@resolution}"
+        end
+
+        private
+
+          BASE_KEY = "ruby.enum.errors.messages" #:nodoc:
+
+          # Given the key of the specific error and the options hash, translate the
+          # message.
+          #
+          # === Parameters
+          # [key] The key of the error in the locales.
+          # [options] The objects to pass to create the message.
+          #
+          # Returns a localized error message string.
+          def translate(key, options)
+            ::I18n.translate("#{BASE_KEY}.#{key}", { :locale => :en }.merge(options)).strip
+          end
+
+          # Create the problem.
+          #
+          # === Parameters
+          # [key] The error key.
+          # [attributes] The attributes to interpolate.
+          #
+          # Returns the problem.
+          def create_problem(key, attributes)
+            translate("#{key}.message", attributes)
+          end
+
+          # Create the summary.
+          #
+          # === Parameters
+          # [key] The error key.
+          # [attributes] The attributes to interpolate.
+          #
+          # Returns the summary.
+          def create_summary(key, attributes)
+            translate("#{key}.summary", attributes)
+          end
+
+          # Create the resolution.
+          #
+          # === Parameters
+          # [key] The error key.
+          # [attributes] The attributes to interpolate.
+          #
+          # Returns the resolution.
+          def create_resolution(key, attributes)
+            translate("#{key}.resolution", attributes)
+          end
+
+      end
+    end
+  end
+end

data/lib/ruby-enum/errors/uninitialized_constant_error.rb

@@ -0,0 +1,11 @@
+module Ruby
+  module Enum
+    module Errors
+      class UninitializedConstantError < Base
+        def initialize(attrs)
+          super(compose_message("uninitialized_constant", attrs))
+        end
+      end
+    end
+  end
+end

data/lib/ruby-enum/version.rb

@@ -1,5 +1,5 @@
 module Ruby
   module Enum
-    VERSION = '0.1.0'
+    VERSION = '0.2.1'
   end
 end

data/ruby-enum.gemspec

@@ -8,9 +8,10 @@ Gem::Specification.new do |s|
   s.email = "dblock@dblock.org"
   s.platform = Gem::Platform::RUBY
   s.required_rubygems_version = '>= 1.3.6'
-  s.files = `git ls-files`.split("\n")
+  s.files = Dir['**/*']
   s.require_paths = [ "lib" ]
   s.homepage = "http://github.com/dblock/ruby-enum"
   s.licenses = [ "MIT" ]
   s.summary = "Enum-like behavior for Ruby."
+  s.add_dependency "i18n"
 end

data/spec/ruby-enum/enum_spec.rb

@@ -12,7 +12,25 @@ describe Ruby::Enum do
     Colors::RED.should eq "red"
     Colors::GREEN.should eq "green"
   end
-  context "parse" do
+  it "raises UninitializedConstantError on an invalid constant" do
+    expect { Colors::ANYTHING }.to raise_error Ruby::Enum::Errors::UninitializedConstantError
+  end
+  context "#each" do
+    it "iterates over constants" do
+      keys = []
+      enum_keys = []
+      enum_values = []
+      Colors.each do |key, enum|
+        keys << key
+        enum_keys << enum.key
+        enum_values << enum.value
+      end
+      keys.should == [ :RED, :GREEN ]
+      enum_keys.should == [ :RED, :GREEN ]
+      enum_values.should == [ "red", "green" ]
+    end
+  end
+  context "#parse" do
     it "parses exact value" do
       Colors.parse("red").should == Colors::RED
     end
@@ -26,4 +44,19 @@ describe Ruby::Enum do
       Colors.parse("invalid").should be_nil
     end
   end
+  context "#keys" do
+    it "returns keys" do
+      Colors.keys.should == [ :RED, :GREEN ]
+    end
+  end
+  context "#values" do
+    it "returns values" do
+      Colors.values.should == [ "red", "green" ]
+    end
+  end
+  context "#to_h" do
+    it "returns a hash of key:values" do
+      Colors.to_h.should == { :RED => "red", :GREEN => "green" }
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-enum
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,26 +9,45 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-14 00:00:00.000000000 Z
-dependencies: []
+date: 2013-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: dblock@dblock.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
 - CHANGELOG.md
 - Gemfile
-- LICENSE.md
-- README.md
-- Rakefile
-- lib/ruby-enum.rb
+- Gemfile.lock
+- lib/config/locales/en.yml
 - lib/ruby-enum/enum.rb
+- lib/ruby-enum/errors/base.rb
+- lib/ruby-enum/errors/uninitialized_constant_error.rb
 - lib/ruby-enum/version.rb
+- lib/ruby-enum.rb
 - lib/ruby_enum.rb
+- LICENSE.md
+- pkg/ruby-enum-0.2.0.gem
+- pkg/ruby-enum-0.3.0.gem
+- Rakefile
+- README.md
 - ruby-enum.gemspec
 - spec/ruby-enum/enum_spec.rb
 - spec/ruby-enum/version_spec.rb
@@ -48,7 +67,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 388465617
+      hash: 4593317306755494398
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -57,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Enum-like behavior for Ruby.

data/.gitignore

@@ -1,2 +0,0 @@
-Gemfile.lock
-pkg

data/.rspec

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

data/.travis.yml

@@ -1,6 +0,0 @@
-rvm:
-  - 1.8.7
-  - 1.9.3
-  - 2.0.0
-  - jruby-19mode
-  - rbx-19mode