meta_enum 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2613b743e3671c160c9e9402e181e49e300b4cbf0d89e8c42ed93299f8095a2f
+  data.tar.gz: 4fb9192c6bcfb1096a6b605a574f975e00247662670b7cf51e2744a5867ff9ee
+SHA512:
+  metadata.gz: 712fc2fddf6c361a890da5c24ce063556b0289d8bf437ccbc68b7051f501e7839a4926dafddc83bfbca055e8e206797c20117865586990f9e5b7c5eea75e0e26
+  data.tar.gz: a43af11ac01bd954776e9ddb41d557c06707cb1941e8374c7bafcffbb4b1845968699528dd56b7e5a0733e32c085b581f7a5b9c540c0d20f66684b5cff40acca

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.envrc
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in meta_enum.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    meta_enum (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    method_source (0.9.0)
+    minitest (5.11.1)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  meta_enum!
+  minitest (~> 5.0)
+  pry (~> 0.11.3)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jack Christensen
+
+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,90 @@
+# MetaEnum
+
+MetaEnum is a library for handling enum types in Ruby. It makes it easy to
+convert between external numbers and internal names.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'meta_enum'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install meta_enum
+
+## Usage
+
+Create a enum type:
+
+```ruby
+require 'meta_enum'
+
+ColorType = MetaEnum::Type.new(red: 0, green: 1, blue: 2)
+```
+
+Use the `[]` operator to lookup a value by name:
+
+```ruby
+ColorType[:green] # => #<MetaEnum::Value: 1 => green}>
+```
+
+Or lookup by number:
+
+```ruby
+ColorType[1] # => #<MetaEnum::Value: 1 => green}>
+```
+
+Values can also be easily compared with numbers or names:
+
+```ruby
+ColorType[:green] == 1 # => true
+ColorType[:green] == :green # => true
+```
+
+Missing names would almost always be a programming error, so that will raise an exception.
+
+```ruby
+ColorType[:purple] # => raises: KeyError: key not found: :purple
+```
+
+But missing numbers could mean that there are values defined externally we do not know about. So it is preferable not to raise an exception.
+
+```ruby
+ColorType[42] # => #<MetaEnum::MissingValue: 42}>
+```
+
+Number and name can be retrieved from a `MetaEnum::Value`
+
+```ruby
+v = ColorType[:red] # => #<MetaEnum::Value: 0 => red}>
+v.number # => 0
+v.name # => :red
+```
+
+Values can have extra associated data.
+
+```ruby
+AgeType = MetaEnum::Type.new(child: [0, "Less than 18"], adult: [1, "At least 18"])
+AgeType[:child].data # => "Less than 18"
+```
+
+## 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/ccsalespro/meta_enum.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "meta_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.
+
+require "pry"
+Pry.start

data/bin/setup

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

data/lib/meta_enum/missing_value.rb

@@ -0,0 +1,30 @@
+module MetaEnum
+  class MissingValue
+    attr_reader :number, :type
+
+    def initialize(number, type)
+      @number = Integer(number)
+      @type = type
+      freeze
+    end
+
+    def name; :missing_value; end
+    def data; nil; end
+
+    def ==(other)
+      other = type[other]
+      number == other.number && type == other.type
+
+    # type[] will raise for certain bad keys. Those are obviously not equal so return false.
+    rescue ArgumentError, KeyError
+      false
+    end
+
+    def to_i; number; end
+    def to_s; name.to_s; end
+
+    def inspect
+      "#<#{self.class}: #{number}}>"
+    end
+  end
+end

data/lib/meta_enum/type.rb

@@ -0,0 +1,75 @@
+require 'set'
+
+module MetaEnum
+  class Type
+    attr_reader :values, :values_by_number, :values_by_name
+
+    # Initialize takes a single hash of name to number.
+    #
+    # e.g. MetaEnum::Type.new(red: 0, green: 1, blue: 2)
+    #
+    # Additional data can also be associated with each value by passing an array
+    # of [number, extra data]. This can be used for additional description or
+    # any other reason.
+    #
+    # e.g. MetaEnum::Type.new(small: [0, "Less than 10], large: [1, "At least 10"]
+    def initialize(values)
+      @values_by_number = {}
+      @values_by_name = {}
+      @values = Set.new
+
+      values.each do |name, number_and_data|
+        number_and_data = Array(number_and_data)
+        v = Value.new number_and_data[0], name, number_and_data[1], self
+        raise ArgumentError, "duplicate number: #{v.number}" if @values_by_number.key? v.number
+        raise ArgumentError, "duplicate name: #{v.name}" if @values_by_name.key? v.name
+        @values_by_number[v.number] = v
+        @values_by_name[v.name] = v
+        @values.add(v)
+      end
+
+      @values_by_number.freeze
+      @values_by_name.freeze
+      @values.freeze
+      freeze
+    end
+
+    # [] is a "do what I mean" operator. It returns the Value from this type depending on the key.
+    #
+    # When key is a symbol, it is considered the name of the Value to return.
+    # Since symbols are used from number, it is considered an error if the key is
+    # not found and it raises an exception.
+    #
+    # When key can be converted to an integer by Integer(), then it is
+    # considered the number of the Value to return. Retrieving by number is
+    # presumed to converting from external data where a missing value should not
+    # be considered fatal. In this case it returns a MissingValue is with number
+    # as the key. This allows a Type to only specify the values is needs while
+    # passing through the others unmodified.
+    #
+    # Finally, when key is a MetaEnum::Value, it is simply returned (unless it
+    # belongs to a different Type in which case an ArgumentError is raised).
+    #
+    # See #values_by_number and #values_by_name for non-fuzzy value selection.
+    def [](key)
+      case key
+      when Value, MissingValue
+        raise ArgumentError, "wrong type" unless key.type == self
+        key
+      when Symbol
+        values_by_name.fetch(key)
+      else
+        key = Integer(key)
+        values_by_number.fetch(key) { MissingValue.new key, self }
+      end
+    end
+
+    def inspect
+      sprintf('#<%s: {%s}>', self.class, values.to_a.map { |v| "#{v.name}: #{v.number}"}.join(", "))
+    end
+
+    def size
+      values.size
+    end
+  end
+end

data/lib/meta_enum/value.rb

@@ -0,0 +1,28 @@
+module MetaEnum
+  class Value
+    attr_reader :number, :name, :data, :type
+
+    def initialize(number, name, data, type)
+      @number = Integer(number)
+      @name = name.to_sym
+      @data = data
+      @type = type
+      freeze
+    end
+
+    def ==(other)
+      equal?(other) || equal?(type[other])
+
+    # type[] will raise for certain bad keys. Those are obviously not equal so return false.
+    rescue ArgumentError, KeyError
+      false
+    end
+
+    def to_i; number; end
+    def to_s; name.to_s; end
+
+    def inspect
+      "#<#{self.class}: #{name}: #{number}, data: #{data.inspect}>"
+    end
+  end
+end

data/lib/meta_enum/version.rb

@@ -0,0 +1,3 @@
+module MetaEnum
+  VERSION = "1.0.0"
+end

data/lib/meta_enum.rb

@@ -0,0 +1,4 @@
+require "meta_enum/version"
+require 'meta_enum/type.rb'
+require 'meta_enum/value.rb'
+require 'meta_enum/missing_value.rb'

data/meta_enum.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "meta_enum/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "meta_enum"
+  spec.version       = MetaEnum::VERSION
+  spec.authors       = ["Jack Christensen"]
+  spec.email         = ["jack@jackchristensen.com"]
+
+  spec.summary       = %q{Friendly enum type system}
+  spec.homepage      = "https://github.com/ccsalespro/meta_enum"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry", "~> 0.11.3"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: meta_enum
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jack Christensen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+description: 
+email:
+- jack@jackchristensen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/meta_enum.rb
+- lib/meta_enum/missing_value.rb
+- lib/meta_enum/type.rb
+- lib/meta_enum/value.rb
+- lib/meta_enum/version.rb
+- meta_enum.gemspec
+homepage: https://github.com/ccsalespro/meta_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.3
+signing_key: 
+specification_version: 4
+summary: Friendly enum type system
+test_files: []