scim2-filter 0.2.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e97f1535209f959f102bff6a8d05ab2b0be5284f99482a34bcdfe36030c949b
-  data.tar.gz: b69d559219489bfdd64a90af1c6cbc8bbb86576514d83ab985da04ddb0250dee
+  metadata.gz: 1a06f08d89647446182b280a6b6020b14f6d2507fc808aa3f60afa9d49882ebf
+  data.tar.gz: 01f68d9673c9bc6f938fe2fd7331a869efc90f64a810bb454e9388bcd10d9e74
 SHA512:
-  metadata.gz: 4aee232a4ffb1bc1a6138d96702d10c7d53face887c05522671d2079fef7e87846b1db9cbc184e976100094de729b0d38cb7db9d5b473db94811c96f4d51fe9e
-  data.tar.gz: 1f1af70c8fbb720e9b8b38ecc95b9d4e33cc5d7565393852598c661ca6770e35dd17a34b0fec24dc4f2ea9474fea74adddf5091e04bf5d8e021f937c5077200f
+  metadata.gz: 94282e498fe69171d77a26e73c193c9e96383bb3175d1b1a648d2bc600348c7b36538eae341c35fcf160fa85a461ac14887ecdd6012f17d1c83ec17c9bcb0a57
+  data.tar.gz: 24b8bc2752a9c4d3d42561660fe8364f139bff8cc4767515c839b0e3f545f2b6058d420bed235a3b08af1f30ee036515b6bf4bfde6cd4da245a481ad1497450e

data/README.md

