graphql-filters 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9344189bc4ae82f67f66db0a205d932500cdf8f318588e6129a64bd2374fbbac
-  data.tar.gz: d9e10df965526be218a0459234e7f79bb7626859d5f29af61ed1502559444ae5
+  metadata.gz: 2de1ec0e63619e14566194c02827c05f3b593d1a032ab2a885ab2735fd2adf81
+  data.tar.gz: d26182e54ec5bdf0fa8eef48d31d76dd429827e7ac68e6cc2614fd25d1f3f99c
 SHA512:
-  metadata.gz: f51fe336718070181df965eaab2c072cba21bd596d50c3faff28c342fdfe193996f8f3599d7a53c9940bedd8e327f5098d3abccc28b19c5e2ac8376b4d0aebca
-  data.tar.gz: 987109d5d12d53ebce9d9811f6d392a23bd23104443098ac56e9a19e428c2e725110845b120bd6d81e65a0b3cff104cbf7c25648af63a211fe4704beb7f0b573
+  metadata.gz: 45e8caf0669fc4eba7a2731f19104177610692a526799b57d55c8c4b3d97aaf849e8c3162e6a7f7ea0af9be816102e61a3332d1a6f65394d6ef56e1fa287d448
+  data.tar.gz: c348559d4851966e5227f249f95d5bcfcf6a3bf9cc3f567d80f0ff41ca87dcab2c8f0f139ac96c76cf1da903cb0856ee5c8e035f99e40dc8864e0fdac60cc794

data/CHANGELOG.md

@@ -8,6 +8,23 @@
 ### Bug fixes
 )-->
 
