literal_enums 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0ac7656b0ea18bc915ff4bfda4b341e9a9923b3ee84775a834158589ea09e21
-  data.tar.gz: aa5810e0cd16ae43906aff642757f51bf23bc83fd1a18cba30324614314bf54d
+  metadata.gz: b7e6724b81f59fbf8d701b0567dc17c344c53c677c318992a7a799acf3242c05
+  data.tar.gz: 735a34d71b23525d8285e4fccb39063946ba1af6ff691081471d9b14f869bc40
 SHA512:
-  metadata.gz: 373cc1046ac9963b82af06e94f85a1d1a8dd78647a1ed3d24a6d2f577dcc3aabfecabbcb4966ef34b516f55f0ff27de0c0b86b5d269e15543425aa6939782fa5
-  data.tar.gz: 293b1b49906a3972bf96a46f9a710f58389bf0d205503cb1481f8c9af11964055578d5a98d6ac83652c303566cdd20661015018a49b7db97272024440716b496
+  metadata.gz: 4331f3a30ca04be1eb49fb20463a673eb36a9a721fab8ae7fd0fb8ecab1a1c37d0ba9e43b34b20416230f43fac8f3c738cfff0127b4cfdc8feb3a5d30f1ea064
+  data.tar.gz: d25213819f531fb985c7556171a8fc4820d87672f7bad03a41c1cdda26cb7c20c0974db96f832016aba3251a1581337f0000aebe7c4a00fb128884266e67de19

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: [joeldrapper]

data/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  tests:
+    strategy:
+      matrix:
+        os: ['ubuntu-latest', 'macos-latest']
+        ruby-version: ['2.7', '3.0', '3.1', 'head']
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: false
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Tests
+        run: bundle exec rake

data/.gitignore

@@ -6,3 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock
+.DS_Store

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at joel.drapper@shopify.com. All
+reported by contacting the project team at joel@drapper.me. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

data/Gemfile

@@ -1,6 +1,10 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-# Specify your gem's dependencies in literal_enums.gemspec
 gemspec
+
+gem "rake"
+gem "minitest"
+gem "benchmark-ips"

data/README.md

