philiprehberger-enum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c57d423a66fad422a2a57e996e53a2b0bcf32e11de057e0dc0eeeac2dde3a4f
+  data.tar.gz: 6c9121f4a1be73222f09a58df5d42b305f75a47eb6d662bac79c30648010c568
+SHA512:
+  metadata.gz: b205fdb4a98c0188db035118d32f8d7d95a56fbf8dc3638317dfeeb56e1cb77fa36e02b02573f937d8aeba84a4eedf2bd6659b67ccc7226f56d7c3a89cf02835
+  data.tar.gz: 9b838f375c6141ce9a2ab3d4fc3bb1482da6c2b17b08eda07b639641072714a66aa85ee09503a39c54110ef508fecb4dcf8da10894dffed18687f4dc7daa5a37

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this gem will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-03-21
+
+### Added
+
+- Initial release
+- Type-safe enum base class with `member` class method
+- Automatic ordinals based on declaration order
+- Custom values via `value:` keyword parameter
+- Lookup methods: `from_name`, `from_value`, `from_string`, `valid?`
+- Comparable by ordinal for sorting and comparison
+- Pattern matching support via `deconstruct_keys`
+- JSON serialization via `to_json`
+- Frozen singleton members for immutability

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 philiprehberger
+
+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,122 @@
+# philiprehberger-enum
+
+[![Tests](https://github.com/philiprehberger/rb-enum/actions/workflows/ci.yml/badge.svg)](https://github.com/philiprehberger/rb-enum/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/philiprehberger-enum.svg)](https://rubygems.org/gems/philiprehberger-enum)
+[![License](https://img.shields.io/github/license/philiprehberger/rb-enum)](LICENSE)
+
+Type-safe enumerations with ordinals, custom values, and pattern matching
+
+## Requirements
+
+- Ruby >= 3.1
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'philiprehberger-enum'
+```
+
+Or install directly:
+
+```bash
+gem install philiprehberger-enum
+```
+
+## Usage
+
+```ruby
+require 'philiprehberger/enum'
+
+class Status < Philiprehberger::Enum
+  member :draft
+  member :published
+  member :archived
+end
+
+Status::DRAFT.name       # => :draft
+Status::DRAFT.ordinal    # => 0
+Status.members           # => [DRAFT, PUBLISHED, ARCHIVED]
+```
+
+### Custom Values
+
+```ruby
+class HttpCode < Philiprehberger::Enum
+  member :ok, value: 200
+  member :not_found, value: 404
+  member :server_error, value: 500
+end
+
+HttpCode::OK.value          # => 200
+HttpCode.from_value(404)    # => HttpCode::NOT_FOUND
+```
+
+### Lookup Methods
+
+```ruby
+Status.from_name(:draft)    # => Status::DRAFT
+Status.from_string('draft') # => Status::DRAFT
+Status.valid?(:draft)       # => true
+Status.valid?(:unknown)     # => false
+```
+
+### Comparison
+
+Members are comparable by ordinal:
+
+```ruby
+Status::DRAFT < Status::PUBLISHED   # => true
+Status.members.sort                  # sorted by declaration order
+```
+
+### Pattern Matching
+
+```ruby
+case Status::DRAFT
+in { name: :draft }
+  'is draft'
+in { name: :published }
+  'is published'
+end
+```
+
+### Serialization
+
+```ruby
+Status::DRAFT.to_s     # => "draft"
+Status::DRAFT.to_json  # => '{"name":"draft","ordinal":0,"value":null}'
+```
+
+## API
+
+### `Philiprehberger::Enum` (base class)
+
+| Method | Description |
+|--------|-------------|
+| `.member(name, value: nil)` | Define a new enum member with optional custom value |
+| `.members` | Return all members in declaration order |
+| `.from_name(name)` | Look up a member by symbol or string name |
+| `.from_string(string)` | Look up a member by string name |
+| `.from_value(val)` | Look up a member by custom value |
+| `.valid?(name)` | Check if a name is a valid member |
+| `#name` | Return the member name as a symbol |
+| `#ordinal` | Return the ordinal position |
+| `#value` | Return the custom value, or nil |
+| `#to_s` | Return the member name as a string |
+| `#to_json` | Serialize to JSON with name, ordinal, and value |
+| `#deconstruct_keys(keys)` | Pattern matching support |
+| `#<=>(other)` | Compare by ordinal |
+
+## Development
+
+```bash
+bundle install
+bundle exec rspec      # Run tests
+bundle exec rubocop    # Check code style
+```
+
+## License
+
+MIT

data/lib/philiprehberger/enum/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  class Enum
+    VERSION = '0.1.0'
+  end
+end

data/lib/philiprehberger/enum.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require_relative 'enum/version'
+require 'json'
+
+module Philiprehberger
+  # Type-safe enumerations with ordinals, custom values, and pattern matching.
+  #
+  # Subclass Enum and use the `member` class method to define members:
+  #
+  #   class Status < Philiprehberger::Enum
+  #     member :draft
+  #     member :published
+  #     member :archived
+  #   end
+  #
+  class Enum
+    include Comparable
+
+    class Error < StandardError; end
+
+    # @return [Symbol] the member name
+    attr_reader :name
+
+    # @return [Integer] the ordinal position (declaration order)
+    attr_reader :ordinal
+
+    # @return [Object, nil] the custom value, or nil if not set
+    attr_reader :value
+
+    # @param name [Symbol] the member name
+    # @param ordinal [Integer] the ordinal position
+    # @param value [Object, nil] an optional custom value
+    def initialize(name, ordinal, value)
+      @name = name
+      @ordinal = ordinal
+      @value = value
+      freeze
+    end
+
+    # Compare members by ordinal
+    #
+    # @param other [Enum] another member of the same enum class
+    # @return [Integer, nil] -1, 0, 1, or nil if not comparable
+    def <=>(other)
+      return nil unless other.is_a?(self.class)
+
+      ordinal <=> other.ordinal
+    end
+
+    # @return [String] the member name as a string
+    def to_s
+      name.to_s
+    end
+
+    # @return [String] a human-readable representation
+    def inspect
+      "#<#{self.class} #{name}>"
+    end
+
+    # Serialize to a JSON-compatible hash
+    #
+    # @return [String] JSON string with name, ordinal, and value
+    def to_json(*args)
+      { name: name, ordinal: ordinal, value: value }.to_json(*args)
+    end
+
+    # Support Ruby 3.x pattern matching with `in` expressions
+    #
+    # @param keys [Array<Symbol>, nil] the keys to deconstruct
+    # @return [Hash] hash of requested keys
+    def deconstruct_keys(keys)
+      h = { name: name, ordinal: ordinal, value: value }
+      keys ? h.slice(*keys) : h
+    end
+
+    class << self
+      # Define a new member on this enum class
+      #
+      # @param name [Symbol] the member name
+      # @param value [Object, nil] an optional custom value
+      # @return [Enum] the created member
+      # @raise [Error] if the enum is frozen or name is already defined
+      def member(name, value: nil)
+        raise Error, "cannot add members to #{self} after freeze" if @frozen
+
+        name = name.to_sym
+        raise Error, "member #{name} is already defined on #{self}" if member_registry.key?(name)
+
+        ord = member_registry.size
+        instance = new(name, ord, value)
+
+        member_registry[name] = instance
+        const_set(name.upcase, instance)
+
+        instance
+      end
+
+      # Return all members in declaration order
+      #
+      # @return [Array<Enum>] frozen array of all members
+      def members
+        freeze_members!
+        member_registry.values.freeze
+      end
+
+      # Look up a member by its name
+      #
+      # @param name [Symbol, String] the member name
+      # @return [Enum, nil] the member, or nil if not found
+      def from_name(name)
+        freeze_members!
+        member_registry[name.to_sym]
+      end
+
+      # Look up a member by its string representation
+      #
+      # @param string [String] the member name as a string
+      # @return [Enum, nil] the member, or nil if not found
+      def from_string(string)
+        from_name(string)
+      end
+
+      # Look up a member by its custom value
+      #
+      # @param val [Object] the value to search for
+      # @return [Enum, nil] the member, or nil if not found
+      def from_value(val)
+        freeze_members!
+        member_registry.values.find { |m| m.value == val }
+      end
+
+      # Check if a name is a valid member
+      #
+      # @param name [Symbol, String] the member name
+      # @return [Boolean] true if the name is a valid member
+      def valid?(name)
+        freeze_members!
+        member_registry.key?(name.to_sym)
+      end
+
+      private
+
+      def inherited(subclass)
+        super
+        subclass.instance_variable_set(:@member_registry, {})
+        subclass.instance_variable_set(:@frozen, false)
+      end
+
+      def member_registry
+        @member_registry ||= {}
+      end
+
+      def freeze_members!
+        @frozen = true
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: philiprehberger-enum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philip Rehberger
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-22 00:00:00.000000000 Z
+dependencies: []
+description: Define type-safe enums in Ruby with automatic ordinals, custom values,
+  lookup methods, and Ruby 3.x pattern matching support. A cleaner alternative to
+  ad-hoc constants and symbol sets.
+email:
+- me@philiprehberger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/philiprehberger/enum.rb
+- lib/philiprehberger/enum/version.rb
+homepage: https://github.com/philiprehberger/rb-enum
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/philiprehberger/rb-enum
+  source_code_uri: https://github.com/philiprehberger/rb-enum
+  changelog_uri: https://github.com/philiprehberger/rb-enum/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/philiprehberger/rb-enum/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Type-safe enumerations with ordinals, custom values, and pattern matching
+test_files: []