ruby-enum 0.2.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e0ced60d6ed9e9fb379e0804f7483d97f8469b2
+  data.tar.gz: 8a67751a1fd7777b39e5c1be070ab498875872a7
+SHA512:
+  metadata.gz: f4978a831b5fe81cf79abb6c1568b681e4750a8f6b50a904c32f5d5e9fe2dd7116e6935046f30956d241a93f53e462e20bf66be4fdb72f77ffe47d2773bf41c5
+  data.tar.gz: 8f76f84efced4d354aa73bef8d3da875d2543cc4683bfe5db44adf23c1e748d62e5f5bdcfd0792e1e0b218f7f9c91a676782e9ff35dbb8b719c38df40c51d68c

data/CHANGELOG.md

@@ -1,6 +1,6 @@
-### 0.3.0 (Next Release)
+### 0.3.0 (5/19/2014)
 
-* Your contribution here.
+* Added `Ruby::Enum#map` - [@ArnaudRinquin](https://github.com/ArnaudRinquin).
 
 ### 0.2.1 (5/15/2013)
 

data/Gemfile

@@ -4,3 +4,4 @@ gemspec
 
 gem "rspec"
 gem "rake"
+gem "rubocop", "0.21.0"

data/Gemfile.lock

@@ -1,23 +1,38 @@
 PATH
   remote: .
   specs:
-    ruby-enum (0.2.1)
+    ruby-enum (0.3.0)
       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)
+    ast (2.0.0)
+    diff-lcs (1.2.5)
+    i18n (0.6.9)
+    json (1.8.1)
+    parser (2.1.9)
+      ast (>= 1.1, < 3.0)
+      slop (~> 3.4, >= 3.4.5)
+    powerpack (0.0.9)
+    rainbow (2.0.0)
+    rake (10.3.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.1)
+    rspec-mocks (2.14.6)
+    rubocop (0.21.0)
+      json (>= 1.7.7, < 2)
+      parser (~> 2.1.9)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.5.1)
+    slop (3.5.0)
 
 PLATFORMS
   ruby
@@ -25,4 +40,5 @@ PLATFORMS
 DEPENDENCIES
   rake
   rspec
+  rubocop (= 0.21.0)
   ruby-enum!

data/README.md

