literal_enums 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5032b916232ac6faa5494185fcf1fd84914e3e7781f791a0466e9b7617d136b9
+  data.tar.gz: b7ab5c1a471672329cbd2f23707d206cd214c4bdb1b066ba908124750acd4e50
+SHA512:
+  metadata.gz: 609cbdcfa378843a507deb5d01b9da8a66e5d91a5e3b96b723a57af19e1cb3cb056fa4c9eac7bee96edec89544ce3e8d290c3da3cc664c30d09b9796a0fe4577
+  data.tar.gz: 7f58231fbdad7bd52c717a0a05922661945fee6b0db62604bb85ee05d52fc62d9bc77071f11e7a8466cf84acc1f9911bca2e03481dad2e215b8d801dd25da432

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+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/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+3.1.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+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
+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.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 literal_enums.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    literal_enums (1.0.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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Joel Drapper
+
+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,175 @@
+# literal_enums
+
+Literal Enums makes Enumerations first-class citizens in Ruby, providing a literal definition syntax.
+
+## Usage
+
+You can define an enum by subclassing `Enum` and using the literal syntax.
+
+```ruby
+class Color < Enum
+  Red()
+  Green()
+  Blue()
+end
+```
+
+Here we’ve enumerated `Color::Red`, `Color::Green`, and `Color::Blue` constants that reference unique instances of `Color`. You can verify this in the console:
+
+```ruby
+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`.
+
+Members also have polymorphic predicate methods for each member of the enumeration in lower-snake-case.
+
+```ruby
+color = Color::Red
+
+color.red? # true
+color.green? # false
+```
+
+### Values
+
+Literal Enums can also be defined with values:
+
+```ruby
+class Color < Enum
+  Red("ff0000")
+  Green("00ff00")
+  Blue("0000ff")
+end
+```
+
+Then we can look up all the values.
+
+```ruby
+Color.values # returns a Set of "ff0000", "00ff00", "0000f".
+```
+
+We can also look at the value for any member directly.
+
+```ruby
+Color::Red.value # returns "ff0000"
+```
+
+Additionally, we can cast an Enum member from its value:
+
+```ruby
+Color.cast("ff0000") # returns Color::Red
+```
+
+### Singletons
+
+When defining an enumeration, we can optionally provide a block that allows us to define methods on the singleton member. An example use-case might be a Switch that can be toggled On and Off. Whichever state its in, `toggle` will return the other state.
+
+```ruby
+class Switch < Enum
+  On do
+    def toggle
+      Off
+    end
+  end
+
+  Off do
+    def toggle
+      On
+    end
+  end
+end
+
+Switch::On.toggle # returns Switch::Off
+Switch::Off.toggle # returns Switch::On
+```
+
+### State machine
+
+It is also possible to define a more complex state machine by defining `transitions_to` methods on member singletons.
+
+```ruby
+class State < Enum
+  Unprocessed do
+    def transitions_to
+      [Validated, Errored]
+    end
+  end
+
+  Validated do
+    def transitions_to
+      [Published, Errored]
+    end
+  end
+
+  Published do
+    def transitions_to
+      [Processed, Errored]
+    end
+  end
+
+  Processed()
+  Errored()
+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::Unprocessed.transition_to(State::Validated) # returns State::Validated.
+State::Unprocessed.transition_to(State::Processed) # raises a LiteralEnums::TransitionError.
+```
+
+Alternatively, we can call the new state as a method on the old state.
+
+```ruby
+State::Unprocessed.validated # returns State::Validated.
+```
+
+An invalid transition will 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.
+
+```ruby
+State::Unprocessed.validated.processed # returns State::Processed, since it's valid to
+                                       # move to State::Processed from State::Validated and it's
+                                       # valid to move to State::Validated from State::Unprocessed.
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "literal_enums"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install literal_enums
+
+### Rails
+
+Literal Enums are compatible with Rails. Please see `literal_enums-rails`.
+
+## 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/joeldrapper/literal_enums. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the LiteralEnums project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/joeldrapper/literal_enums/blob/master/CODE_OF_CONDUCT.md).

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 "literal_enums"
+
+# 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/enum.rb

@@ -0,0 +1,63 @@
+class Enum
+  include LiteralEnums::Transitions
+
+  attr_reader :name, :value
+
+  alias_method :to_s, :value
+  alias_method :inspect, :name
+
+  def initialize(name, value)
+    @name = "#{self.class.name}::#{name}"
+    @value = value || @name
+  end
+
+  class << self
+    def method_missing(name, *args, **kwargs, &block)
+      return super unless name[0] == name[0].upcase
+      new(name, *args, **kwargs, &block)
+    end
+
+    def cast(value)
+      members.find { |v| v.value == value.to_s }
+    end
+
+    def values
+      members.map(&:value).to_set
+    end
+
+    def each(&block)
+      members.each(&block)
+    end
+
+    def members
+      constants.map { |c| const_get(c) }.to_set
+    end
+
+    private
+
+    def new(name, value = nil, &block)
+      if self == Enum
+        raise ArgumentError, "You can't add values to the abstract Enum class itself."
+      end
+
+      if constants.include?(name)
+        raise ArgumentError, "Name conflict: '#{self.name}::#{name}' is already defined."
+      end
+
+      if values.include?(value)
+        raise ArgumentError, "Value conflict: the value '#{value}' is defined for '#{self.cast(value).name}'."
+      end
+
+      member = super(name, value)
+      member.instance_eval(&block) if block_given?
+
+      class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+        def #{name.to_s.underscore}?
+          name.demodulize.underscore == "#{name.to_s.underscore}"
+        end
+      RUBY
+
+      const_set(name, member.freeze)
+    end
+  end
+end

data/lib/literal_enums/transitions.rb

@@ -0,0 +1,33 @@
+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 method_missing(name, *args, **kwargs, &block)
+      valid_next_states.find { |m| m.name.to_s.demodulize.underscore.to_sym == name } || super
+    end
+
+    def transition_to(new_state)
+      return new_state if can_transition_to?(new_state)
+
+      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}."
+      end
+
+      valid_next_states.include?(new_state)
+    end
+
+    private
+
+    def valid_next_states
+      return Array(transitions_to) if respond_to? :transitions_to
+      []
+    end
+  end
+end

data/lib/literal_enums/version.rb

@@ -0,0 +1,3 @@
+module LiteralEnums
+  VERSION = "1.0.0"
+end

data/lib/literal_enums.rb

@@ -0,0 +1,11 @@
+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
+end

data/literal_enums.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "literal_enums/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "literal_enums"
+  spec.version       = LiteralEnums::VERSION
+  spec.authors       = ["Joel Drapper"]
+  spec.email         = ["joel@drapper.me"]
+
+  spec.summary       = "Literal Enums syntax for Ruby"
+  spec.description   = "A comprehensive Enum library for Ruby with literal-style syntax."
+  spec.homepage      = "https://github.com/joeldrapper/literal_enums"
+  spec.license       = "MIT"
+
+  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"
+
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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", "~> 2.3.7"
+  spec.add_development_dependency "rake", "~> 12.3.3"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency "activesupport", "~> 7.0.2.2"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: literal_enums
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Joel Drapper
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-03-09 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.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.2.2
+description: A comprehensive Enum library for Ruby with literal-style syntax.
+email:
+- joel@drapper.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/enum.rb
+- lib/literal_enums.rb
+- lib/literal_enums/transitions.rb
+- lib/literal_enums/version.rb
+- literal_enums.gemspec
+homepage: https://github.com/joeldrapper/literal_enums
+licenses:
+- MIT
+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
+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: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Literal Enums syntax for Ruby
+test_files: []