ya_enum 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 22dc33f31631f9421973d4cbf319e8fa23dd876d0e10003ac8d367399280161c
+  data.tar.gz: 3484534969f78c6106116b005a2c23b28842fa58b5b9bc8927d6af645099bb45
+SHA512:
+  metadata.gz: 8365627b9e546a61bef20649b475e5a7d07fcf3004fc48812399543dd5c5997fa4827f2430ce58dc27ca66c2cc0115ff54dec4d3b8ec59b5521ee9f2b254fa6e
+  data.tar.gz: 5bcde80986b96a157c52cff7ff076882d7d559916af017cb5f341828cb6f1d7bca055073d0d06d166a3230d5cf091023458d2d28449c0e459ff2383f3dc92f92

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.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 ya_enum.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    ya_enum (0.1.1)
+      takes_macro (>= 1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+    takes_macro (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  ya_enum!
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,196 @@
+# YaEnum
+
+**NOTE:** This gem is not stable yet. Use at your own risk.
+
+Easily define enums in Ruby that aren't just symbols. Your enums can have associated values and methods. Imagine if Ruby had Rust's or Swift's enums.
+
+## Installation
+
+Since this isn't published on rubygems.org yet, you'll have to 
+
+1. Download the repo
+2. `bundle install`
+3. `rake install`
+
+## Usage
+
+Basic API for defining enums:
+
+```ruby
+module Colors
+  extend YaEnum
+
+  variant :Red do
+    def rgb
+      [255, 0, 0]
+    end
+  end
+
+  variant :Blue do
+    def rgb
+      [0, 0, 255]
+    end
+  end
+end
+
+p Colors::Red.rgb # => [255, 0, 0]
+p Colors::Blue.rgb # => [0, 0, 255]
+```
+
+You can also define methods outside the variants, which will be inherited by each variant
+
+```ruby
+module Colors
+  extend YaEnum
+
+  variant :Red do
+    def rgb
+      [max, 0, 0]
+    end
+  end
+
+  variant :Blue do
+    def rgb
+      [0, 0, max]
+    end
+  end
+
+  def max
+    255
+  end
+end
+
+p Colors::Blue.rgb # => [0, 0, 255]
+p Colors::Blue.max # 255
+```
+
+Enums can also have associated values:
+
+```ruby
+module Colors
+  extend YaEnum
+
+  variant :Red, [:max] do
+    def rgb
+      [max, 0, 0]
+    end
+  end
+
+  variant :Blue, [:max] do
+    def rgb
+      [0, 0, max]
+    end
+  end
+end
+
+p Colors::Red.new(max: 255).rgb # => [255, 0, 0]
+p Colors::Blue.new(max: 255).rgb # => [0, 0, 255]
+```
+
+Enums can also be used in `case` statements:
+
+```ruby
+module Colors
+  extend YaEnum
+
+  variant :Red, [:max]
+  variant :Blue, [:max]
+end
+
+color = Colors::Red.new(max: 255)
+
+case color
+when Colors::Red
+  puts "red!"
+when Colors::Blue
+  puts "blue!"
+else
+  raise "Unknown case"
+end # => red!
+```
+
+If you forget to implement a method for a variant you'll get an exception:
+
+```ruby
+module Colors
+  extend YaEnum
+
+  variant :Red, [:max] do
+    def rgb
+      [max, 0, 0]
+    end
+  end
+
+  variant :Blue, [:max] do
+  end
+end
+
+# Traceback (most recent call last):
+#         5: from readme.rb:3:in `<main>'
+#         4: from readme.rb:12:in `<module:Colors>'
+#         3: from .../ya_enum/lib/ya_enum.rb:35:in `variant'
+#         2: from .../ya_enum/lib/ya_enum.rb:49:in `ensure_all_methods_defined_for_each_variant!'
+#         1: from .../ya_enum/lib/ya_enum.rb:49:in `each'
+# .../ya_enum/lib/ya_enum.rb:54:in `block in ensure_all_methods_defined_for_each_variant!': Variant Blue is missing the following methods: (YaEnum::MissingMethods)
+#   rgb
+```
+
+You can also use the `.case` method to ensure you're handling all cases
+
+```ruby
+module Colors
+  extend YaEnum
+
+  variant :Red
+  variant :Blue
+end
+
+color = Colors::Red
+
+Colors.case(color) do
+  on(Colors::Red) do
+    puts "red!"
+  end
+
+  on(Colors::Blue) do
+    puts "blue!"
+  end
+end
+```
+
+This is different from a normal `case` statement because you'll get an `YaEnum::Matcher::NonExhaustiveMatch` exception if you forget to handle a case:
+
+```ruby
+module Colors
+  extend YaEnum
+
+  variant :Red
+  variant :Blue
+end
+
+color = Colors::Red
+
+Colors.case(color) do
+  on(Colors::Red) do
+    puts "red!"
+  end
+end
+
+# Traceback (most recent call last):
+#         5: from readme.rb:12:in `<main>'
+#         4: from .../ya_enum/lib/ya_enum.rb:42:in `case'
+#         3: from .../ya_enum/lib/ya_enum/matcher.rb:13:in `match_on'
+#         2: from .../ya_enum/lib/ya_enum/matcher.rb:31:in `ensure_all_variants_handled!'
+#         1: from .../ya_enum/lib/ya_enum/matcher.rb:31:in `each'
+# .../ya_enum/lib/ya_enum/matcher.rb:33:in `block in ensure_all_variants_handled!': Variant Blue is not handled (YaEnum::Matcher::NonExhaustiveMatch)
+```
+
+## 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/tonsser/ya_enum

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 "ya_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(__FILE__)

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/ya_enum/matcher.rb

@@ -0,0 +1,41 @@
+module YaEnum
+  class Matcher
+    def initialize(all_variants:)
+      @cases = []
+      @all_variants = all_variants
+    end
+
+    def on(a_case, &block)
+      cases << [a_case, block]
+    end
+
+    def match_on(variant)
+      ensure_all_variants_handled!
+
+      match = cases.detect do |a_case, _block|
+        a_case === variant
+      end
+
+      if match
+        match.last.call
+      end
+    end
+
+    private
+
+    attr_reader :cases, :all_variants
+
+    def ensure_all_variants_handled!
+      variants_handled = cases.map(&:first)
+
+      all_variants.each do |name, variant|
+        next if variants_handled.include?(variant)
+        raise NonExhaustiveMatch, <<~EOS
+          Variant #{name} is not handled
+        EOS
+      end
+    end
+
+    class NonExhaustiveMatch < StandardError; end
+  end
+end

data/lib/ya_enum/version.rb

@@ -0,0 +1,3 @@
+module YaEnum
+  VERSION = "0.1.1"
+end

data/lib/ya_enum.rb

@@ -0,0 +1,79 @@
+require "takes_macro"
+require "ya_enum/version"
+require "ya_enum/matcher"
+
+module YaEnum
+  attr_accessor :variants
+
+  def variant(name, associated_values = [], &block)
+    if variants.nil?
+      self.variants = []
+    end
+
+    enum = Class.new do
+      extend TakesMacro
+      takes associated_values.map { |value| :"#{value}!" }
+
+      def self.===(other)
+        self == other || super
+      end
+    end
+
+    if block
+      if associated_values.any?
+        enum.class_eval(&block)
+        enum.include(self)
+      else
+        enum.instance_eval(&block)
+        enum.extend(self)
+      end
+    end
+
+    const_set(name, enum)
+    variants << [name.to_s, enum]
+    ensure_all_methods_defined_for_each_variant!
+  end
+
+  def case(variant, &block)
+    matcher = Matcher.new(all_variants: variants)
+    matcher.instance_eval(&block)
+    matcher.match_on(variant)
+  end
+
+  private
+
+  def all_methods_from_all_variants
+    variants.flat_map do |_name, enum|
+      unique_methods_of(enum)
+    end
+  end
+
+  def ensure_all_methods_defined_for_each_variant!
+    all_methods = all_methods_from_all_variants
+
+    variants.each do |name, enum|
+      missing_methods = all_methods - unique_methods_of(enum)
+
+      next if missing_methods.empty?
+
+      raise MissingMethods, <<~EOS
+        Variant #{name} is missing the following methods:
+          #{missing_methods.to_a.join(", ")}
+      EOS
+    end
+  end
+
+  def unique_methods_of(obj)
+    (
+      (obj.methods - Object.methods) +
+        (obj.instance_methods - Object.instance_methods) -
+        takes_macro_methods
+    ).uniq
+  end
+
+  def takes_macro_methods
+    [:takes, :after_takes]
+  end
+
+  class MissingMethods < StandardError; end
+end

data/ya_enum.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ya_enum/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ya_enum"
+  spec.version       = YaEnum::VERSION
+  spec.authors       = ["David Pedersen"]
+  spec.email         = ["david.pdrsn@gmail.com"]
+
+  spec.summary       = %q{Enums in Ruby}
+  spec.description   = %q{Enums in Ruby, that aren't just Java enums. We can do better than that}
+  spec.homepage      = "http://github.com/tonsser/ya_enum"
+
+  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_dependency "takes_macro", ">= 1.0.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: ya_enum
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- David Pedersen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-19 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: takes_macro
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Enums in Ruby, that aren't just Java enums. We can do better than that
+email:
+- david.pdrsn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ya_enum.rb
+- lib/ya_enum/matcher.rb
+- lib/ya_enum/version.rb
+- ya_enum.gemspec
+homepage: http://github.com/tonsser/ya_enum
+licenses: []
+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: Enums in Ruby
+test_files: []