enummify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 16f397e8462e592ee835ac563f64ed9b5f5ae9166b051effe5c397b908ecfdcf
+  data.tar.gz: d71a579357f34609457fb66c55535aa096a785e78d8361f1b14d96c891330b6d
+SHA512:
+  metadata.gz: a6529db8dfa09dee22f886333559ba379da3ca7d9940210e117ad8cb5edf69a830915be4b923aea00cc9bfa38723a6c4a0c340e94a412cbdd7246873df652e0a
+  data.tar.gz: 012263c4cf3610fde962d10315ef6ea487bd00edfcab29fa264e992ac681ae9cfcd54d1cf2169979edfdf4d8aa59451a16a9ce31553c6449bff95eb3e81a1844

data/lib/enummify/enum.rb

@@ -0,0 +1,105 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Enummify
+  # A typed set of immutable, named instances with string serialization.
+  class Enum
+    @serialized_to_value = {} #: Hash[String, Enum]
+    @values = nil #: Array[Enum]?
+
+    # Register direct constants so only named members belong to the enum.
+    #: (Symbol) -> void
+    def self.const_added(constant)
+      super
+
+      member = const_get(constant, false) #: as Enum
+      serialized = member.send(:finalize, constant)
+      if @serialized_to_value.key?(serialized)
+        raise ArgumentError, "Duplicate serialized value for #{name}: #{serialized.inspect} is already used"
+      end
+
+      @serialized_to_value[serialized] = member
+    end
+
+    # Look up a member by its exact serialized string.
+    #: (String) -> instance
+    def self.deserialize(serialized)
+      @serialized_to_value[serialized] || raise(ArgumentError, "Unknown #{name} value: #{serialized.inspect}") #: as instance
+    end
+
+    class << self
+      # Restore the canonical member when loading a Marshal stream.
+      alias _load deserialize
+    end
+
+    # Look up a member, returning nil for an unknown string.
+    #: (String) -> instance?
+    def self.try_deserialize(serialized)
+      @serialized_to_value[serialized] #: as instance?
+    end
+
+    # Return the members.
+    #: () -> Array[instance]
+    def self.values
+      (@values ||= @serialized_to_value.values.freeze) #: as Array[instance]
+    end
+
+    # Give each enum class its own registry.
+    #: (singleton(Enummify::Enum)) -> void
+    def self.inherited(subclass)
+      super
+      subclass.instance_variable_set(:@serialized_to_value, {})
+    end
+
+    private_class_method :const_added, :inherited
+
+    # Store only the serialized string so Marshal loading uses the registered member.
+    #: (Integer) -> String
+    def _dump(_depth)
+      serialize
+    end
+
+    # Enum members are immutable singletons, including copies requested as unfrozen.
+    # rubocop:disable Lint/UnusedMethodArgument
+    #: (?freeze: bool?) -> self
+    def clone(freeze: true)
+      self
+    end
+    # rubocop:enable Lint/UnusedMethodArgument
+
+    #: () -> self
+    def dup
+      self
+    end
+
+    #: () -> String
+    def inspect
+      "#<#{self.class.name}: #{serialize.inspect}>"
+    end
+
+    #: () -> String
+    def serialize
+      @serialized || raise(ArgumentError, 'Enum members must be assigned to a constant before serialization')
+    end
+
+    #: () -> String
+    def to_s
+      serialize
+    end
+
+    private
+
+    # The constant name is only available after construction has returned.
+    #: (Symbol) -> String
+    def finalize(constant)
+      @serialized ||= constant.name
+      freeze
+      @serialized
+    end
+
+    #: (?String?) -> void
+    def initialize(serialized = nil)
+      @serialized = serialized&.dup&.freeze #: String?
+    end
+  end
+end

data/lib/enummify/version.rb

@@ -0,0 +1,6 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Enummify
+  VERSION = '0.1.0'
+end

data/lib/enummify.rb

@@ -0,0 +1,5 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative 'enummify/enum'
+require_relative 'enummify/version'

data/rbi/enummify.rbi

@@ -0,0 +1,45 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Enummify
+  # A typed set of immutable, named instances with string serialization.
+  class Enum
+    extend T::Sig
+
+    sig { params(serialized: String).returns(T.attached_class) }
+    def self.deserialize(serialized); end
+
+    class << self
+      alias _load deserialize
+    end
+
+    sig { params(serialized: String).returns(T.nilable(T.attached_class)) }
+    def self.try_deserialize(serialized); end
+
+    sig { returns(T::Array[T.attached_class]) }
+    def self.values; end
+
+    sig { params(_depth: Integer).returns(String) }
+    def _dump(_depth); end
+
+    sig { params(freeze: T.nilable(T::Boolean)).returns(T.self_type) }
+    def clone(freeze: true); end
+
+    sig { returns(T.self_type) }
+    def dup; end
+
+    sig { returns(String) }
+    def inspect; end
+
+    sig { returns(String) }
+    def serialize; end
+
+    sig { returns(String) }
+    def to_s; end
+
+    private
+
+    sig { params(serialized: T.nilable(String)).void }
+    def initialize(serialized = nil); end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: enummify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin D. Harris
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.13426
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.13426
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.8
+description: Immutable, typed Ruby enums with RBS comments and no runtime dependencies.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/enummify.rb
+- lib/enummify/enum.rb
+- lib/enummify/version.rb
+- rbi/enummify.rbi
+homepage: https://github.com/juharris/enummify
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/juharris/enummify/issues
+  source_code_uri: https://github.com/juharris/enummify
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: Typed Ruby enums using RBS.
+test_files: []