rails-pattern_matching 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d0f0b6be09429d51fcbb4683ff41d54f52001860252f97dd9d92713250b5ccd
+  data.tar.gz: 53400bf0accac128b063573955666e57dcb03930e280a5a8e7d4729711763a6c
+SHA512:
+  metadata.gz: 11654a4b132a304a188c94e6f96903904190c4b15f459ef0c9b276e00e6a57e7fcd59cf1c341526285f5131d2239a07fc6a3337c00cb5c9999f28b70ab4767ba
+  data.tar.gz: 7536eb9b739cabf05c38ef85cb975d961d0629bf4b44be17a39221985f972fdf9025b2de10dec0261de370f5be2c8fca39c6d5910bbb244cf33fe27ed7da4e39

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/auto-merge.yml

@@ -0,0 +1,22 @@
+name: Dependabot auto-merge
+on: pull_request
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v1.3.3
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - name: Enable auto-merge for Dependabot PRs
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

data/.github/workflows/main.yml

@@ -0,0 +1,25 @@
+name: Main
+
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+    branches:
+    - main
+
+permissions:
+  contents: read
+
+jobs:
+  ci:
+    name: CI
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.1'
+        bundler-cache: true
+    - name: Test
+      run: bundle exec rake

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    rails-pattern_matching (0.1.0)
+      activemodel
+      activerecord
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
+    activerecord (7.0.4)
+      activemodel (= 7.0.4)
+      activesupport (= 7.0.4)
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    concurrent-ruby (1.1.10)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.16.3)
+    power_assert (2.0.2)
+    rake (13.0.6)
+    sqlite3 (1.5.4-arm64-darwin)
+    sqlite3 (1.5.4-x86_64-linux)
+    test-unit (3.5.5)
+      power_assert
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  rails-pattern_matching!
+  rake
+  sqlite3
+  test-unit
+
+BUNDLED WITH
+   2.3.24

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022-present Kevin Newton
+
+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,70 @@
+# rails-pattern_matching
+
+This gem provides the pattern matching interface for `ActiveModel::AttributeMethods`, `ActiveRecord::Base`, and `ActiveRecord::Relation`.
+
+That means it allows you to write code using the pattern matching against your Rails models like the following example:
+
+```ruby
+# app/models/post.rb
+class Post < ApplicationRecord
+  has_many :comments
+end
+
+# app/models/comment.rb
+class Comment < ApplicationRecord
+  belongs_to :post
+end
+
+# app/helpers/posts_helper.rb
+module PostsHelper
+  def comment_header_for(post)
+    case post
+    # Here we're matching against an attribute on the post that is an
+    # association. It will go through the association and then match against the
+    # records in the relation.
+    in { comments: [] }
+      "No comments yet"
+    # Here we're searching for a comment that has the same user_id as the post.
+    # We can do this with the "find" pattern. This syntax is all baked into
+    # Ruby, so we don't have to do anything other than define the requisite
+    # deconstruct methods that are used by the pattern matching.
+    in { comments: [*, { user_id: ^(post.user_id ) }, *] }
+      "Host replied"
+    # Here we're extracting the first comment out of the comments association.
+    in { comments: [comment] }
+      "One comment"
+    # Here we provide a default in case none of the above match. Since we have
+    # already matched against an empty array of comments and a single element
+    # array, we know that there are at least two comments. We can get the length
+    # of the comments association by capturing the comments association in the
+    # pattern itself and then using it.
+    in { comments: }
+      "#{comments.length} comments"
+    end
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rails-pattern_matching"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails-pattern_matching
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kddnewton/rails-pattern_matching.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/*_test.rb"]
+  t.verbose = true
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails/pattern_matching"
+
+require "irb"
+IRB.start(__FILE__)

data/lib/rails/pattern_matching/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rails
+  module PatternMatching
+    VERSION = "0.1.0"
+  end
+end

data/lib/rails/pattern_matching.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require "active_model"
+require "active_record"
+require "rails/pattern_matching/version"
+
+module Rails
+  module PatternMatching
+    class Error < StandardError
+      def initialize(context)
+        super(<<~MSG)
+          Pattern matching appears to already be defined in #{context}. In this
+          case the rails-pattern_matching gem should not be used because it
+          would override the pattern matching behavior given by #{context}.
+        MSG
+      end
+    end
+  end
+end
+
+class ActiveRecord::Base
+  if method_defined?(:deconstruct_keys)
+    raise Rails::PatternMatching::Error, "ActiveRecord::Base"
+  end
+
+  # Returns a hash of attributes for the given keys. Provides the pattern
+  # matching interface for matching against hash patterns. For example:
+  #
+  #   class Person < ActiveRecord::Base
+  #   end
+  #
+  #   def greeting_for(person)
+  #     case person
+  #     in { name: "Mary" }
+  #       "Welcome back, Mary!"
+  #     in { name: }
+  #       "Welcome, stranger!"
+  #     end
+  #   end
+  #
+  #   person = Person.new
+  #   person.name = "Mary"
+  #   greeting_for(person) # => "Welcome back, Mary!"
+  #
+  #   person = Person.new
+  #   person.name = "Bob"
+  #   greeting_for(person) # => "Welcome, stranger!"
+  #
+  def deconstruct_keys(keys)
+    keys.each_with_object({}) do |key, deconstructed|
+      method = key.to_s
+
+      if attribute_method?(method)
+        # Here we're pattern matching against an attribute method. We're
+        # going to use the [] method so that we either get the value or
+        # raise an error for a missing attribute in case it wasn't loaded.
+        deconstructed[key] = public_send(method)
+      elsif self.class.reflect_on_association(method)
+        # Here we're going to pattern match against an association. We're
+        # going to use the main interface for that association which can
+        # be further pattern matched later.
+        deconstructed[key] = public_send(method)
+      end
+    end
+  end
+end
+
+class ActiveRecord::Relation
+  if method_defined?(:deconstruct)
+    raise Rails::PatternMatching::Error, "ActiveRecord::Relation"
+  end
+
+  # Provides the pattern matching interface for matching against array
+  # patterns. For example:
+  #
+  #   class Person < ActiveRecord::Base
+  #   end
+  #
+  #   case Person.all
+  #   in []
+  #     "No one is here"
+  #   in [{ name: "Mary" }]
+  #     "Only Mary is here"
+  #   in [_]
+  #     "Only one person is here"
+  #   in [_, _, *]
+  #     "More than one person is here"
+  #   end
+  #
+  # Be wary when using this method with a large number of records, as it
+  # will load everything into memory.
+  #
+  def deconstruct
+    records
+  end
+end
+
+module ActiveModel::AttributeMethods
+  if method_defined?(:deconstruct_keys)
+    raise Rails::PatternMatching::Error, "ActiveModel::AttributeMethods"
+  end
+
+  # Returns a hash of attributes for the given keys. Provides the pattern
+  # matching interface for matching against hash patterns. For example:
+  #
+  #   class Person
+  #     include ActiveModel::AttributeMethods
+  #
+  #     attr_accessor :name
+  #     define_attribute_method :name
+  #   end
+  #
+  #   def greeting_for(person)
+  #     case person
+  #     in { name: "Mary" }
+  #       "Welcome back, Mary!"
+  #     in { name: }
+  #       "Welcome, stranger!"
+  #     end
+  #   end
+  #
+  #   person = Person.new
+  #   person.name = "Mary"
+  #   greeting_for(person) # => "Welcome back, Mary!"
+  #
+  #   person = Person.new
+  #   person.name = "Bob"
+  #   greeting_for(person) # => "Welcome, stranger!"
+  #
+  def deconstruct_keys(keys)
+    keys.each_with_object({}) do |key, deconstructed|
+      string_key = key.to_s
+
+      if attribute_method?(string_key)
+        deconstructed[key] = public_send(string_key)
+      end
+    end
+  end
+end

data/rails-pattern_matching.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rails/pattern_matching/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails-pattern_matching"
+  spec.version       = Rails::PatternMatching::VERSION
+  spec.authors       = ["Kevin Newton"]
+  spec.email         = ["kddnewton@gmail.com"]
+
+  spec.summary       = "Pattern matching for Rails applications"
+  spec.homepage      = "https://github.com/kddnewton/rails-pattern_matching"
+  spec.license       = "MIT"
+
+  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_dependency "activemodel"
+  spec.add_dependency "activerecord"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "test-unit"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: rails-pattern_matching
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Newton
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- kddnewton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/dependabot.yml"
+- ".github/workflows/auto-merge.yml"
+- ".github/workflows/main.yml"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- lib/rails/pattern_matching.rb
+- lib/rails/pattern_matching/version.rb
+- rails-pattern_matching.gemspec
+homepage: https://github.com/kddnewton/rails-pattern_matching
+licenses:
+- MIT
+metadata: {}
+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.21
+signing_key:
+specification_version: 4
+summary: Pattern matching for Rails applications
+test_files: []