rails-pattern_matching 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d0f0b6be09429d51fcbb4683ff41d54f52001860252f97dd9d92713250b5ccd
-  data.tar.gz: 53400bf0accac128b063573955666e57dcb03930e280a5a8e7d4729711763a6c
+  metadata.gz: '08e126de1c151ea3a985acfbed7d9b819c86fcf5f3ec72f8d49c9d47b8fd1ee2'
+  data.tar.gz: 9c86543873217efc90ddf02d01075ac67926d84055f13c7ea7fe3a016385abe0
 SHA512:
-  metadata.gz: 11654a4b132a304a188c94e6f96903904190c4b15f459ef0c9b276e00e6a57e7fcd59cf1c341526285f5131d2239a07fc6a3337c00cb5c9999f28b70ab4767ba
-  data.tar.gz: 7536eb9b739cabf05c38ef85cb975d961d0629bf4b44be17a39221985f972fdf9025b2de10dec0261de370f5be2c8fca39c6d5910bbb244cf33fe27ed7da4e39
+  metadata.gz: 92d70dae9127ab8f9184c985f35c994b7031b5ae1879893d24cddbe575dae2cedb8b2e92c6cefa91477511a6ba897723c2fca6a5e671b8101e13abd7074a5272
+  data.tar.gz: be879b4de1aa2ee54e1d73448ed1a9cf93f15132b38867e50ceae0524693584bdc553c0c00a53dfbd132fbbe848eac98a3ef965d66953212df79628408c69c40

data/.github/dependabot.yml

@@ -4,3 +4,7 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

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

@@ -12,7 +12,7 @@ jobs:
     steps:
       - name: Dependabot metadata
         id: metadata
-        uses: dependabot/fetch-metadata@v1.3.3
+        uses: dependabot/fetch-metadata@v1.6.0
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
       - name: Enable auto-merge for Dependabot PRs

data/.github/workflows/main.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# 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, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, 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 kddnewton@gmail.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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile.lock

@@ -1,38 +1,95 @@
 PATH
   remote: .
   specs:
-    rails-pattern_matching (0.1.0)
+    rails-pattern_matching (0.3.0)
+      actionpack
       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)