+## 1.0.4 2024-10-14
+
+### New features
+
+- Added `filtered_type` to declare a type for the filters which differs from the result type of the resolver.
+
+### Bug fixes
+
+- Fixed a broken `require`.
+
+## 1.0.3 2024-10-09
+
+### Bug fixes
+
+- Made dependency to Rails more lax
+- Extracted the pairing of models and GraphQL types into [a separate gem](https://github.com/moku-io/graphql-models_connect)
+
 ## 1.0.2 2023-07-24
 
 ### Bug fixes

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Moku S.r.l., Riccardo Agatea
+Copyright (c) 2023-2024 Moku S.r.l., Riccardo Agatea
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -47,6 +47,8 @@ class RoutesResolver < BaseResolver
 end
 ```
 
+By default the filters are based on the `type`. If you need them to be based on a different type (for example if the result will be wrapped in another object), you can declare it with `filtered_type`, which has the same API as `type`.
+
 Using either of these resolvers for a `routes` field will generate all the necessary input types to make a query like this:
 
 ```graphql
@@ -95,7 +97,7 @@ query {
 }
 ```
 
-Notice that eager loading is outside the scope of this gem, so if without anything else the above query will fall victim to the N+1 problem.
+Notice that eager loading is outside the scope of this gem, so without anything else the above query will fall victim to the N+1 problem.
 
 Each input type is generated based on the respective type: scalar and enum types allow for basic comparisons like equality and inclusion, while object types let you build complex queries that mix and match comparisons on their fields. List types let you make `any`, `all`, and `none` queries based on a nested filter. Support for null-checked filters is planned for future development.
 

data/lib/graphql/filters/dsl/graphql/schema/resolver.rb

@@ -0,0 +1,26 @@
+require 'active_support/concern'
+
+monkey_patch = Module.new do
+  extend ActiveSupport::Concern
+
+  class_methods do
+    attr_accessor :filtered_type_expr, :filtered_type_null
+
+    def filtered_type new_type=nil, null: nil
+      if new_type
+        raise ArgumentError, 'required argument `null:` is missing' if null.nil?
+
+        @filtered_type_expr = new_type
+        @filtered_type_null = null
+      elsif filtered_type_expr
+        GraphQL::Schema::Member::BuildType.parse_type filtered_type_expr, null: filtered_type_null
+      elsif type_expr
+        GraphQL::Schema::Member::BuildType.parse_type type_expr, null: self.null
+      elsif superclass.respond_to? :filtered_type
+        superclass.filtered_type
+      end
+    end
+  end
+end
+
+GraphQL::Schema::Resolver.prepend monkey_patch

data/lib/graphql/filters/filterable.rb

@@ -9,14 +9,14 @@ module GraphQL
       #   nullability is relevant.
 
       included do
-        raise 'You can only apply a filter to a list field' unless type.list?
+        raise 'You can only apply a filter to a list field' unless filtered_type.list?
 
         unless defined?(SearchObject::Base) && include?(SearchObject::Base)
           raise 'If you don\'t use SearchObject, you must *prepend* Filterable, not *include* it.'
         end
 
-        inner_type = type
-        inner_type = type.of_type until inner_type.kind == GraphQL::TypeKinds::LIST
+        inner_type = filtered_type
+        inner_type = filtered_type.of_type until inner_type.kind == GraphQL::TypeKinds::LIST
         inner_type = inner_type.of_type
 
         option :filter, type: inner_type.comparison_input_type do |scope, filter|
@@ -25,10 +25,10 @@ module GraphQL
       end
 
       prepended do
-        raise 'You can only apply a filter to a list field' unless type.list?
+        raise 'You can only apply a filter to a list field' unless filtered_type.list?
 
-        inner_type = type
-        inner_type = type.of_type while inner_type.kind == GraphQL::TypeKinds::LIST
+        inner_type = filtered_type
+        inner_type = filtered_type.of_type while inner_type.kind == GraphQL::TypeKinds::LIST
         inner_type = inner_type.of_type
 
         argument :filter, inner_type.comparison_input_type, required: false

data/lib/graphql/filters/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module Filters
-    VERSION = '1.0.2'
+    VERSION = '1.0.4'.freeze
   end
 end

data/lib/graphql/filters.rb

@@ -1,6 +1,7 @@
 require 'active_support/configurable'
 require 'active_support/core_ext/module/delegation'
 require 'graphql'
+require 'graphql/models_connect'
 require_relative 'filters/version'
 require_relative 'filters/utility/cached_class'
 
@@ -20,7 +21,6 @@ end
 
 # These need to be here, after the definition of GraphQL::Filters
 
-require_relative 'models_connect'
 require_relative 'filters/activerecord_patch'
 require_relative 'filters/dsl'
 require_relative 'filters/filterable'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphql-filters
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Moku S.r.l.
@@ -9,36 +9,36 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-24 00:00:00.000000000 Z
+date: 2024-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
@@ -53,6 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: graphql-models_connect
+  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'
 description: Provide a fully typed interface to filter lists in a GraphQL API.
 email:
 - info@moku.io
@@ -78,6 +92,7 @@ files:
 - lib/graphql/filters/dsl/graphql/schema/member.rb
 - lib/graphql/filters/dsl/graphql/schema/non_null.rb
 - lib/graphql/filters/dsl/graphql/schema/object.rb
+- lib/graphql/filters/dsl/graphql/schema/resolver.rb
 - lib/graphql/filters/dsl/graphql/schema/scalar.rb
 - lib/graphql/filters/dsl/graphql/types/numeric.rb
 - lib/graphql/filters/dsl/graphql/types/string.rb
@@ -93,9 +108,6 @@ files:
 - lib/graphql/filters/input_types/string_comparison_input_type.rb
 - lib/graphql/filters/utility/cached_class.rb
 - lib/graphql/filters/version.rb
-- lib/graphql/models_connect.rb
-- lib/graphql/models_connect/dsl.rb
-- lib/graphql/models_connect/dsl/graphql/schema/object.rb
 homepage: https://github.com/moku-io/graphql-filters
 licenses:
 - MIT
@@ -118,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Provide a fully typed interface to filter lists in a GraphQL API.

data/lib/graphql/models_connect/dsl/graphql/schema/object.rb

@@ -1,27 +0,0 @@
-require 'active_support/concern'
-
-monkey_patch = Module.new do
-  extend ActiveSupport::Concern
-
-  class_methods do
-    def model_class new_model_class=nil
-      if new_model_class.nil?
-        @model_class ||= default_model_class
-      else
-        @model_class = new_model_class
-      end
-    end
-
-    def default_model_class
-      raise 'You must set an explicit model for anonymous graphql classes' if name.nil?
-
-      default_model_name = name.delete_suffix 'Type'
-
-      raise "No default model found for #{name}" unless const_defined? default_model_name
-
-      const_get default_model_name
-    end
-  end
-end
-
-GraphQL::Schema::Object.prepend monkey_patch

data/lib/graphql/models_connect/dsl.rb

@@ -1,3 +0,0 @@
-Dir['dsl/**/*.rb', base: __dir__].each do |filename|
-  require_relative filename
-end

data/lib/graphql/models_connect.rb

@@ -1,15 +0,0 @@
-require 'active_support/configurable'
-require 'active_support/core_ext/module/delegation'
-require 'graphql'
-
-module GraphQL
-  module ModelsConnect
-    include ActiveSupport::Configurable
-
-    singleton_class.delegate(*config.keys, to: :config)
-  end
-end
-
-# These need to be here, after the definition of GraphQL::ModelsConnect
-
-require_relative 'models_connect/dsl'