safe-hash-enum 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 304e864000cd9009e884b5a9722d045453a575a53cc8ad550d3a003934e3cbe7
-  data.tar.gz: 2a20b309e7588c9bc35c5795eea9f56bd47203227e7e431df2191fea2945c82f
+  metadata.gz: '072928a0df967986d036f27aa5b5dd2db382b1f72be26d95b99311db6bb24ace'
+  data.tar.gz: 93bdc11f44febe4ec26c656f30116719d019e4550cbfbf02701d71e01072f8f1
 SHA512:
-  metadata.gz: e2fae3be5f296d03585737378424d23eabc6aced6f782202378fd6ec1d7031ccf7d9977a12ab7b7eff0ba0ee6d5b8d642662a08075c97b6301c1fd0b3d4e89df
-  data.tar.gz: 02617f7cc9c0a266a49be008b2b57800540d8864ce7627d2aa5de2efcd2a9a054be114d15f5374d97aee43a16af75c25e2ecd2da8854e361c476b64c2ee61127
+  metadata.gz: 0c6256bc0a9f820b3f0a094b8bbf4e5ac487f16da6e7e3277f374e08742d7e5fbc6c556fcbfcdcf62a592c0453a8c3e39e1348ea014510bb69d880c0658a2a04
+  data.tar.gz: d2b913cc32cf59188b245a86164874e285102fd9eacdf2506101a0d9715977f95cb13dd72a1830a80df12d6701d803f4ec7f40105dcc0501f0cdb579f70d9ee0

data/README.md

@@ -1,14 +1,13 @@
-![Travis](https://travis-ci.org/mezuka/enum.svg)
 # Enum
 
-This is a very basic implementation of enums in Ruby. The cornerstone of the library is **safety**.
+This is a very basic implementation of enums in Ruby. Forked from [mezuka/enum](https://github.com/mezuka/enum). The cornerstone of the mezuka library is **safety**. This implementation uses **hashes** instead of strings to create enums. It is a work in progress and evolves depending on developers needs.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'safe-enum'
+gem 'safe-hash-enum'
 ```
 
 And then execute:
@@ -17,62 +16,80 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install safe-enum
+    $ gem install safe-hash-enum
 
 ## Usage
 
 Define set of enums with code like this:
 ```ruby
 class Side < Enum::Base
-  values :left, :right
+  values({left: 'my_left', right: 'my_right'})
 end
 ```
 
-Now get a value with the `enum` method safely defined values by argument with its `Symbol` or `String` type. If there is no defined such value `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 value or fixing a source of the invalid value. 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 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:
 
 ```ruby
-Side.enum(:left) # => "left"
-Side.enum('left') # => "left"
-Side.enum(:invalid) # => Enum::TokenNotFoundError: token 'invalid'' not found in the enum Side
-Side.enum('invalid') # => Enum::TokenNotFoundError: token 'invalid'' not found in the enum Side
+Side.enum(:left) # => {:left => "my_left"}
+Side.enum('left') # => {:left => "my_left"}
+Side.enum(:invalid) # => Enum::TokenNotFoundError: token 'invalid'' not found in Side
+Side.enum('invalid') # => Enum::TokenNotFoundError: token 'invalid'' not found in Side
+```
+
+Get value of hash by token (String or Symbol):
+
+```ruby
+Side.value(:left) # => "my_left"
+Side.value('left') # => "my_left"
+Side.value(:invalid) # => Enum::TokenNotFoundError: token 'invalid'' not found in Side
+Side.value('invalid') # => Enum::TokenNotFoundError: token 'invalid'' not found in Side
 ```
 
 Get all defined enum values with the `all` method:
 
 ```ruby
-Side.all # => ['left', 'rigth', 'whole']
+Side.all # => [:left, :right]
 ```
 
-> Order or the returned values in the same as their definition. It's guaranteed.
+> Order of the returned values in the same as their definition. It's guaranteed.
 
 In order to get array of defined enums safely use `enums` method:
 
 ```ruby
- Side.enums(:left, :right) # => ['left', 'right']
+ Side.enums(:left, :right) # => [{:left => "my_left"}, {:right => "my_right"}]
 ```
 
-If you have installed `I18n` in your application feel free to use `name` method to retreive the values' translations. For the given example the possible translation structure in `yml` format is the following:
+To get the token by value use `find_value` method :
 
-```yml
-en:
-  enum:
-    Side:
-      left: 'Left'
-      right: 'Right'
+```ruby
+ Side.find_value('my_left') # => {:left => "my_left"}
 ```
 
-The `name` method usage example:
+To get the index of a token use `index` method :
 
 ```ruby
-Side.name(:left) # => "Left"
-Side.name('left') # => "Left"
-Side.name(:right) # => "Right"
-Side.name('right') # => "Right"
-Side.name(:invalid) # => Enum::TokenNotFoundError: token 'invalid'' not found in the enum Side
+ Side.index(:left) # => 0
+ Side.index(:right) # => 1
 ```
 
-> If you don't have installed `I18n` in your project `NameError` exception will be raised on the `name` method call.
+Note : the predicates feature in mezuka/enum isn't implemented yet with hashes
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/netika-res/enum. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+---
+## TODO ADAPT FROM MEZUKA (not yet implemented with hash)
 Consider the case when we have an object with a field with only enum values. Extend the class of this object by `Enum::Predicates` and use `enumerize` method to generate predicates. This is a more convenient way matching current value of the field with an enum value. Usage the predicate methods is **safe** also. It means that you can't pass to the method invalid enum value neither can have an invalid value in the field:
 
 ```ruby
@@ -113,19 +130,4 @@ WeekDay.index(:sunday) == Date.new(2015, 9, 13).wday # => true
 WeekDay.index(:monday) # => 1
 WeekDay.indexes # => [0, 1, 2, 3, 4, 5, 6]
 ```
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/mezuka/enum. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+---

data/lib/enum/base.rb

@@ -40,6 +40,11 @@ module Enum
         end
       end
 
+      def value(t)
+        e = enum(t)
+        e[t]
+      end
+
       def find_value(v)
         key = nil
         store.each do |e|

data/lib/enum/version.rb

@@ -1,3 +1,3 @@
 module Enum
-  VERSION = '0.4.2'
+  VERSION = '0.4.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safe-hash-enum
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - NETIKA real estate solution s.a.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-18 00:00:00.000000000 Z
+date: 2019-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler