easy_enum 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a277b4952bac2f58dd791e094b9f57952df468c3e9e1bd79aabb86065d740f15
+  data.tar.gz: eeb710a77ecf87a36bf93fdea34ed79f27fd4dc96312fcc06657d3c8331bf050
+SHA512:
+  metadata.gz: 4c67b817be49fe3ace46c30d646a85afcb33e5141ea277c749d0e34cb50f8dd74f41d1872eb49d68857d1c669e55626b1207bd683643857ed18117172e053fa2
+  data.tar.gz: f236d45007f52cff6177f10b03f4269fdd8a98c13cef6d158f04722486e1ed8a5bf05d71003e448d51c1756b25aba65c2d82fb4d699788ca0f44fa4a6136325a

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Marco Roth
+
+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,164 @@
+# EasyEnum
+
+Turn any Ruby class in an easy to use enum.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'easy_enum'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_enum
+
+## Basic Usage
+
+```ruby
+include EasyEnum
+
+class Color < EasyEnum
+  easy_enum(green: 0, red: 1, blue: 2)
+end
+
+# or
+
+class Color < EasyEnum
+  self.easy_enum = {
+    green: 0,
+    red: 1,
+    blue: 2
+  }
+end
+
+```
+
+### Getting an Instance
+
+```ruby
+Color.green
+Color.red
+Color.blue
+
+Color.new(0)
+Color.new(1)
+Color.new(2)
+
+Color.key(:green)
+Color.key(:red)
+Color.key(:blue)
+
+Color.value(0)
+Color.value(1)
+Color.value(2)
+
+```
+
+### Getting Values
+
+```ruby
+green = Color.green
+green.value
+# => 0
+
+red = Color.red
+red.value
+# => 1
+
+blue = Color.blue
+blue.value
+# => 2
+
+```
+
+### Check the value of your instance
+
+```ruby
+color = Color.green
+
+color.green? # => true
+color.red? # => false
+color.blue? # => false
+
+```
+
+### Exploring the Enum
+
+```ruby
+Color.members
+# => {:green=>0, :red=>1, :blue=>2}
+
+Color.keys
+# => [:green, :red, :blue]
+
+Color.values
+# => [0, 1, 2]
+
+Color.key?(:green)
+# => true
+
+Color.value?(0)
+# => true
+
+```
+
+
+### Comparison
+
+```ruby
+green = Color.green
+
+green == :green # => true
+green == 0 # => true
+green == Color.green # => true
+green == Color.key(:green) # => true
+green == Color.value(0) # => true
+
+green == Color.red # => false
+
+```
+
+
+### Redefining the value of your instance
+
+```ruby
+color = Color.green
+color.value # => 0
+color.key # => :green
+
+color.value = 1
+color.value # => 1
+color.key # => :red
+
+color.key = :blue
+color.value  # => 2
+color.key # => :blue
+
+color.key = :yellow
+# => raises EasyEnum::KeyNotInEnum
+
+color.value = 3
+# => raises EasyEnum::ValueNotInEnum
+
+```
+
+
+## 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/marcoroth/easy_enum.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/easy_enum/color.rb

@@ -0,0 +1,5 @@
+module EasyEnum
+  class Color < EasyEnum
+    easy_enum(green: 0, red: 1, blue: 2)
+  end
+end

data/lib/easy_enum/easy_enum.rb

@@ -0,0 +1,102 @@
+module EasyEnum
+  class EasyEnum
+    attr_reader :value
+
+    class << self
+      attr_writer :easy_enum
+    end
+
+    def initialize(value)
+      self.value = value
+    end
+
+    def self.easy_enum(easy_enum = {})
+      @easy_enum ||= easy_enum
+    end
+
+    def value=(value)
+      if self.class.values.include?(value)
+        @value = value
+        return
+      end
+      raise ValueNotInEnum
+    end
+
+    def key=(key)
+      if self.class.keys.include?(key)
+        @value = self.class.members[key]
+        return
+      end
+      raise KeyNotInEnum
+    end
+
+    def key
+      self.class.easy_enum.each do |key, val|
+        return key if value == val
+      end
+
+      nil
+    end
+
+    def self.members
+      easy_enum
+    end
+
+    def self.keys
+      easy_enum.keys
+    end
+
+    def self.values
+      easy_enum.values
+    end
+
+    def self.key(key)
+      value = members[key]
+      return new(value) if value
+
+      nil
+    end
+
+    def self.value(value)
+      return new(value) if values.include? value
+
+      nil
+    end
+
+    def self.key?(key)
+      keys.include? key
+    end
+
+    def self.value?(value)
+      values.include? value
+    end
+
+    def self.size
+      easy_enum.count
+    end
+
+    def ==(other)
+      if other.is_a? self.class
+        other.key == key
+      elsif other.is_a? Symbol
+        other == key
+      else
+        other == value
+      end
+    end
+
+    def method_missing(method, *args) # rubocop:disable Style/MissingRespondToMissing
+      self.class.easy_enum.each do |key, val|
+        return val == value if method == "#{key}?".to_sym
+      end
+
+      super
+    end
+
+    def self.method_missing(method, *args) # rubocop:disable Style/MissingRespondToMissing
+      return key(method) if keys.include?(method)
+
+      super
+    end
+  end
+end

data/lib/easy_enum/unit.rb

@@ -0,0 +1,9 @@
+module EasyEnum
+  class Unit < EasyEnum
+    self.easy_enum = {
+      meter: 0,
+      yard: 1,
+      feet: 2
+    }
+  end
+end

data/lib/easy_enum/version.rb

@@ -0,0 +1,3 @@
+module EasyEnum
+  VERSION = '0.1.2'.freeze
+end

data/lib/easy_enum.rb

@@ -0,0 +1,7 @@
+require 'easy_enum/version'
+require 'easy_enum/easy_enum'
+
+module EasyEnum
+  class ValueNotInEnum < StandardError; end
+  class KeyNotInEnum < StandardError; end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: easy_enum
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Marco Roth
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.68.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.68.0
+description: Turn any Ruby class in an easy to use enum
+email:
+- marco.roth@intergga.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/easy_enum.rb
+- lib/easy_enum/color.rb
+- lib/easy_enum/easy_enum.rb
+- lib/easy_enum/unit.rb
+- lib/easy_enum/version.rb
+homepage: https://github.com/marcoroth/easy_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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Turn any Ruby class in an easy to use enum
+test_files: []