@@ -1,3 +1,5 @@
+This documentation is for Literal Enums 2.0, which is not yet supported by Literal Enums Rails. You can see documentaiton for Literal Enums v1 [here](https://github.com/joeldrapper/literal_enums/tree/d49eeba40f01f24c6b26d4dcdc6abb0da28e9ccb#readme).
+
 # literal_enums
 
 Literal Enums makes Enumerations first-class citizens in Ruby, providing a literal definition syntax.
@@ -8,9 +10,9 @@ You can define an enum by subclassing `Enum` and using the literal syntax.
 
 ```ruby
 class Color < Enum
-  Red()
-  Green()
-  Blue()
+  Red
+  Green
+  Blue
 end
 ```
 
@@ -20,7 +22,7 @@ Here we’ve enumerated `Color::Red`, `Color::Green`, and `Color::Blue` constant
 Color::Red.is_a?(Color) # returns true
 ```
 
-Enum classes have synthetic methods for looking up their members. `Color.members` will return a `Set` of members of the `Color` enumeration: `Color::Red`, `Color::Green`, and `Color::Blue`.
+Enum classes have synthetic methods for looking up their members. `Color.members` will return an `Array` of members of the `Color` enumeration: `Color::Red`, `Color::Green`, and `Color::Blue`.
 
 Members also have polymorphic predicate methods for each member of the enumeration in lower-snake-case.
 
@@ -46,7 +48,7 @@ end
 Then we can look up all the values.
 
 ```ruby
-Color.values # returns a Set of "ff0000", "00ff00", "0000f".
+Color.values # returns an Array of ["ff0000", "00ff00", "0000f"].
 ```
 
 We can also look at the value for any member directly.
@@ -90,50 +92,20 @@ It is also possible to define a more complex state machine by defining `transiti
 
 ```ruby
 class State < Enum
-  Pending do
-    def transitions_to
-      [Approved, Rejected]
-    end
-  end
-
-  Approved do
-    def transitions_to
-      Published
-    end
-  end
-
-  Rejected do
-    def transitions_to
-      Deleted
-    end
-  end
+  Pending -> { [Approved, Rejected] }
+  Approved -> { Published }
+  Rejected -> { Deleted }
 
-  Deleted()
-  Published()
+  Deleted
+  Published
 end
 ```
 
-Given the above definition, we can transition from one state to another by calling `transition_to` with the newly desired state. This will raise a `LiteralEnums::TransitionError` if the transition is invalid.
-
-```ruby
-State::Pending.transition_to(State::Approved) # returns State::Approved.
-State::Pending.transition_to(State::Published) # raises a LiteralEnums::TransitionError.
-```
-
-Alternatively, we can call the new state as a method on the old state.
-
-```ruby
-State::Pending.approved # returns State::Approved.
-```
-
-An invalid transition would return a `NoMethodErorr` in this case as the method is not defined.
-
-The advantage of using method calls to transition from one state to anotehr is the method calls can be chained.
+Given the above definition, we can transition from one state to another by calling `>>` with the newly desired state. This will raise a `LiteralEnums::TransitionError` if the transition is invalid.
 
 ```ruby
-State::Pending.approved.published # returns State::Published, since it's valid to
-                                  # move to State::Published from State::Approved and it's
-                                  # valid to move to State::Approved from State::Pending.
+State::Pending >> State::Approved # returns State::Approved.
+State::Pending >> State::Published # raises a LiteralEnums::TransitionError.
 ```
 
 ## Installation

data/bench.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "literal_enums"
+require "benchmark/ips"
+
+class Color < Enum
+  Red("#f00")
+  Green("#0f0")
+  Blue("#00f")
+end
+
+Benchmark.ips do |x|
+  x.report("Cast") { Color.cast("f00") }
+  x.report("Lookup") { Color::Red }
+  x.report("Members") { Color.members }
+  x.report("Values") { Color.values }
+end

data/lib/enum.rb

@@ -7,57 +7,94 @@ class Enum
   alias_method :inspect, :name
 
   def initialize(name, value)
+    @short_name = name.to_s.gsub(/([a-z])([A-Z])/, '\1_\2').downcase!
     @name = "#{self.class.name}::#{name}"
-    @value = value || @name
+    @value = value
   end
 
   class << self
+    attr_reader :members
+
+    def inherited(child)
+      TracePoint.new(:end) do |tp|
+        if tp.self == child
+          tp.self.freeze
+          tp.disable
+        end
+      end.enable
+
+      child.instance_eval do
+        @values = {}
+        @members = []
+      end
+    end
+
+    def const_missing(name)
+      return super if frozen?
+      new(name)
+    end
+
     def method_missing(name, *args, **kwargs, &block)
-      return super unless name[0] == name[0].upcase
+      return super if frozen?
+      return super unless name[0] =~ /[A-Z]/
       new(name, *args, **kwargs, &block)
     end
 
     def cast(value)
-      members.find { |v| v.value == value.to_s }
+      @values[value]
     end
 
     def values
-      map(&:value).to_set
+      @values.keys
     end
 
     def each(&block)
-      members.each(&block)
-    end
-
-    def members
-      constants.map { |c| const_get(c) }.to_set
+      @members.each(&block)
     end
 
     private
 
-    def new(name, value = nil, &block)
-      if self == Enum
-        raise ArgumentError, "You can't add values to the abstract Enum class itself."
+    def new(name, a = nil, b = nil, &block)
+
+      # If only one positional argument is provided and it's a proc, treat it as the transitions_to definition. Otherwise, the first argument is the value and the second argument is the transitions_to definition.
+
+      if !b && Proc === a
+        transitions_to = a
+        value = name
+      else
+        value = a || name
+        transitions_to = b
       end
 
-      if constants.include?(name)
-        raise ArgumentError, "Name conflict: '#{self.name}::#{name}' is already defined."
+      if self == Enum
+        raise ArgumentError,
+          "You can't add values to the abstract Enum class itself."
       end
 
-      if values.include?(value)
-        raise ArgumentError, "Value conflict: the value '#{value}' is defined for '#{self.cast(value).name}'."
+      if const_defined?(name)
+        raise ArgumentError,
+          "Name conflict: '#{self.name}::#{name}' is already defined."
       end
 
-      member = super(name, value)
-      member.instance_eval(&block) if block_given?
+      if @values[value]
+        raise ArgumentError,
+          "Value conflict: the value '#{value}' is defined for '#{self.cast(value).name}'."
+      end
 
       class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
-        def #{name.to_s.underscore}?
-          name.demodulize.underscore == "#{name.to_s.underscore}"
+        def #{name.to_s.gsub(/([a-z])([A-Z])/, '\1_\2').downcase!}?
+          @short_name == "#{name.to_s.gsub(/([a-z])([A-Z])/, '\1_\2').downcase!}"
         end
       RUBY
 
-      const_set(name, member.freeze)
+      member = super(name, value)
+      member.instance_eval(&block) if block_given?
+      member.define_singleton_method(:transitions_to, transitions_to) if transitions_to
+      member.freeze
+
+      const_set(name, member)
+      @members << member
+      @values[value] = member
     end
   end
 end

data/lib/literal_enums/transitions.rb

@@ -1,32 +1,30 @@
 module LiteralEnums
   module Transitions
-    def respond_to_missing?(name, include_private = false)
-      return false if name == :transitions_to
-      valid_next_states.any? { |m| m.name.to_s.demodulize.underscore.to_sym == name }
-    end
+    def >>(new_state)
+      return self if new_state == self
 
-    def method_missing(name, *args, **kwargs, &block)
-      valid_next_states.find { |m| m.name.to_s.demodulize.underscore.to_sym == name } || super
+      if transitions_to?(new_state)
+        new_state
+      else
+        raise TransitionError,
+          "You can't transition from #{self.name} to #{new_state.name}."
+      end
     end
 
-    def transition_to(new_state)
-      return new_state if can_transition_to?(new_state)
+    def transitions_to?(new_state)
+      possible_states = transitions_to
 
-      raise TransitionError, "You can't transition from #{self.name} to #{new_state.name}."
-    end
-
-    def can_transition_to?(new_state)
-      unless new_state.is_a?(self.class)
-        raise ArgumentError "You can only transition to another #{self.class.name}."
+      case possible_states
+      when Enum
+        possible_states == new_state
+      when Array
+        possible_states.include?(new_state)
       end
-
-      valid_next_states.include?(new_state)
     end
 
     private
 
-    def valid_next_states
-      return Array(transitions_to) if respond_to? :transitions_to
+    def transitions_to
       []
     end
   end

data/lib/literal_enums/version.rb

@@ -1,3 +1,3 @@
 module LiteralEnums
-  VERSION = "1.1.1"
+  VERSION = "2.0.0"
 end

data/lib/literal_enums.rb

@@ -1,11 +1,9 @@
-require "active_support"
-require "active_support/core_ext/string"
-
 require "literal_enums/version"
 require "literal_enums/transitions"
 require "enum"
 
 module LiteralEnums
-  class Error < StandardError; end
-  class TransitionError < Error; end
+  Error = Module.new
+  StandardError = Class.new(StandardError) { include Error }
+  TransitionError = Class.new(StandardError) { include Error }
 end

data/literal_enums.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/joeldrapper/literal_enums"
   spec.metadata["changelog_uri"] = "https://github.com/joeldrapper/literal_enums"
+  spec.metadata["funding_uri"] = "https://github.com/sponsors/joeldrapper"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -28,9 +29,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 2.3.7"
-  spec.add_development_dependency "rake", "~> 12.3.3"
-  spec.add_development_dependency "minitest", "~> 5.0"
-
-  spec.add_dependency "activesupport", ">= 7.0"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,71 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: literal_enums
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Joel Drapper
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-01 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.3.7
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.3.7
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-- !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: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '7.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '7.0'
+date: 2022-12-14 00:00:00.000000000 Z
+dependencies: []
 description: A comprehensive Enum library for Ruby with literal-style syntax.
 email:
 - joel@drapper.me
@@ -73,15 +17,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ruby.yml"
+- ".github/FUNDING.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- bench.rb
 - bin/console
 - bin/setup
 - lib/enum.rb
@@ -96,6 +41,8 @@ metadata:
   homepage_uri: https://github.com/joeldrapper/literal_enums
   source_code_uri: https://github.com/joeldrapper/literal_enums
   changelog_uri: https://github.com/joeldrapper/literal_enums
+  funding_uri: https://github.com/sponsors/joeldrapper
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:

data/.github/workflows/ruby.yml

@@ -1,24 +0,0 @@
-name: Ruby
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['2.7', '3.0']
-        
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run tests
-      run: bundle exec rake

data/Gemfile.lock

@@ -1,34 +0,0 @@
-PATH
-  remote: .
-  specs:
-    literal_enums (1.1.0)
-      activesupport (~> 7.0.2.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (7.0.2.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    concurrent-ruby (1.1.9)
-    i18n (1.10.0)
-      concurrent-ruby (~> 1.0)
-    minitest (5.15.0)
-    rake (12.3.3)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-
-PLATFORMS
-  arm64-darwin-21
-  x86_64-linux
-
-DEPENDENCIES
-  bundler (~> 2.3.7)
-  literal_enums!
-  minitest (~> 5.0)
-  rake (~> 12.3.3)
-
-BUNDLED WITH
-   2.3.7