matchable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20eea165b65f710ddb8430164ad48ac52a4893382b7ce73065964b3d35fcc5e3
+  data.tar.gz: e1e50759a271a337147ef19c44c9f95d0725ef2f9556cdecbdb2e0a8d09ef9e9
+SHA512:
+  metadata.gz: 5d1ec0a429ed529641461774b7ea5bab46e49e41c2fe7cabe1d91d2357d935b44c5a26e778ac111d35a9e272147bb77de843a4cba960a0ff623204cf3019584e
+  data.tar.gz: fd72d05a74294d517a31dbfdfbc750c40c0bc84e4c2da3c7fd00c09f8009314d2c709789b467bf298d949a0d7ab05d0fc65e876a77a9ae5b3f26660732cde8f3

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at keystonelemur@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    matchable (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    ffi (1.14.2)
+    formatador (0.2.5)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    listen (3.4.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    shellany (0.0.1)
+    thor (1.1.0)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  guard-rspec
+  matchable!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.3

data/Guardfile

@@ -0,0 +1,15 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Brandon Weaver
+
+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,135 @@
+# Matchable
+
+Pattern Matching interfaces made easy for Ruby 3.0+
+
+## Usage
+
+`Matchable` works very much like other `-able` interfaces in Ruby:
+
+```ruby
+class Something
+  include Matchable
+end
+```
+
+### Basic Example
+
+It exposes two methods, `deconstruct` and `deconstruct_keys`, after the instance methods by the same name which are used as Pattern Matching hooks in Ruby for `Array`-like and `Hash`-like matches:
+
+```ruby
+class Card
+  include Matchable
+
+  deconstruct :to_a
+  deconstruct_keys :suit, :rank
+
+  attr_reader :suit, :rank
+
+  def initialize(suit, rank)
+    @suit = suit
+    @rank = rank
+  end
+
+  def to_a() = [@suit, @rank]
+end
+```
+
+The above code will generate the following effective code within the `Card` class for you:
+
+```ruby
+class Card
+  def deconstruct
+    to_a
+  end
+
+  def deconstruct_keys(keys)
+    deconstructed_values = {}
+
+    if keys.nil? || keys.include?(:suit)
+      deconstructed_values[:suit] = suit
+    end
+
+    if keys.nil? || keys.include?(:rank)
+      deconstructed_values[:rank] = rank
+    end
+
+    deconstructed_values
+  end
+end
+```
+
+It should be noted that `nil` is passed to `deconstruct_keys` when no values are provided or when a `**rest` pattern is present in the match. In these cases all values should be returned, hence the `keys.nil? ||` check, which is correct.
+
+The generated code is optimized to only include keys which are being directly matched against, guarding against loading more data than is necessary, and all in one line of code above.
+
+In the case of `deconstruct` this method could be anything as long as it returns an `Array`. `to_a` is the most intuitive of these methods, but calling this is not required if you have more unique usecases.
+
+### Deconstructing `new`
+
+`Matchable` diverges from more vanilla Ruby in that adding a `deconstruct` against `new` will not alias the method like above, it will treat the constructor itself as the attributes to deconstruct. Consider this `Person` class:
+
+```ruby
+class Person
+  include Matchable
+
+  deconstruct :new
+  deconstruct_keys :name, :age
+
+  attr_reader :name, :age
+
+  def initialize(name, age)
+    @name = name
+    @age  = age
+  end
+end
+```
+
+By deconstructing on `new` the following code will be generated for `deconstruct`:
+
+```ruby
+class Person
+  def deconstruct
+    [name, age]
+  end
+end
+```
+
+These attributes are pulled, as mentioned above, directly from the class constructor. An `attr_reader` or similar method is expected as `Matchable` will not attempt to hunt for instance variables of the same name.
+
+If the parameter names do not match to this requirement it is advised not to use this method with `new`, and instead define your own `deconstruct` method.
+
+As with the above `deconstruct_keys` this method is dynamically generated to directly call methods rather than use `send`-like methods for performance reasons.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'matchable'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install matchable
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/baweaver/matchable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/baweaver/matchable/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 Matchable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/baweaver/matchable/blob/master/CODE_OF_CONDUCT.md).

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/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "matchable"
+
+# 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/matchable.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+require_relative "matchable/version"
+
+# Interface for Pattern Matching hooks
+#
+# @author baweaver
+# @since 0.0.1
+#
+module Matchable
+  # Constant to prepend methods and extensions to
+  MODULE_NAME = "MatchableDeconstructors".freeze
+
+  # Extend class methods for pattern matching hooks
+  def self.included(klass) = klass.extend(ClassMethods)
+
+  # Class method hooks for adding pattern matching interfaces
+  #
+  # @author baweaver
+  # @since 0.0.1
+  module ClassMethods
+    # Hook for the `deconstruct` instance method which triggers its definition
+    # based on a deconstruction method passed. If the method is not yet defined
+    # by the class it will wait until such a method is added to execute.
+    #
+    # @param method_name [Symbol]
+    #   Name of the method to bind to
+    #
+    # @return [Array[status, method_name]]
+    def deconstruct(method_name)
+      return if deconstructable_module.const_defined?('DECONSTRUCTION_METHOD')
+
+      # :new should mean :initialize if one wants to match against arguments
+      # to :new
+      method_name = :initialize if method_name == :new
+      deconstructable_module.const_set('DECONSTRUCTION_METHOD', method_name)
+
+      # If this was called after the method was added, go ahead and attach,
+      # otherwise we need some trickery to make sure the method is defined
+      # first if they used this at the top of the class above its definition.
+      if method_defined?(method_name)
+        attach_deconstructor(method_name)
+        return [true, method_name]
+      end
+
+      # Otherwise we set a flag, and hand it to `method_added` to clean up
+      # after this method
+      @_awaited_deconstruction_method = method_name
+      [false, method_name]
+    end
+
+    # Method Added hook, will trigger only if `deconstruct` could not bind to
+    # a method because it didn't exist yet.
+    #
+    # @param method_name [Symbol]
+    #   Name of the method currently being defined
+    #
+    # @return [void]
+    def method_added(method_name)
+      return unless defined?(@_awaited_deconstruction_method)
+      return unless @_awaited_deconstruction_method == method_name
+
+      attach_deconstructor(method_name)
+      remove_instance_variable(:@_awaited_deconstruction_method)
+
+      # Return is irrelevant here, mask response from `remove_instance_variable`
+      nil
+    end
+
+    # Hook for the `deconstruct_keys` method which triggers its defintion based
+    # on the keys passed to this method.
+    #
+    # @param *keys [Array[Symbol]]
+    #   Keys to deconstruct values from. Each must have an associated instance
+    #   method to work, or this will fail.
+    #
+    # @return [void]
+    def deconstruct_keys(*keys)
+      # Return early if called more than once
+      return if deconstructable_module.const_defined?('DECONSTRUCTION_KEYS')
+
+      # Ensure keys are symbols, then generate Ruby code for each
+      # key assignment branch to be used below
+      sym_keys        = keys.map(&:to_sym)
+      deconstructions = sym_keys.map { deconstructed_value(_1) }.join("\n\n")
+
+      # Retain a reference to which keys we deconstruct from
+      deconstructable_module.const_set('DECONSTRUCTION_KEYS', sym_keys)
+
+      # `public_send` can be slow, and `to_h` and `each_with_object` can also
+      # be slow. This defines the direct method calls in-line to prevent
+      # any performance penalties to generate optimal match code.
+      deconstructable_module.class_eval <<~RUBY, __FILE__ , __LINE__ + 1
+        def deconstruct_keys(keys)
+          deconstructed_values = {}
+
+          #{deconstructions}
+
+          deconstructed_values
+        end
+      RUBY
+
+      # To mask the return of the above class_eval
+      nil
+    end
+
+    # Generates Ruby code for `deconstruct_keys` branches which will
+    # directly call the method rather than utilizing `public_send` or
+    # similar methods.
+    #
+    # Note that in the case of `keys` being `nil` it is expected to return
+    # all keys that are possible from a pattern match rather than nothing,
+    # hence adding this guard in every case.
+    #
+    # @param method_name [Symbol]
+    #   Name of the method to add a deconstructed key from
+    #
+    # @return [String]
+    #   Evaluatable Ruby code for adding a deconstructed key to requested
+    #   values.
+    private def deconstructed_value(method_name)
+      <<~RUBY
+        if keys.nil? || keys.include?(:#{method_name})
+          deconstructed_values[:#{method_name}] = #{method_name}
+        end
+      RUBY
+    end
+
+    # Attaches the deconstructor to the parent class. If the method is
+    # initialize we want to deconstruct based on the parameters of class
+    # instantiation rather than alias that method, as this is a common method
+    # of deconstruction.
+    #
+    # @param method_name [Symbol]
+    #   Method to deconstruct from
+    #
+    # @return [void]
+    private def attach_deconstructor(method_name)
+      i_method = instance_method(method_name)
+
+      deconstruction_code = if method_name == :initialize
+        param_names = i_method.parameters.map(&:last)
+
+        "[#{param_names.join(', ')}]"
+      else
+        method_name
+      end
+
+      deconstructable_module.class_eval <<~RUBY, __FILE__ , __LINE__ + 1
+        def deconstruct
+          #{deconstruction_code}
+        end
+      RUBY
+
+      nil
+    end
+
+    # Prepended module to define methods against
+    #
+    # @return [Module]
+    private def deconstructable_module
+      if const_defined?(MODULE_NAME)
+        const_get(MODULE_NAME)
+      else
+        const_set(MODULE_NAME, Module.new).tap(&method(:prepend))
+      end
+    end
+  end
+end

data/lib/matchable/version.rb

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

data/matchable.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/matchable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "matchable"
+  spec.version       = Matchable::VERSION
+  spec.authors       = ["Brandon Weaver"]
+  spec.email         = ["keystonelemur@gmail.com"]
+
+  spec.summary       = "Pattern Matching interfaces for Ruby classes"
+  spec.homepage      = "https://www.github.com/baweaver/matchable"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"]   = "#{spec.homepage}/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: matchable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brandon Weaver
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-31 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- keystonelemur@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/matchable.rb
+- lib/matchable/version.rb
+- matchable.gemspec
+homepage: https://www.github.com/baweaver/matchable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.github.com/baweaver/matchable
+  source_code_uri: https://www.github.com/baweaver/matchable
+  changelog_uri: https://www.github.com/baweaver/matchable/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Pattern Matching interfaces for Ruby classes
+test_files: []