hq-graphql 2.2.2 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 716058e2edc04ba4af8f3ab85fb2af83dd73a89257d26e91f972edc0272de856
-  data.tar.gz: 3c844bc5ba2473a40b43e3f4e591795eb6d6adb51e763066a53d42ffc3f55de0
+  metadata.gz: ad646bb38a0bd0920ca49428245d5183377719ef6b4802a0a619dc5c8bdbbcdf
+  data.tar.gz: 53f4c4b248e1fe424d34eb37e86002a18e6a39a54c91141f939d6aa9d85438db
 SHA512:
-  metadata.gz: 518d168eda93dfccaacfcc4c50d0ec7b715db6053d9d41e5cc722078e3e967db75be980999f02bcf3e87b25667e0987205b0364065a817b60daa2ee6acfd0d4f
-  data.tar.gz: 170ee8cd55160692280044b3ac3e84fc4b615a059fbc4f8f2cc38e2c401eee6cc7e49eb48c1743b102a6ae35c3112f4640fd7f8d0822816245104cb96e888a4d
+  metadata.gz: c5978e1805f3097aaf708f667fbfb669b74205edc8c4f73f7e859f768636a41e6fd72de00dc62322e90a6e127850467b7bf0a9ebd82507f50b197625259cf7cd
+  data.tar.gz: fc94b8611372d29218b621e762ccbfac2de279a5b16276eeaf8043a8f9f19a03539ceb90c9270fe22b306b4a3191c7ab7e8e50bcf6d989d512ff3db94e23edd1

data/lib/hq/graphql/enum/filter_operation.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "hq/graphql/filter_operations"
+
+module HQ
+  module GraphQL
+    module Enum
+      class FilterOperation < ::GraphQL::Schema::Enum
+        ::HQ::GraphQL::FilterOperations::OPERATIONS.each do |filter_operation|
+          value filter_operation.name, value: filter_operation
+        end
+      end
+    end
+  end
+end

data/lib/hq/graphql/filter_operations.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "hq/graphql/enum/filter_operation"
+
+module HQ
+  module GraphQL
+    module FilterOperations
+      class Operation
+        attr_reader :name, :arel, :check_for_null, :sanitize
+
+        def initialize(name:, arel:, check_for_null: false, sanitize: nil)
+          @name           = name
+          @arel           = arel
+          @check_for_null = check_for_null
+          @sanitize       = sanitize
+        end
+
+        def sanitize_value(value)
+          sanitize ? sanitize.call(value) : value
+        end
+
+        def to_arel(table:, column_name:, value:)
+          sanitized_value = sanitize_value(value)
+
+          if arel.is_a?(Proc)
+            return arel.call(table: table, column_name: column_name, value: sanitized_value)
+          end
+
+          expression = table[column_name].send(arel, sanitized_value)
+
+          if check_for_null
+            expression = expression.or(table[column_name].eq(nil))
+          end
+
+          expression
+        end
+      end
+
+      OPERATIONS = [
+        EQUAL = Operation.new(name: "EQUAL", arel: :eq),
+        NOT_EQUAL = Operation.new(name: "NOT_EQUAL", arel: :not_eq, check_for_null: true),
+        LIKE = Operation.new(name: "LIKE", arel: :matches, sanitize: ->(value) { "%#{ActiveRecord::Base.sanitize_sql_like(value)}%" }),
+        NOT_LIKE = Operation.new(name: "NOT_LIKE", arel: :does_not_match, check_for_null: true, sanitize: ->(value) { "%#{ActiveRecord::Base.sanitize_sql_like(value)}%" }),
+        GREATER_THAN = Operation.new(name: "GREATER_THAN", arel: :gt),
+        LESS_THAN = Operation.new(name: "LESS_THAN", arel: :lt),
+        WITH = Operation.new(
+          name: "WITH",
+          arel: ->(table:, column_name:, value:) do
+            if value.casecmp("t") == 0 || value.casecmp("true") == 0
+              table[column_name].not_eq(nil)
+            else
+              table[column_name].eq(nil)
+            end
+          end
+        )
+      ]
+    end
+  end
+end

data/lib/hq/graphql/filters.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require "hq/graphql/filter_operations"
+require "hq/graphql/util"
+
+module HQ
+  module GraphQL
+    class Filters
+      BOOLEAN_VALUES = ["t", "f", "true", "false"]
+
+      def self.supported?(column)
+        !!Filter.class_from_column(column)
+      end
+
+      attr_reader :filters, :model
+
+      def initialize(filters, model)
+        @filters = Array(filters).map { |filter| Filter.for(filter, table: model.arel_table) }
+        @model = model
+      end
+
+      def validate!
+        filters.each(&:validate)
+        errors = filters.map do |filter|
+          filter.display_error_message
+        end.flatten.uniq
+
+        if errors.any?
+          raise ::GraphQL::ExecutionError, errors.join(", ")
+        end
+      end
+
+      def to_scope
+        filters.reduce(model.all) do |s, filter|
+          s.where(filter.to_arel)
+        end
+      end
+
+      class Filter
+        include ActiveModel::Validations
+        include FilterOperations
+
+        def self.for(filter, **options)
+          class_from_column(filter.field).new(filter, **options)
+        end
+
+        def self.class_from_column(column)
+          case column.type
+          when :boolean
+            BooleanFilter
+          when :date, :datetime
+            DateFilter
+          when :decimal, :integer
+            NumericFilter
+          when :string, :text
+            StringFilter
+          when :uuid
+            UuidFilter
+          end
+        end
+
+        def self.validate_operations(*operations)
+          valid_operations = operations + [WITH]
+          validates :operation, inclusion: {
+            in: valid_operations,
+            message: "only supports the following operations: #{valid_operations.map(&:name).join(", ")}"
+          }
+        end
+
+        def self.validate_value(**options)
+          validates :value, **options, unless: ->(filter) { filter.operation == WITH }
+        end
+
+        validate :validate_boolean_values, if: ->(filter) { filter.operation == WITH }
+
+        attr_reader :table, :column, :operation, :value
+
+        def initialize(filter, table:)
+          @table = table
+          @column = filter.field
+          @operation = filter.operation
+          @value = filter.value
+        end
+
+        def display_error_message
+          return unless errors.any?
+          messages = errors.messages.values.join(", ")
+          "#{column.name.camelize(:lower)} (type: #{column.type}, operation: #{operation.name}, value: \"#{value}\"): #{messages}"
+        end
+
+        def to_arel
+          operation.to_arel(table: table, column_name: column.name, value: value)
+        end
+
+        def validate_boolean_values
+          is_valid = BOOLEAN_VALUES.any? { |v| value.casecmp(v) == 0 }
+          return if is_valid
+          errors.add(:value, "WITH operation only supports boolean values (#{BOOLEAN_VALUES.join(", ")})")
+        end
+      end
+
+      class BooleanFilter < Filter
+        validate_operations
+
+        def to_arel
+          arel = super
+
+          if value.casecmp("f") == 0 || value.casecmp("false") == 0
+            arel = arel.or(table[column.name].eq(false))
+          end
+
+          arel
+        end
+      end
+
+      class DateFilter < Filter
+        validate_operations GREATER_THAN, LESS_THAN
+        validate :validate_iso8601
+
+        def validate_iso8601
+          is_valid = begin
+            DateTime.iso8601(value)
+            true
+          rescue ArgumentError
+            false
+          end
+
+          return if is_valid
+
+          today = Date.today
+          errors.add(:value, "only supports ISO8601 values (\"#{today.iso8601}\", \"#{today.to_datetime.iso8601}\")")
+        end
+      end
+
+      class NumericFilter < Filter
+        validate_operations GREATER_THAN, LESS_THAN, EQUAL, NOT_EQUAL
+        validate_value numericality: { message: "only supports numerical values" }
+      end
+
+      class StringFilter < Filter
+        validate_operations EQUAL, NOT_EQUAL, LIKE, NOT_LIKE
+      end
+
+      class UuidFilter < Filter
+        validate_operations EQUAL, NOT_EQUAL
+        validate_value format: { with: HQ::GraphQL::Util::UUID_FORMAT, message: "only supports UUID values (e.g. 00000000-0000-0000-0000-000000000000)" }
+      end
+    end
+  end
+end

data/lib/hq/graphql/resource.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
+require "hq/graphql/ext/enum_extensions"
 require "hq/graphql/ext/input_object_extensions"
 require "hq/graphql/ext/object_extensions"
+require "hq/graphql/enum/filter_operation"
 require "hq/graphql/enum/sort_by"
 require "hq/graphql/field_extension/paginated_arguments"
+require "hq/graphql/filters"
 require "hq/graphql/resource/auto_mutation"
 require "hq/graphql/scalars"
 
@@ -91,11 +94,50 @@ module HQ
             nil_query_object
           when :Input
             input_klass
+          when :FilterInput
+            filter_input
+          when :FilterFields
+            filter_fields_enum
           else
             super
           end
         end
 
+        def filter_input
+          @filter_input ||= begin
+            scoped_self = self
+
+            input_class = Class.new(::GraphQL::Schema::InputObject) do
+              graphql_name "#{scoped_self.graphql_name}FilterInput"
+
+              argument :field, scoped_self.filter_fields_enum, required: true
+              argument :operation, Enum::FilterOperation, required: true
+              argument :value, String, required: true
+            end
+
+            const_set(:FilterInput, input_class)
+          end
+        end
+
+        def filter_fields_enum
+          @filter_fields_enum ||= begin
+            scoped_self = self
+
+            enum_class = Class.new(::GraphQL::Schema::Enum) do
+              graphql_name "#{scoped_self.graphql_name}FilterFields"
+
+              lazy_load do
+                scoped_self.model_klass.columns.sort_by(&:name).each do |column|
+                  next unless HQ::GraphQL::Filters.supported?(column)
+                  value column.name.camelize(:lower), value: column
+                end
+              end
+            end
+
+            const_set(:FilterFields, enum_class)
+          end
+        end
+
         protected
 
         def default_scope(&block)
@@ -167,9 +209,13 @@ module HQ
           if find_all
             def_root field_name.pluralize, is_array: true, null: false do
               extension FieldExtension::PaginatedArguments, klass: scoped_self.model_klass if pagination
+              argument :filters, [scoped_self.filter_input], required: false
+
+              define_method(:resolve) do |filters: nil, limit: nil, offset: nil, sort_by: nil, sort_order: nil, **_attrs|
+                filters_scope = ::HQ::GraphQL::Filters.new(filters, scoped_self.model_klass)
+                filters_scope.validate!
 
-              define_method(:resolve) do |limit: nil, offset: nil, sort_by: nil, sort_order: nil, **_attrs|
-                scope = scoped_self.scope(context).all
+                scope = scoped_self.scope(context).all.merge(filters_scope.to_scope)
 
                 if pagination || page || limit
                   offset = [0, *offset].max

data/lib/hq/graphql/types/uuid.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "hq/graphql/util"
+
 module HQ
   module GraphQL
     module Types
@@ -18,16 +20,12 @@ module HQ
           private
 
           def validate_and_return_uuid(value)
-            if validate_uuid(value)
+            if ::HQ::GraphQL::Util.validate_uuid(value)
               value
             else
               raise ::GraphQL::CoercionError, "#{value.inspect} is not a valid UUID"
             end
           end
-
-          def validate_uuid(value)
-            !value || !!value.to_s.match(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/)
-          end
         end
       end
     end

data/lib/hq/graphql/util.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module HQ
+  module GraphQL
+    module Util
+      UUID_FORMAT = /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/
+
+      def self.validate_uuid(value)
+        !value || !!value.to_s.match(UUID_FORMAT)
+      end
+    end
+  end
+end

data/lib/hq/graphql/version.rb

@@ -2,6 +2,6 @@
 
 module HQ
   module GraphQL
-    VERSION = "2.2.2"
+    VERSION = "2.2.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hq-graphql
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.2.3
 platform: ruby
 authors:
 - Danny Jones
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-12 00:00:00.000000000 Z
+date: 2021-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -236,6 +236,7 @@ files:
 - lib/hq/graphql/comparator.rb
 - lib/hq/graphql/config.rb
 - lib/hq/graphql/engine.rb
+- lib/hq/graphql/enum/filter_operation.rb
 - lib/hq/graphql/enum/sort_by.rb
 - lib/hq/graphql/enum/sort_order.rb
 - lib/hq/graphql/ext.rb
@@ -249,6 +250,8 @@ files:
 - lib/hq/graphql/field_extension/association_loader_extension.rb
 - lib/hq/graphql/field_extension/paginated_arguments.rb
 - lib/hq/graphql/field_extension/paginated_loader.rb
+- lib/hq/graphql/filter_operations.rb
+- lib/hq/graphql/filters.rb
 - lib/hq/graphql/inputs.rb
 - lib/hq/graphql/object_association.rb
 - lib/hq/graphql/paginated_association_loader.rb
@@ -260,6 +263,7 @@ files:
 - lib/hq/graphql/scalars.rb
 - lib/hq/graphql/types.rb
 - lib/hq/graphql/types/uuid.rb
+- lib/hq/graphql/util.rb
 - lib/hq/graphql/version.rb
 homepage: https://github.com/OneHQ/hq-graphql
 licenses: