safe-hash-enum 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12b4195219a8cbc129dbe7355fceb9492ff234b71f762a3a79ad714ef1fb828d
-  data.tar.gz: 8fdbbfd2d882048ba6e79eec9ec7c44116019bd4da96bc68ae3f5e054b34bece
+  metadata.gz: f3d0a446cc2c0ed1557281434982bb76b03705b164e37d36192579c77ad0ebfa
+  data.tar.gz: d2244782d1f0d6a5a572758e378acd2647a736f4744262f00fe5e07206ff24c8
 SHA512:
-  metadata.gz: a85934bace64fd4ac0c86bad414ef5cc44914dcc5322e30444cdc1f845311c626ed61109f43efe81a76a973eb26c1ea5b2de6141ffdba75a8d7b7f9800aed0bb
-  data.tar.gz: a32a205c45a53d4f62d6118d348de3969989e1bafe16e9fbbc654fdcf5df711a30fc57db2c85edbdc56b0c5d10332e03947037b86e5700424dab280dfbeb85f6
+  metadata.gz: 9490216122e2b2c8e2fde9d294795e226ba7ffa2238b547372f2a5351897183d064da1cc8fdb13b77258fb1b2092d9e82ccf2df5d6144eb853da27eceb97bc06
+  data.tar.gz: 5cc9dd5e1a628dcbed7c1a6e07271c864668a2cac672ddc265d2bc1511d4568ad3bf1bc232d5866e005cab6ab4b02783eb3120ca96b161209865a091b148c6be

data/README.md

@@ -27,15 +27,22 @@ class Side < Enum::Base
 end
 ```
 
-Now get a safely defined hash with the `enum` method with its `Symbol` or `String` type as argument. If there is no defined such hash `Enum::TokenNotFoundError` exception will be raised. And this is the **safety** - you will be noticed about the problem and fix it by introducing a new hash or fixing the source of the invalid hash. While others implementations of enums in Ruby (that I know) just silently ignore invalid values returning `nil` this one will raise the exception **always**. Example of usage:
+Now get a safely defined key with the `enum` method with its `Symbol` or `String` type as argument. If there is no such key,  `Enum::TokenNotFoundError` exception will be raised. And this is the **safety** - you will be noticed about the problem and fix it by introducing a new hash or fixing the source of the invalid hash. While others implementations of enums in Ruby (that I know) just silently ignore invalid values returning `nil` this one will raise the exception **always**. Example of usage:
 
 ```ruby
-Side.enum(:left) # => {:left => "my_left"}
-Side.enum('left') # => {:left => "my_left"}
+Side.enum(:left) # => :left
+Side.enum('left') # => :left
 Side.enum(:invalid) # => Enum::TokenNotFoundError: token 'invalid'' not found in Side
 Side.enum('invalid') # => Enum::TokenNotFoundError: token 'invalid'' not found in Side
 ```
 
+To get the real enum, the hash representing the enum, use `real_enum` method :
+
+```ruby
+ Side.real_enum(:left) # => {:left => "my_left"}
+ Side.real_enum('left') # => {:left => "my_left"}
+```
+
 Get value of hash by token (String or Symbol):
 
 ```ruby

data/lib/enum/base.rb

@@ -46,7 +46,7 @@ module Enum
       end
 
       def value(t)
-        e = enum(t)
+        e = real_enum(t)
         e[t]
       end
 

data/lib/enum/version.rb

@@ -1,3 +1,3 @@
 module Enum
-  VERSION = '0.4.4'
+  VERSION = '0.4.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safe-hash-enum
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - NETIKA real estate solution s.a.