safe-enum 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00f1140cec43431cbc879909a1b626628e041a6a
-  data.tar.gz: 08542bb0baba436e8eb2e5b79db64d5ecdabed00
+  metadata.gz: b01a24ce4b8682ef047734ceda2a6d42f7f20654
+  data.tar.gz: 344c9fbee4e130f694c287e4a8a2a5e29e063126
 SHA512:
-  metadata.gz: 30e94b5da5fc242107ab922e6ec0f52da85e82092f32ae5dcb047258aefad7cfb1d74936abdcd76cb1f3ab6dc18dd08a09c3b9af7131031ee1738f8fe8254d77
-  data.tar.gz: 2e14ca8f1d0e9b2858332b44d4f37327ffaf043e85f91887104041bffacf08d29980583dff7f15957cbf3f39254379a0262adaf516748926d1da3f6565966253
+  metadata.gz: f57bf5d384b5d282486dacd279fd14380acd61dc04f76e871c93d93ecdb5f3bec5e6f6772744c307c2e5b140b73c712e9a0f2eb7d3476609d955aef611884508
+  data.tar.gz: db9c679dcbfbcd4f785d732b903daf73fb8b73f691c212404a9dbd95ac4366879f1c3119e2746bdf3c7dd23c339ac171a21ba80cf8cc0c4523f8f1a0d6bed0ba

data/README.md

@@ -8,7 +8,7 @@ This is a very basic implementation of enums in Ruby. The cornerstone of the lib
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'safe-enum', require: 'enum'
+gem 'safe-enum'
 ```
 
 And then execute:
@@ -28,13 +28,27 @@ class Side < Enum::Base
 end
 ```
 
-Now `take` 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 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:
 
 ```ruby
-Side.take(:left) # => "left"
-Side.take('left') # => "left"
-Side.take(:invalid) # => Enum::TokenNotFoundError: token 'invalid'' not found in the enum Side
-Side.take('invalid') # => Enum::TokenNotFoundError: token 'invalid'' not found in the enum Side
+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
+```
+
+Get all defined enum values with the `all` method:
+
+```ruby
+Side.all # => ['left', 'rigth', 'whole']
+```
+
+> Order or 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']
 ```
 
 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:
@@ -74,7 +88,7 @@ end
 @table.side_is?(:left) # => false
 @table.side_is?(nil) # => false
 
-@table.side = Side.take(:left)
+@table.side = Side.enum(:left)
 @table.side_is?(:left) # => true
 @table.side_is?(:right) # => false
 @table.side_is?(nil) # => false
@@ -83,6 +97,9 @@ end
 @table.side = 'invalid'
 @table.side_is?(nil) # => false
 @table.side_is?(:left) # => Enum::TokenNotFoundError: token 'invalid'' not found in the enum Side
+@table.side_any?(:left, :right) # => true
+@table.side_any?(:right) # => false
+@table.side_any?(:invalid, :left) # => Enum::TokenNotFoundError: token 'invalid'' not found in the enum Side
 ```
 > If you pass to the predicate `nil` or have `nil` value in the field the result will be always `false`. If you want to check that the field is `nil` just use Ruby's standard method `nil?`.
 
@@ -94,6 +111,7 @@ class WeekDay < Enum::Base
 end
 WeekDay.index(:sunday) == Date.new(2015, 9, 13).wday # => true
 WeekDay.index(:monday) # => 1
+WeekDay.indexes # => [0, 1, 2, 3, 4, 5, 6]
 ```
 
 ## Development

data/lib/enum/base.rb

@@ -17,7 +17,19 @@ module Enum
         history
       end
 
-      def take(t)
+      def indexes
+        (0...store.size).to_a
+      end
+
+      def include?(token)
+        store.include?(token.to_s)
+      end
+
+      def enums(*tokens)
+        tokens.map { |token| enum(token) }
+      end
+
+      def enum(t)
         ts = t.to_s
         unless store.include?(ts)
           raise(TokenNotFoundError, "token '#{t}'' not found in the enum #{self}")
@@ -26,11 +38,11 @@ module Enum
       end
 
       def name(t)
-        translate(take(t))
+        translate(enum(t))
       end
 
       def index(token)
-        history.index(take(token))
+        history.index(enum(token))
       end
 
       protected

data/lib/enum/predicates.rb

@@ -3,11 +3,16 @@ module Enum
     def enumerize(field, enum)
       define_method("#{field}_is?") do |other|
         if (field_value = public_send(field)) && other
-          enum.take(field_value) == enum.take(other)
+          enum.enum(field_value) == enum.enum(other)
         else
           false
         end
       end
+
+      define_method("#{field}_any?") do |*others|
+        others.each { |other| enum.enum(other) } # make sure that all others values are valid enums
+        others.any? { |other| public_send("#{field}_is?", other) }
+      end
     end
   end
 end

data/lib/enum/version.rb

@@ -1,3 +1,3 @@
 module Enum
-  VERSION = "0.2.0"
+  VERSION = '0.3.0'
 end

data/lib/safe-enum.rb

@@ -0,0 +1 @@
+require 'enum'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safe-enum
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrey Koleshko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-14 00:00:00.000000000 Z
+date: 2016-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,6 +89,7 @@ files:
 - lib/enum/predicates.rb
 - lib/enum/token_not_found_error.rb
 - lib/enum/version.rb
+- lib/safe-enum.rb
 homepage: https://github.com/mezuka/enum
 licenses:
 - MIT
@@ -109,8 +110,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Enum implementation
 test_files: []
+has_rdoc: