safe-enum 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b46454a6c48cc776ce859c3a4ff8c6913b78e3d
-  data.tar.gz: aa98b2d7f30253991c5d5ad4d2f9a9e550fbb648
+  metadata.gz: 00f1140cec43431cbc879909a1b626628e041a6a
+  data.tar.gz: 08542bb0baba436e8eb2e5b79db64d5ecdabed00
 SHA512:
-  metadata.gz: 32c878b5aeaa9e3443f8c490b21d0d34fe80d4213eee4d8e2f62b6d033886b0a8d46ad1f4a6210e3eca80c3edad2e96ecba7b519f61ac4acfd0d672ad1c8c21e
-  data.tar.gz: 20c18d7366e5732cf8e4fd64886bbe0efa17d0060863011c43c6aecb5cf53cdf5528e83041c7b455214a6e91b866680d12854ec0e1cc3fdd08f8358b5a779e4c
+  metadata.gz: 30e94b5da5fc242107ab922e6ec0f52da85e82092f32ae5dcb047258aefad7cfb1d74936abdcd76cb1f3ab6dc18dd08a09c3b9af7131031ee1738f8fe8254d77
+  data.tar.gz: 2e14ca8f1d0e9b2858332b44d4f37327ffaf043e85f91887104041bffacf08d29980583dff7f15957cbf3f39254379a0262adaf516748926d1da3f6565966253

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

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 'enum', require: 'enum'
+gem 'safe-enum', require: 'enum'
 ```
 
 And then execute:
@@ -17,7 +17,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install enum
+    $ gem install safe-enum
 
 ## Usage
 
@@ -28,7 +28,7 @@ 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 returing `nil` this one will raise the exception **always**. Example of usage:
+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:
 
 ```ruby
 Side.take(:left) # => "left"
@@ -59,6 +59,43 @@ Side.name(:invalid) # => Enum::TokenNotFoundError: token 'invalid'' not found in
 
 > If you don't have installed `I18n` in your project `NameError` exception will be raised on the `name` method call.
 
+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
+class Table
+  extend Enum::Predicates
+
+  attr_accessor :side
+
+  enumerize :side, Side
+end
+
+@table = Table.new
+@table.side_is?(:left) # => false
+@table.side_is?(nil) # => false
+
+@table.side = Side.take(:left)
+@table.side_is?(:left) # => true
+@table.side_is?(:right) # => false
+@table.side_is?(nil) # => false
+@table.side_is?(:invalid) # => Enum::TokenNotFoundError: token 'invalid'' not found in the enum Side
+
+@table.side = 'invalid'
+@table.side_is?(nil) # => false
+@table.side_is?(: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?`.
+
+It's possible to get index of an enum value with `index` method. It can be convenient in some circumstances:
+
+```ruby
+class WeekDay < Enum::Base
+  values :sunday, :monday, :tuesday, :wednesday, :thusday, :friday, :saturday
+end
+WeekDay.index(:sunday) == Date.new(2015, 9, 13).wday # => true
+WeekDay.index(:monday) # => 1
+```
+
 ## 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.

data/lib/enum.rb

@@ -1,3 +1,4 @@
 require 'enum/version'
 require 'enum/token_not_found_error'
 require 'enum/base'
+require 'enum/predicates'

data/lib/enum/base.rb

@@ -14,7 +14,7 @@ module Enum
       end
 
       def all
-        store.to_a
+        history
       end
 
       def take(t)
@@ -29,6 +29,10 @@ module Enum
         translate(take(t))
       end
 
+      def index(token)
+        history.index(take(token))
+      end
+
       protected
 
       def store
@@ -39,6 +43,14 @@ module Enum
         @store = set
       end
 
+      def history
+        @history ||= Array.new
+      end
+
+      def history=(ary)
+        @history = ary
+      end
+
       def translate(token, options = {})
         I18n.t(token, scope: "enum.#{self}", exception_handler: proc do
           if superclass == Enum::Base
@@ -55,10 +67,12 @@ module Enum
 
       def add_value(val)
         store.add(val)
+        history.push(val)
       end
 
       def init_child_class(child)
         child.store = self.store.clone
+        child.history = self.history.clone
       end
 
     end

data/lib/enum/predicates.rb

@@ -0,0 +1,13 @@
+module Enum
+  module Predicates
+    def enumerize(field, enum)
+      define_method("#{field}_is?") do |other|
+        if (field_value = public_send(field)) && other
+          enum.take(field_value) == enum.take(other)
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/enum/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safe-enum
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrey Koleshko
@@ -86,6 +86,7 @@ files:
 - enum.gemspec
 - lib/enum.rb
 - lib/enum/base.rb
+- lib/enum/predicates.rb
 - lib/enum/token_not_found_error.rb
 - lib/enum/version.rb
 homepage: https://github.com/mezuka/enum