noomer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be396d0dfca2322d065927b71e614eca3380760ce6d27a855bdc755293e59623
+  data.tar.gz: 3f902f864d81f1ab71c02d853199c522304d84a73a7e1f3db1827650f88cd7ee
+SHA512:
+  metadata.gz: f34136746ff00b71b4fa1b8fb3ab7fa4294114fd347a831e46143ead35356e62a99d773d41326e0756f18f68d4017ff07b6fbe15181fa19aa420524aca3860dd
+  data.tar.gz: 9ece085daf505ceaa21d9b19651419f7feaf17b45c4d26f1e22465021c4c37851d4db4af32c355519a897a4da76857a6813683665d3eff88d8b5bdc7e0e7740d

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in enum.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    noomer (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+
+PLATFORMS
+  x86_64-darwin-22
+
+DEPENDENCIES
+  noomer!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 DanOlson
+
+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,161 @@
+# Noomer
+
+A basic enum implementation for Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'noomer'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install noomer
+
+## Usage
+
+Define a PORO to hold your variants, and include the `Noomer` module. This provides an `enum` method you can use to declare your enum variants.
+
+```ruby
+class Color
+  include Noomer
+
+  # Declare your variants with the `enum` method
+  Red = enum
+  Green = enum
+  Blue = enum
+end
+```
+
+The `enum` method returns a subclass of the including class. In the above example, it returns a subclass of `Color`. When the result of the `enum` method is assigned to a constant, a method named after the constant is defined which returns an instance of the new subclass. In the above example, `enum` is invoked three times, each one creating a new subclass of `Color`. Three methods are defined, each one returning an instance of the corresponding subclass:
+
+```ruby
+Color::Red()
+# => #<Color::Red 0x000000010a27ccb0 @value=nil>
+
+Color::Green()
+# => #<Color::Green:0x000000010d146b40 @value=nil>
+
+Color::Blue()
+# => #<Color::Blue:0x000000010d26c600 @value=nil>
+```
+
+These methods can be invoked repeatedly, and will always return the same instance.
+
+Now we have three new classes, and three new methods:
+
+| Class          | Method           |
+|----------------|------------------|
+| `Color::Red`   | `Color::Red()`   |
+| `Color::Green` | `Color::Green()` |
+| `Color::Blue`  | `Color::Blue()`  |
+
+`Color::Red()` returns an instance of `Color::Red`, which `is_a?` `Color`.
+
+### Associated Data
+
+`Enum` also supports declaring variants with associated data:
+
+```ruby
+class Book
+  attr_reader :title
+
+  def initialize(title) = @title = title
+end
+
+class Subject
+  include Noomer
+
+  Math = enum(Book)
+  Literature = enum(Book)
+  Science = enum(Book)
+  PhyEd = enum
+end
+```
+
+Here we have a `Subject` class that includes `Enum`, and four variants are declared; three of which require a book and one that does not. When `enum` is called with an argument that is a `Class`, the accompanying constructor method requires an argument that is an instance of that class. In the above example:
+
+```ruby
+math_book = Book.new('Beyond Algebra')
+# => #<Book:0x000000010d145f88 @title="Beyond Algebra">
+math = Subject::Math(math_book)
+# => #<Subject::Math:0x000000010d1a8bb0 @value=#<Book:0x000000010d145f88 @title="Beyond Algebra">>
+math.value == math_book
+# => true
+```
+
+If you provide an argument that is not an instance of `Book`, you'll get an error:
+
+```ruby
+Pencil = Struct.new(:number)
+pencil = Pencil.new(2)
+Subject::Math(pencil)
+# => ArgumentError
+```
+
+Enum classes works well with `case` statements. Using the example above:
+
+```ruby
+# @param subject [Subject]
+# @return [void]
+def study(subject)
+  case subject
+  when Subject::Math, Subject::Literature, Subject::Science
+    book = subject.value
+    book.open_to_chapter(assignment.chapter)
+    read(book)
+  when Subject::PhyEd
+    stretch
+    jog
+    pushups
+  end
+end
+```
+
+### Explicit Discriminators
+
+Variants with can be declared with explicit discriminators. A variation on the `Color` example above:
+
+```ruby
+class Color
+  include Noomer
+
+  Red = enum('#ff0000')
+  Green = enum('#00ff00')
+  Blue = enum('#0000ff')
+end
+```
+
+When instantiated, the value of each variant is that of the provided discriminator:
+
+```ruby
+red = Color::Red()
+green = Color::Green()
+blue = Color::Blue()
+red.value
+# => "#ff0000"
+green.value
+# => "#00ff00"
+blue.value
+# => "#0000ff"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### TODOs
+
+- Support Ruby versions < 3.2
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DanOlson/noomer.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/noomer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Noomer
+  VERSION = "0.1.0"
+end

data/lib/noomer.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative "noomer/version"
+
+module Noomer
+  def self.included(base) = base.extend(ClassMethods)
+
+  attr_reader :value
+
+  def initialize(value = nil)
+    @value = value
+  end
+
+  module ClassMethods
+    attr_reader :type_holder
+
+    def enum(type = nil)
+      Class.new(self) do
+        self.type_holder = TypeHolder.new(type) if type
+      end
+    end
+
+    private
+
+    attr_writer :type_holder
+
+    def registry = @registry ||= Registry.new
+
+    def const_added(const)
+      constant = const_get(const)
+      return unless constant.is_a?(Class)
+      return unless constant < self
+
+      type = constant.type_holder&.type
+      defn = case type
+      when Class
+        proc do |instance|
+          raise ArgumentError unless instance.is_a?(type)
+          registry.fetch(instance) { constant.new(instance).freeze }
+        end
+      when nil
+        proc do
+          registry.fetch(constant) { constant.new.freeze }
+        end
+      else
+        proc do
+          registry.fetch(type) { constant.new(type).freeze }
+        end
+      end
+      self.class.define_method(const, &defn)
+    end
+  end
+
+  class Registry
+    def initialize = @registry = {}
+
+    def fetch(key, &blk) = @registry[key] ||= blk.call
+  end
+  private_constant :Registry
+
+  class TypeHolder
+    attr_reader :type
+
+    def initialize(type) = @type = type
+  end
+  private_constant :TypeHolder
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: noomer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dan Olson
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-09-18 00:00:00.000000000 Z
+dependencies: []
+description: An enum implementation in Ruby
+email:
+- olson_dan@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/noomer.rb
+- lib/noomer/version.rb
+homepage: https://github.com/DanOlson/noomer
+licenses: []
+metadata:
+  homepage_uri: https://github.com/DanOlson/noomer
+  source_code_uri: https://github.com/DanOlson/noomer
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Enum implementation in Ruby
+test_files: []