safe-hash-enum 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 24ae9a6403ab1d2473b5a534cbbecaea25626dddd17cd284295737e5f90d0917
+  data.tar.gz: fc5571584592356f078f0057eafde28f1ae17d0ef3a542327d42e3925935f2de
+SHA512:
+  metadata.gz: 80f5574bf058de1c7a1a0ce2c5fd3d2459bac7e268a4e153722a2ac29116afe95a762db1374f2e40ac7d3c548e8207360d236d22f193317dfe51f6430498dd6c
+  data.tar.gz: 7c8f9b71f667c24530bb15738fe3c397ce50a12a8b05b2ae0cc18d445f2f764cb26512a9bfc8ea2c94860b5ecce600a346eedd346b71b764ace00c48cc77fdde

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in enum.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Andrey Koleshko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,131 @@
+![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**.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'safe-enum'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install safe-enum
+
+## Usage
+
+Define set of enums with code like this:
+```ruby
+class Side < Enum::Base
+  values :left, :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:
+
+```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
+```
+
+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:
+
+```yml
+en:
+  enum:
+    Side:
+      left: 'Left'
+      right: 'Right'
+```
+
+The `name` method usage example:
+
+```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
+```
+
+> 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.enum(: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
+@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?`.
+
+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
+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/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "enum"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/enum.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "safe-hash-enum"
+  spec.version       = Enum::VERSION
+  spec.authors       = ["NETIKA real estate solution s.a."]
+  spec.email         = ["pierre.streel@netika.com"]
+
+  spec.summary       = %q{Enum implementation}
+  spec.description   = %q{This is a implementation of enums in Ruby.}
+  spec.homepage      = "https://github.com/netika-res/enum"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "i18n"
+end

data/lib/Stereotype.rb

@@ -0,0 +1,3 @@
+class Stereotype < SafeEnum::Enum::Base
+  values({left: 'my_left', right: 'my_right', whole: 'my_whole'})
+end

data/lib/enum.rb

@@ -0,0 +1,13 @@
+require 'enum/token_not_found_error'
+require 'enum/init_not_hash_error'
+require 'enum/key_in_use_error'
+require 'enum/base'
+require 'enum/predicates'
+
+module Enum
+  def self.[](*ary)
+    Class.new(Base) do
+      values(*ary)
+    end
+  end
+end

data/lib/enum/base.rb

@@ -0,0 +1,103 @@
+require 'set'
+
+module Enum
+  class Base < BasicObject
+    class << self
+      def inherited(child)
+        return if self == Enum
+
+        init_child_class(child)
+      end
+
+      def values(*ary)
+        add_value(ary.first) if ary.first
+      end
+
+      def all
+        history.to_a
+      end
+
+      def indexes
+        (0...store.size).to_a
+      end
+
+      def include?(token)
+        history.include?(token.to_sym)
+      end
+
+      def enums(*tokens)
+        tokens.map { |token| enum(token) }
+      end
+
+      def enum(t)
+        ts = t.to_sym
+        store[index(t)]
+      end
+
+      def exists(token)
+        unless history.include?(token.to_sym)
+          raise(TokenNotFoundError, "token '#{token}'' not found in #{self}")
+        end
+      end
+
+=begin        def name(t)
+        translate(enum(t))
+      end
+=end
+      def index(token)
+        exists(token)
+        store.index do |h|
+          key, value = h.first
+          key == token.to_sym
+        end
+      end
+
+      protected
+
+      def store
+        @store ||= Array.new
+      end
+
+      def store=(ary)
+        @store = ary
+      end
+
+      def history
+        @history ||= Set.new
+      end
+
+      def history=(set)
+        @history = set
+      end
+
+=begin        def translate(token, options = {})
+        I18n.t(token, scope: "enum.#{self}", exception_handler: proc do
+          if superclass == Enum::Base
+            I18n.t(token, options.merge(scope: "enum.#{self}"))
+          else
+            superclass.translate(token, exception_handler: proc do
+              I18n.t(token, scope: "enum.#{self}")
+            end)
+          end
+        end)
+      end
+=end
+      private
+
+      def add_value(val)
+        raise(InitNotHashError, "'#{val}' is not a hash and cannot be processed") unless val.is_a? Hash
+        val.each do |newKey, newValue|
+          raise(KeyInUseError, "'#{key}' is already a key existing in enum") if history.include?(newKey.to_sym)
+          store.push(Hash[newKey, newValue])
+          history.add(newKey)
+        end
+      end
+
+      def init_child_class(child)
+        child.store = self.store.clone
+        child.history = self.history.clone
+      end
+
+    end
+  end
+end

data/lib/enum/init_not_hash_error.rb

@@ -0,0 +1,4 @@
+module Enum
+  class InitNotHashError < StandardError
+  end
+end

data/lib/enum/key_in_use_error.rb

@@ -0,0 +1,4 @@
+module Enum
+  class KeyInUseError < StandardError
+  end
+end

data/lib/enum/predicates.rb

@@ -0,0 +1,19 @@
+module Enum
+  module Predicates
+    #TODO : check if still working with hashes instead of strings
+    def enumerize(field, enum)
+      define_method("#{field}_is?") do |other|
+        if (field_value = public_send(field)) && 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/token_not_found_error.rb

@@ -0,0 +1,4 @@
+module Enum
+  class TokenNotFoundError < StandardError
+  end
+end

data/lib/enum/version.rb

@@ -0,0 +1,3 @@
+module Enum
+  VERSION = '0.4.0'
+end

data/lib/safe-enum.rb

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

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: safe-hash-enum
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- NETIKA real estate solution s.a.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is a implementation of enums in Ruby.
+email:
+- pierre.streel@netika.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- enum.gemspec
+- lib/Stereotype.rb
+- lib/enum.rb
+- lib/enum/base.rb
+- lib/enum/init_not_hash_error.rb
+- lib/enum/key_in_use_error.rb
+- lib/enum/predicates.rb
+- lib/enum/token_not_found_error.rb
+- lib/enum/version.rb
+- lib/safe-enum.rb
+homepage: https://github.com/netika-res/enum
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.10
+signing_key: 
+specification_version: 4
+summary: Enum implementation
+test_files: []