+    actionpack (7.1.3.2)
+      actionview (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actionview (7.1.3.2)
+      activesupport (= 7.1.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activemodel (7.1.3.2)
+      activesupport (= 7.1.3.2)
+    activerecord (7.1.3.2)
+      activemodel (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      timeout (>= 0.4.0)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
-    concurrent-ruby (1.1.10)
-    i18n (1.12.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
+    builder (3.2.4)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    drb (2.2.0)
+      ruby2_keywords
+    erubi (1.12.0)
+    i18n (1.14.1)
       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)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    minitest (5.22.2)
+    mutex_m (0.2.0)
+    nokogiri (1.16.2-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.2-x86_64-linux)
+      racc (~> 1.4)
+    power_assert (2.0.3)
+    prettier_print (1.2.1)
+    racc (1.7.3)
+    rack (3.0.9.1)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    rake (13.1.0)
+    ruby2_keywords (0.0.5)
+    sqlite3 (1.7.2-arm64-darwin)
+    sqlite3 (1.7.2-x86_64-linux)
+    syntax_tree (6.2.0)
+      prettier_print (>= 1.2.0)
+    test-unit (3.6.2)
       power_assert
-    tzinfo (2.0.5)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
 
 PLATFORMS
-  arm64-darwin-21
+  arm64-darwin-22
   x86_64-linux
 
 DEPENDENCIES
@@ -40,7 +97,8 @@ DEPENDENCIES
   rails-pattern_matching!
   rake
   sqlite3
+  syntax_tree
   test-unit
 
 BUNDLED WITH
-   2.3.24
+   2.4.1

data/README.md

@@ -1,8 +1,11 @@
 # rails-pattern_matching
 
-This gem provides the pattern matching interface for `ActiveModel::AttributeMethods`, `ActiveRecord::Base`, and `ActiveRecord::Relation`.
+[![Build Status](https://github.com/kddnewton/rails-pattern_matching/workflows/Main/badge.svg)](https://github.com/kddnewton/rails-pattern_matching/actions)
+[![Gem](https://img.shields.io/gem/v/rails-pattern_matching.svg)](https://rubygems.org/gems/rails-pattern_matching)
 
-That means it allows you to write code using the pattern matching against your Rails models like the following example:
+This gem provides the pattern matching interface for `ActionController::Parameters`, `ActiveModel::AttributeMethods`, `ActiveRecord::Base`, and `ActiveRecord::Relation`.
+
+That means it allows you to write code using pattern matching within your Rails applications like the following examples:
 
 ```ruby
 # app/models/post.rb
@@ -15,30 +18,55 @@ class Comment < ApplicationRecord
   belongs_to :post
 end
 
+# app/controllers/posts_controller.rb
+class PostsController < ApplicationController
+  def update
+    @post = Post.find(params[:id])
+
+    case params.require(:post).permit(:title, :body, :published)
+    in { published: true } if !can_publish?(@post, current_user)
+      # Here we are matching against a single parameter with a guard clause.
+      # This allows us to express both the value check and the authorization
+      # check in a single line.
+      render :edit, alert: "You are not authorized to publish this post"
+    in permitted if @post.update(permitted)
+      # Here we are grabbing the entire set of parameters and then using it to
+      # update the post. If the update succeeds, this branch will be taken.
+      redirect_to @post, notice: "Post was successfully updated"
+    else
+      # Here we are providing a default in case none of the above match. This
+      # will be taken if the update fails, and presumably the view will render
+      # appropriate error messages.
+      render :edit
+    end
+  end
+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: [] }
+      # 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.
       "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 { user_id:, comments: [*, { user_id: ^user_id }, *] }
+      # 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.
+      "Author replied"
+    in { comments: [{ user: { name: } }] }
+      # Here we're extracting the first comment out of the comments association
+      # and using its associated user's name in the header.
+      "One comment from #{name}"
     in { comments: }
+      # 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.
       "#{comments.length} comments"
     end
   end

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "syntax_tree/rake_tasks"
 
 Rake::TestTask.new do |t|
   t.libs << "test"
@@ -10,3 +11,11 @@ Rake::TestTask.new do |t|
 end
 
 task default: :test
+
+configure = ->(task) do
+  task.source_files =
+    FileList[%w[Gemfile Rakefile *.gemspec lib/**/*.rb test/**/*.rb]]
+end
+
+SyntaxTree::Rake::CheckTask.new(&configure)
+SyntaxTree::Rake::WriteTask.new(&configure)

data/lib/rails/pattern_matching/version.rb

@@ -2,6 +2,6 @@
 
 module Rails
   module PatternMatching
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/rails/pattern_matching.rb

@@ -2,10 +2,14 @@
 
 require "active_model"
 require "active_record"
+require "action_controller"
 require "rails/pattern_matching/version"
 
 module Rails
   module PatternMatching
+    # This error is raised when the pattern matching behavior is already
+    # defined in a class or module that we're trying to extend. We want to be
+    # careful not to silently override the behavior that's already there.
     class Error < StandardError
       def initialize(context)
         super(<<~MSG)
@@ -47,20 +51,35 @@ class ActiveRecord::Base
   #   greeting_for(person) # => "Welcome, stranger!"
   #
   def deconstruct_keys(keys)
-    keys.each_with_object({}) do |key, deconstructed|
-      method = key.to_s
+    if keys
+      # If we've been given keys, then we're going to filter down to just the
+      # values that are being requested.
+      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)
+        # We don't need to worry about the case where the user provided a key
+        # that doesn't match an attribute or association, because the match
+        # will fail by virtue of there not being a key in the result hash.
+        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
+    else
+      # If we haven't been given keys, then the user wants to grab up all of the
+      # attributes and associations for this record.
+      attributes.transform_keys(&:to_sym).merge!(
+        self.class.reflect_on_all_associations.to_h do |reflection|
+          [reflection.name, public_send(reflection.name)]
+        end
+      )
     end
   end
 end
@@ -128,12 +147,74 @@ module ActiveModel::AttributeMethods
   #   greeting_for(person) # => "Welcome, stranger!"
   #
   def deconstruct_keys(keys)
-    keys.each_with_object({}) do |key, deconstructed|
-      string_key = key.to_s
+    if keys
+      # If we've been given keys, then we're going to filter down to just the
+      # attributes that were given for this object.
+      keys.each_with_object({}) do |key, deconstructed|
+        string_key = key.to_s
 
-      if attribute_method?(string_key)
-        deconstructed[key] = public_send(string_key)
+        # If the user provided a key that doesn't match an attribute, then we
+        # do not add it to the result hash, and the match will fail.
+        if attribute_method?(string_key)
+          deconstructed[key] = public_send(string_key)
+        end
       end
+    else
+      # If we haven't been given keys, then the user wants to grab up all of the
+      # attributes for this object.
+      attributes.transform_keys(&:to_sym)
+    end
+  end
+end
+
+class ActionController::Parameters
+  if method_defined?(:deconstruct_keys)
+    raise Rails::PatternMatching::Error, "ActionController::Parameters"
+  end
+
+  # Returns a hash of parameters for the given keys. Provides the pattern
+  # matching interface for matching against hash patterns. For example:
+  #
+  #     class PostsController < ApplicationController
+  #       before_action :find_post
+  #
+  #       # PATCH /posts/:id
+  #       def update
+  #         case post_params
+  #         in { published: true, ** } if !can_publish?(current_user)
+  #           render :edit, alert: "You are not authorized to publish posts"
+  #         in permitted if @post.update(permitted)
+  #           redirect_to @post, notice: "Post was successfully updated"
+  #         else
+  #           render :edit
+  #         end
+  #       end
+  #
+  #       private
+  #
+  #       def find_post
+  #         @post = Post.find(params[:id])
+  #       end
+  #
+  #       def post_params
+  #         params.require(:post).permit(:title, :body, :published)
+  #       end
+  #     end
+  #
+  # Note that for security reasons, this method will only deconstruct keys that
+  # have been explicitly permitted. This is to avoid the potential accidental
+  # misuse of the `**` operator.
+  #
+  # Note: as an optimization, Hash#deconstruct_keys (and therefore
+  # ActiveSupport::HashWithIndifferentAccess#deconstruct_keys) always returns
+  # itself. This works because the return value then has #[] called on it, so
+  # everything works out. This can yield some somewhat surprising (albeit
+  # correct) results if you call this method manually.
+  def deconstruct_keys(keys)
+    if permitted?
+      to_h.deconstruct_keys(keys)
+    else
+      raise ArgumentError, "Only permitted parameters can be deconstructed."
     end
   end
 end

data/rails-pattern_matching.gemspec

@@ -5,27 +5,33 @@ $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.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.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.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.metadata = { "rubygems_mfa_required" => "true" }
+
   spec.add_dependency "activemodel"
   spec.add_dependency "activerecord"
+  spec.add_dependency "actionpack"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "syntax_tree"
   spec.add_development_dependency "test-unit"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pattern_matching
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-07 00:00:00.000000000 Z
+date: 2024-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  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
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: syntax_tree
+  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
@@ -105,6 +133,7 @@ files:
 - ".github/workflows/auto-merge.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -117,7 +146,8 @@ files:
 homepage: https://github.com/kddnewton/rails-pattern_matching
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -133,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.21
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Pattern matching for Rails applications