@@ -36,6 +36,18 @@ Colors.each do |key, enum|
 end
 ```
 
+### Mapping
+
+``` ruby
+Colors.map do |key, enum|
+  # key and enum.key is :RED, :GREEN
+  # enum.value is "red", "green"
+  [enum.value, key]
+end
+
+# => [ ['red', :RED], ['green', :GREEN] ]
+```
+
 ## Contributing
 
 You're encouraged to contribute to this gem.

data/Rakefile

@@ -7,7 +7,10 @@ require 'rspec/core'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList["spec/**/*_spec.rb"]
+  spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-task :default => :spec
+require 'rubocop/rake_task'
+Rubocop::RakeTask.new(:rubocop)
+
+task default: [:rubocop, :spec]

data/lib/ruby-enum.rb

@@ -7,4 +7,3 @@ 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

@@ -1,6 +1,5 @@
 module Ruby
   module Enum
-
     attr_reader :key, :value
 
     def initialize(key, value)
@@ -13,7 +12,6 @@ module Ruby
     end
 
     module ClassMethods
-
       # Define an enumerated value.
       #
       # === Parameters
@@ -21,25 +19,33 @@ module Ruby
       # [value] Enumerator value.
       def define(key, value)
         @_enum_hash ||= {}
-        @_enum_hash[key] = self.new(key, value)
+        @_enum_hash[key] = new(key, value)
       end
 
       def const_missing(key)
         if @_enum_hash[key]
           @_enum_hash[key].value
         else
-          raise Ruby::Enum::Errors::UninitializedConstantError.new({ :name => name, :key => key })
+          fail 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)
+      def each(&_block)
         @_enum_hash.each do |key, value|
           yield key, value
         end
       end
 
+      # Map all enumerated values.
+      # Yields a key and an enumerated instance.
+      def map(&_block)
+        @_enum_hash.map do |key, value|
+          yield key, value
+        end
+      end
+
       # Attempt to parse an enumerated value.
       #
       # === Parameters
@@ -49,9 +55,7 @@ module Ruby
       def parse(s)
         s = s.to_s.upcase
         each do |key, enum|
-          if key.to_s.upcase == s
-            return enum.value
-          end
+          return enum.value if key.to_s.upcase == s
         end
         nil
       end
@@ -68,11 +72,9 @@ module Ruby
 
       def to_h
         Hash[@_enum_hash.map do |key, enum|
-          [ key, enum.value ]
+          [key, enum.value]
         end]
       end
-
     end
-
   end
 end

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

@@ -2,7 +2,6 @@ module Ruby
   module Enum
     module Errors
       class Base < StandardError
-
         # Problem occurred.
         attr_reader :problem
 
@@ -21,14 +20,13 @@ module Ruby
           @summary = create_summary(key, attributes)
           @resolution = create_resolution(key, attributes)
 
-          "\nProblem:\n  #{@problem}"+
-          "\nSummary:\n  #{@summary}"+
-          "\nResolution:\n  #{@resolution}"
+          "\nProblem:\n  #{@problem}"\
+          "\nSummary:\n  #{@summary}" +           "\nResolution:\n  #{@resolution}"
         end
 
         private
 
-          BASE_KEY = "ruby.enum.errors.messages" #:nodoc:
+        BASE_KEY = 'ruby.enum.errors.messages' #:nodoc:
 
           # Given the key of the specific error and the options hash, translate the
           # message.
@@ -38,9 +36,9 @@ module Ruby
           # [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
+        def translate(key, options)
+          ::I18n.translate("#{BASE_KEY}.#{key}", { locale: :en }.merge(options)).strip
+        end
 
           # Create the problem.
           #
@@ -49,9 +47,9 @@ module Ruby
           # [attributes] The attributes to interpolate.
           #
           # Returns the problem.
-          def create_problem(key, attributes)
-            translate("#{key}.message", attributes)
-          end
+        def create_problem(key, attributes)
+          translate("#{key}.message", attributes)
+        end
 
           # Create the summary.
           #
@@ -60,9 +58,9 @@ module Ruby
           # [attributes] The attributes to interpolate.
           #
           # Returns the summary.
-          def create_summary(key, attributes)
-            translate("#{key}.summary", attributes)
-          end
+        def create_summary(key, attributes)
+          translate("#{key}.summary", attributes)
+        end
 
           # Create the resolution.
           #
@@ -71,11 +69,10 @@ module Ruby
           # [attributes] The attributes to interpolate.
           #
           # Returns the resolution.
-          def create_resolution(key, attributes)
-            translate("#{key}.resolution", attributes)
-          end
-
+        def create_resolution(key, attributes)
+          translate("#{key}.resolution", attributes)
+        end
       end
     end
   end
-end
+end

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

@@ -3,9 +3,9 @@ module Ruby
     module Errors
       class UninitializedConstantError < Base
         def initialize(attrs)
-          super(compose_message("uninitialized_constant", attrs))
+          super(compose_message('uninitialized_constant', attrs))
         end
       end
     end
   end
-end
+end

data/lib/ruby-enum/version.rb

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

data/ruby-enum.gemspec

@@ -1,17 +1,17 @@
-$:.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require 'ruby-enum/version'
 
 Gem::Specification.new do |s|
-  s.name = "ruby-enum"
+  s.name = 'ruby-enum'
   s.version = Ruby::Enum::VERSION
-  s.authors = [ "Daniel Doubrovkine" ]
-  s.email = "dblock@dblock.org"
+  s.authors = ['Daniel Doubrovkine']
+  s.email = 'dblock@dblock.org'
   s.platform = Gem::Platform::RUBY
   s.required_rubygems_version = '>= 1.3.6'
   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"
+  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

@@ -3,20 +3,20 @@ require 'spec_helper'
 class Colors
   include Ruby::Enum
 
-  define :RED, "red"
-  define :GREEN, "green"
+  define :RED, 'red'
+  define :GREEN, 'green'
 end
 
 describe Ruby::Enum do
-  it "returns an enum value" do
-    Colors::RED.should eq "red"
-    Colors::GREEN.should eq "green"
+  it 'returns an enum value' do
+    Colors::RED.should eq 'red'
+    Colors::GREEN.should eq 'green'
   end
-  it "raises UninitializedConstantError on an invalid constant" 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
+  context '#each' do
+    it 'iterates over constants' do
       keys = []
       enum_keys = []
       enum_values = []
@@ -25,38 +25,48 @@ describe Ruby::Enum do
         enum_keys << enum.key
         enum_values << enum.value
       end
-      keys.should == [ :RED, :GREEN ]
-      enum_keys.should == [ :RED, :GREEN ]
-      enum_values.should == [ "red", "green" ]
+      keys.should eq [:RED, :GREEN]
+      enum_keys.should eq [:RED, :GREEN]
+      enum_values.should eq %w(red green)
     end
   end
-  context "#parse" do
-    it "parses exact value" do
-      Colors.parse("red").should == Colors::RED
+  context '#map' do
+    it 'maps constants' do
+      key_key_values = Colors.map do |key, enum|
+        [key, enum.key, enum.value]
+      end
+      key_key_values.count.should eq 2
+      key_key_values[0].should eq [:RED, :RED, 'red']
+      key_key_values[1].should eq [:GREEN, :GREEN, 'green']
+    end
+  end
+  context '#parse' do
+    it 'parses exact value' do
+      Colors.parse('red').should == Colors::RED
     end
-    it "is case-insensitive" do
-      Colors.parse("ReD").should == Colors::RED
+    it 'is case-insensitive' do
+      Colors.parse('ReD').should == Colors::RED
     end
-    it "returns nil for a null value" do
+    it 'returns nil for a null value' do
       Colors.parse(nil).should be_nil
     end
-    it "returns nil for an invalid value" do
-      Colors.parse("invalid").should be_nil
+    it 'returns nil for an invalid value' do
+      Colors.parse('invalid').should be_nil
     end
   end
-  context "#keys" do
-    it "returns keys" do
-      Colors.keys.should == [ :RED, :GREEN ]
+  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" ]
+  context '#values' do
+    it 'returns values' do
+      Colors.values.should == %w(red green)
     end
   end
-  context "#to_h" do
-    it "returns a hash of key:values" do
-      Colors.to_h.should == { :RED => "red", :GREEN => "green" }
+  context '#to_h' do
+    it 'returns a hash of key:values' do
+      Colors.to_h.should == { RED: 'red', GREEN: 'green' }
     end
   end
 end

data/spec/ruby-enum/version_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Ruby::Enum do
-  it "has a version" do
+  it 'has a version' do
     Ruby::Enum::VERSION.should_not be_nil
   end
 end

data/spec/spec_helper.rb

@@ -3,4 +3,3 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'rubygems'
 require 'rspec'
 require 'ruby-enum'
-

metadata

@@ -1,30 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: ruby-enum
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-15 00:00:00.000000000 Z
+date: 2014-05-19 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: 
@@ -44,8 +41,6 @@ files:
 - 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
@@ -55,29 +50,25 @@ files:
 homepage: http://github.com/dblock/ruby-enum
 licenses:
 - MIT
+metadata: {}
 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: 4593317306755494398
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Enum-like behavior for Ruby.
 test_files: []