@@ -8,8 +8,10 @@
 ## Status
 
 [![Gem Version](https://badge.fury.io/rb/scim2-filter.svg)](https://badge.fury.io/rb/scim2-filter)
-[![Travis Build Status](https://travis-ci.org/david-mccullars/scim2-filter.svg?branch=master)](https://travis-ci.org/david-mccullars/scim2-filter)
+[![Build Status](https://github.com/david-mccullars/scim2-filter/workflows/CI/badge.svg)](https://github.com/david-mccullars/scim2-filter/actions?workflow=CI)
 [![Code Climate](https://codeclimate.com/github/david-mccullars/scim2-filter/badges/gpa.svg)](https://codeclimate.com/github/david-mccullars/scim2-filter)
+[![Test Coverage](https://codeclimate.com/github/david-mccullars/scim2-filter/badges/coverage.svg)](https://codeclimate.com/github/david-mccullars/scim2-filter/coverage)
+[![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
 
 
 ## Description

data/lib/scim2/filter/arel_handler.rb

@@ -15,19 +15,32 @@ module Scim2
     #   # "users"."name" LIKE 'J%'
     #
     # @example
-    #   # urn:ietf:params:scim:schemas:core:2.0:User:userType ne "Employee" and not (emails.value co "example.com" or emails.value co "example.org")
+    #   # urn:ietf:params:scim:schemas:core:2.0:User:userType ne "Employee" and not (name.familyName.value co "ab" or name.familyName.value co "xy")
     #
     #   mapping = {
     #     userType: User.arel_table[:type],
-    #     emails: {
-    #       value: User.arel_table[:email],
+    #     name: {
+    #       familyName: User.arel_table[:family_name],
     #     },
     #   }
     #
-    #   # "users"."type" != 'Employee' AND NOT ("users"."email" LIKE '%example.com' OR "users"."email" LIKE '%example.org%')
+    #   # "users"."type" != 'Employee' AND NOT ("users"."family_name" LIKE '%ab%' OR "users"."family_name" LIKE '%xy%')
     #
-    # @note Nested filters (e.g. `emails[type eq "work"]` are not supported at this
-    #       time and will result in an `ArgumentError`
+    # @example
+    #   # emails[type eq "work" and value ew "example.com"]
+    #
+    #   mapping = {
+    #     emails: ->(path, op, value) {
+    #       case path
+    #       when [:type]
+    #         User.arel_table[:email_type]
+    #       when [:value]
+    #         User.arel_table[:email]
+    #       end
+    #     },
+    #   }
+    #
+    #   # "users"."email_type" = 'work' AND "users"."email" LIKE '%example.com'
     ##
     class ArelHandler
 
@@ -52,30 +65,8 @@ module Scim2
       # @return [Hash<Symbol, Object>]
       def on_attribute_filter(attribute_path, value, context:, op:, schema: nil)
         arel = lookup_arel(attribute_path)
-        case op
-        when :eq
-          arel.eq(value)
-        when :ne
-          arel.not_eq(value)
-        when :co
-          arel.matches("%#{value}%")
-        when :sw
-          arel.matches("#{value}%")
-        when :ew
-          arel.matches("%#{value}")
-        when :gt
-          arel.gt(value)
-        when :ge
-          arel.gteq(value)
-        when :lt
-          arel.lt(value)
-        when :le
-          arel.lteq(value)
-        when :pr
-          arel.not_eq(nil)
-        else
-          raise Racc::ParseError, "invalid attribute operand #{op.inspect} with argument #{value.inspect}"
-        end
+        arel = arel.call(attribute_path, op, value) if arel.is_a?(Proc)
+        apply_arel_operation(arel, op, value) or raise Racc::ParseError, "invalid attribute operand #{op.inspect} with argument #{value.inspect}"
       end
 
       # Handle logical filters (e.g. `name.givenName sw "D" AND title co "VP"`)
@@ -94,32 +85,99 @@ module Scim2
         end
       end
 
+      # Begins capturing nested filter conditions inside a SimpleHandler
+      # @return nil
+      def before_nested_filter(*_ignored)
+        @nested_filter_handler = SimpleHandler.new
+        nil
+      end
+
       # Handle nested filters (e.g. `emails[type eq "work"]`)
       # @param attribute_path [Array<Symbol>] the attribute name(s) being filtered on, split by `.`
       # @param filter [Hash<Symbol, Object>] the nested filter inside the backets
       # @param schema [String] schema namespace of the attribute
       # @return [Hash<Symbol, Object>]
       def on_nested_filter(attribute_path, filter, context:, schema: nil)
-        raise ArgumentError, 'Nested attributes are not currently supported for AREL'
+        @nested_filter_handler = nil
+        arel = lookup_arel(attribute_path)
+        recursively_handle_nested_filter(arel, *filter.first)
+      end
+
+      # Wrap the following methods with logic that delegates to nested_filter_handler
+      # if it responds to the method.
+      %i[on_not_filter on_attribute_filter on_logical_filter].each do |name|
+        orig = "___#{name}".to_sym
+        define_method(orig, instance_method(name))
+        send(:private, orig)
+
+        define_method(name) do |*args, **opts|
+          if @nested_filter_handler.respond_to?(name)
+            @nested_filter_handler.send(name, *args, **opts)
+          else
+            send(orig, *args, **opts)
+          end
+        end
       end
 
       protected
 
+      def apply_arel_operation(arel, op, value)
+        case op
+        when :eq
+          arel.eq(value)
+        when :ne
+          arel.not_eq(value)
+        when :co
+          arel.matches("%#{value}%")
+        when :sw
+          arel.matches("#{value}%")
+        when :ew
+          arel.matches("%#{value}")
+        when :gt
+          arel.gt(value)
+        when :ge
+          arel.gteq(value)
+        when :lt
+          arel.lt(value)
+        when :le
+          arel.lteq(value)
+        when :pr
+          arel.not_eq(nil)
+        end
+      end
+
       # Looks up the arel object from the mapping according to the given attribute path
       # @param attribute_path [Array<Symbol>] the attribute name(s) being filtered on, split by `.`
       # @return [Object] the object returned by the mapping
       def lookup_arel(attribute_path)
         arel = arel_mapping.dig(*attribute_path)
+
         case arel
         when NilClass
           raise ArgumentError, "Attribute #{attribute_path.join(',').inspect} not found in mapping"
-        when Arel::Predications
+        when Arel::Predications, Proc
           arel
         else
           raise ArgumentError, "Mapping for attribute #{attribute_path.join(',').inspect} is not a valid arel object"
         end
       end
 
+      def recursively_handle_nested_filter(arel, op, condition)
+        case op
+        when :not
+          recursively_handle_nested_filter(arel, *condition.first).not
+        when :and, :or
+          condition.map do |c|
+            recursively_handle_nested_filter(arel, *c.first)
+          end.reduce(op)
+        else
+          path, value = condition.values_at(:path, :value)
+          arel = arel.call(path, op, value) if arel.is_a?(Proc)
+          arel = apply_arel_operation(arel, op, value) if arel && !arel.is_a?(Arel::Nodes::Node)
+          arel || Arel::Nodes::False.new
+        end
+      end
+
     end
   end
 end

data/lib/scim2/filter/parser.racc

@@ -49,12 +49,20 @@ rule
         }
 
   nested_filter
-    : attr_path LBRACKET filter RBRACKET
+    : nested_filter_start filter RBRACKET
       {
-        attr, _, filter, _ = val
+        attr, filter, _ = val
         result = handler.on_nested_filter(attr[:path], filter, schema: attr[:schema], context: result)
       }
 
+  nested_filter_start
+    : attr_path LBRACKET
+      {
+        attr, _ = val
+        handler.before_nested_filter(attr[:path], schema: attr[:schema], context: result) if handler.respond_to?(:before_nested_filter)
+        result = attr
+      }
+
   grouped_filter
     : LPAREN filter RPAREN
       {

data/lib/scim2/filter/parser.tab.rb

@@ -1,6 +1,6 @@
 #
 # DO NOT MODIFY!!!!
-# This file is automatically generated by Racc 1.5.2
+# This file is automatically generated by Racc 1.6.0
 # from Racc grammar file "".
 #
 
@@ -11,48 +11,48 @@ module Scim2
 ##### State transition tables begin ###
 
 racc_action_table = [
-    20,    21,    22,    23,    24,    25,    26,    27,    28,    17,
-    14,    10,     9,    16,     9,    19,    10,     9,    10,     9,
-    13,    11,    13,    15,    32,    13,    11,    13,    11,    10,
-     9,    10,     9,    38,    37,    39,    40,    15,    13,    11,
-    13,    11,    44,    15,    33,    32,    42,    43,    16 ]
+    21,    22,    23,    24,    25,    26,    27,    28,    29,    18,
+    15,    11,    10,    17,    10,    20,    11,    10,    11,    10,
+    14,    12,    14,    16,    34,    14,    12,    14,    12,    11,
+    10,    11,    10,    40,    39,    41,    42,    16,    14,    12,
+    14,    12,    43,    16,    35,    34,    44,    45,    17 ]
 
 racc_action_check = [
      8,     8,     8,     8,     8,     8,     8,     8,     8,     8,
-     1,     0,     0,     2,    10,     8,     9,     9,    15,    15,
-     0,     0,    11,     1,    12,     9,     9,    15,    15,    16,
-    16,    19,    19,    18,    18,    18,    18,    41,    16,    16,
-    19,    19,    41,    29,    14,    31,    29,    32,    34 ]
+     1,     0,     0,     2,    11,     8,     9,     9,    10,    10,
+     0,     0,    12,     1,    13,     9,     9,    10,    10,    16,
+    16,    17,    17,    19,    19,    19,    19,    30,    16,    16,
+    17,    17,    30,    31,    15,    33,    31,    34,    36 ]
 
 racc_action_pointer = [
     -3,    10,     1,   nil,   nil,   nil,   nil,   nil,    -2,     2,
-    -1,    -1,    -1,   nil,    44,     4,    15,   nil,    14,    17,
-   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,    30,
-   nil,    20,    24,   nil,    36,   nil,   nil,   nil,   nil,   nil,
-   nil,    24,   nil,   nil,   nil ]
+     4,    -1,    -1,    -1,   nil,    44,    15,    17,   nil,    14,
+   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,
+    24,    30,   nil,    20,    24,   nil,    36,   nil,   nil,   nil,
+   nil,   nil,   nil,   nil,   nil,   nil ]
 
 racc_action_default = [
-   -31,   -31,    -1,    -3,    -5,    -6,    -7,    -8,   -31,   -31,
-   -31,   -31,   -15,   -17,   -31,   -31,   -31,    -9,   -31,   -31,
-   -18,   -19,   -20,   -21,   -22,   -23,   -24,   -25,   -26,   -31,
-   -13,   -14,   -31,    45,    -2,    -4,   -10,   -27,   -28,   -29,
-   -30,   -31,   -12,   -16,   -11 ]
+   -32,   -32,    -1,    -3,    -5,    -6,    -7,    -8,   -32,   -32,
+   -32,   -32,   -32,   -16,   -18,   -32,   -32,   -32,    -9,   -32,
+   -12,   -19,   -20,   -21,   -22,   -23,   -24,   -25,   -26,   -27,
+   -32,   -32,   -14,   -15,   -32,    46,    -2,    -4,   -10,   -28,
+   -29,   -30,   -31,   -11,   -13,   -17 ]
 
 racc_goto_table = [
-     1,    34,    35,    30,    18,    36,    31,   nil,   nil,    29,
-   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,    41 ]
+     1,    36,    37,    32,    19,    38,    33,   nil,   nil,    30,
+    31 ]
 
 racc_goto_check = [
-     1,     2,     3,     6,     9,    10,    11,   nil,   nil,     1,
-   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,   nil,     1 ]
+     1,     2,     3,     6,     9,    10,    12,   nil,   nil,     1,
+     1 ]
 
 racc_goto_pointer = [
-   nil,     0,   -14,   -14,   nil,   nil,    -7,   nil,   nil,    -4,
-   -13,    -5 ]
+   nil,     0,   -15,   -15,   nil,   nil,    -8,   nil,   nil,    -4,
+   -14,   nil,    -6 ]
 
 racc_goto_default = [
    nil,   nil,     2,     3,     4,     5,     6,     7,     8,   nil,
-   nil,    12 ]
+   nil,     9,    13 ]
 
 racc_reduce_table = [
   0, 0, :racc_error,
@@ -66,13 +66,14 @@ racc_reduce_table = [
   1, 29, :_reduce_none,
   2, 30, :_reduce_9,
   3, 30, :_reduce_10,
-  4, 31, :_reduce_11,
-  3, 32, :_reduce_12,
-  2, 33, :_reduce_13,
-  2, 34, :_reduce_14,
-  1, 34, :_reduce_15,
-  3, 37, :_reduce_16,
-  1, 37, :_reduce_17,
+  3, 31, :_reduce_11,
+  2, 37, :_reduce_12,
+  3, 32, :_reduce_13,
+  2, 33, :_reduce_14,
+  2, 34, :_reduce_15,
+  1, 34, :_reduce_16,
+  3, 38, :_reduce_17,
+  1, 38, :_reduce_18,
   1, 35, :_reduce_none,
   1, 35, :_reduce_none,
   1, 35, :_reduce_none,
@@ -87,9 +88,9 @@ racc_reduce_table = [
   1, 36, :_reduce_none,
   1, 36, :_reduce_none ]
 
-racc_reduce_n = 31
+racc_reduce_n = 32
 
-racc_shift_n = 45
+racc_shift_n = 46
 
 racc_token_table = {
   false => 0,
@@ -177,6 +178,7 @@ Racc_token_to_s_table = [
   "attr_path",
   "comp_op",
   "comp_value",
+  "nested_filter_start",
   "attr_path_elements" ]
 
 Racc_debug_parser = false
@@ -235,7 +237,7 @@ module_eval(<<'.,.,', 'parser.racc', 46)
 
 module_eval(<<'.,.,', 'parser.racc', 53)
   def _reduce_11(val, _values, result)
-            attr, _, filter, _ = val
+            attr, filter, _ = val
         result = handler.on_nested_filter(attr[:path], filter, schema: attr[:schema], context: result)
 
     result
@@ -244,14 +246,24 @@ module_eval(<<'.,.,', 'parser.racc', 53)
 
 module_eval(<<'.,.,', 'parser.racc', 60)
   def _reduce_12(val, _values, result)
-            result = val[1]
+            attr, _ = val
+        handler.before_nested_filter(attr[:path], schema: attr[:schema], context: result) if handler.respond_to?(:before_nested_filter)
+        result = attr
 
     result
   end
 .,.,
 
-module_eval(<<'.,.,', 'parser.racc', 66)
+module_eval(<<'.,.,', 'parser.racc', 68)
   def _reduce_13(val, _values, result)
+            result = val[1]
+
+    result
+  end
+.,.,
+
+module_eval(<<'.,.,', 'parser.racc', 74)
+  def _reduce_14(val, _values, result)
             _, filter = val
         result = handler.on_not_filter(filter, context: result)
 
@@ -259,8 +271,8 @@ module_eval(<<'.,.,', 'parser.racc', 66)
   end
 .,.,
 
-module_eval(<<'.,.,', 'parser.racc', 73)
-  def _reduce_14(val, _values, result)
+module_eval(<<'.,.,', 'parser.racc', 81)
+  def _reduce_15(val, _values, result)
               schema, path = val
           result = { schema: schema, path: path }
 
@@ -268,32 +280,30 @@ module_eval(<<'.,.,', 'parser.racc', 73)
   end
 .,.,
 
-module_eval(<<'.,.,', 'parser.racc', 78)
-  def _reduce_15(val, _values, result)
+module_eval(<<'.,.,', 'parser.racc', 86)
+  def _reduce_16(val, _values, result)
               result = { path: val.last }
 
     result
   end
 .,.,
 
-module_eval(<<'.,.,', 'parser.racc', 84)
-  def _reduce_16(val, _values, result)
+module_eval(<<'.,.,', 'parser.racc', 92)
+  def _reduce_17(val, _values, result)
               result = [*val.first, val.last]
 
     result
   end
 .,.,
 
-module_eval(<<'.,.,', 'parser.racc', 88)
-  def _reduce_17(val, _values, result)
+module_eval(<<'.,.,', 'parser.racc', 96)
+  def _reduce_18(val, _values, result)
               result = [val.last]
 
     result
   end
 .,.,
 
-# reduce 18 omitted
-
 # reduce 19 omitted
 
 # reduce 20 omitted
@@ -318,6 +328,8 @@ module_eval(<<'.,.,', 'parser.racc', 88)
 
 # reduce 30 omitted
 
+# reduce 31 omitted
+
 def _reduce_none(val, _values, result)
   val[0]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scim2-filter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.1.0
 platform: ruby
 authors:
 - David McCullars
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-14 00:00:00.000000000 Z
+date: 2022-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: racc
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.1'
+- !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: github-markup
+  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
@@ -86,14 +114,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +136,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-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: rubocop-rspec
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -163,7 +233,8 @@ files:
 homepage: https://github.com/david-mccullars/scim2-filter
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -172,14 +243,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Parser for SCIM query filters