graphql-filters 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc4c3d2727cdf9d6767658acca81bed6a8b9d56aa129050fbdd84d69a0ab4454
-  data.tar.gz: 9d76544c44e8890950caf45a390f078b1af0c2f0f5a689f0535b07e230e6a63b
+  metadata.gz: 8a9d2f9785a7b0347f74b77fb46760c08d86ec336efd6d631f3db797cbec46c1
+  data.tar.gz: 126111cae0cca972100e917054cd62a7fa32bf449d316ce53ca1d3b91eb89d0b
 SHA512:
-  metadata.gz: e44a35f54fa1dbc70bde801e3c13c22dde64324ab17dcd24335529f35236a0269df551f0f24a41fa75c64227bc6d2b690c4e899ed11586a0ec748b2324fe7540
-  data.tar.gz: f036f44b1124d4b692bcd7e29f8b43b0ead9d5e6bdfe997e69a2a90dbf63ecd06ed68980a93167b82dd2b5dce48a904469501c78fd401fe791e83a23e171945d
+  metadata.gz: 54a8e2562c6f323e979ca03a5a380cb88e8d630765d6cdc2db8e08cd18f280c0d60865bbe591165a3774aaa37d5e3541de5dda717e727ea503387f354928afd7
+  data.tar.gz: 9c3f9ea059cdd7e819bbed5d417115f6a55969d4e89020fe37ecd400e65ccc679a8848b1e6d66ac2b7742f07f48a499fb8c098ad56ca3ab71763f4f881e3e8fe

data/CHANGELOG.md

@@ -8,6 +8,22 @@
 ### Bug fixes
 )-->
 
+## 1.0.5 2024-11-29
+
+### Bug fixes
+
+- Fixed an internal bug in resolution of the filtered type for a resolver.
+
+## 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

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/graphql-filters.gemspec

@@ -0,0 +1,34 @@
+require_relative 'lib/graphql/filters/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'graphql-filters'
+  spec.version = GraphQL::Filters::VERSION
+  spec.authors = ['Moku S.r.l.', 'Riccardo Agatea']
+  spec.email = ['info@moku.io']
+  spec.license = 'MIT'
+
+  spec.summary = 'Provide a fully typed interface to filter lists in a GraphQL API.'
+  spec.description = 'Provide a fully typed interface to filter lists in a GraphQL API.'
+  spec.homepage = 'https://github.com/moku-io/graphql-filters'
+  spec.required_ruby_version = '>= 3.0.0' # Maybe we should check (?)
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/moku-io/graphql-filters'
+  spec.metadata['changelog_uri'] = 'https://github.com/moku-io/graphql-filters/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir File.expand_path(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'graphql', '~> 2.0.0'
+  spec.add_dependency 'graphql-models_connect'
+end

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 = inner_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 = inner_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.3'.freeze
+    VERSION = '1.0.5'.freeze
   end
 end

data/lib/graphql/filters.rb

@@ -1,7 +1,7 @@
 require 'active_support/configurable'
 require 'active_support/core_ext/module/delegation'
 require 'graphql'
-require 'models_connect'
+require 'graphql/models_connect'
 require_relative 'filters/version'
 require_relative 'filters/utility/cached_class'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphql-filters
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
 - Moku S.r.l.
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-09 00:00:00.000000000 Z
+date: 2024-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -81,6 +81,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- graphql-filters.gemspec
 - lib/graphql/filters.rb
 - lib/graphql/filters/activerecord_patch.rb
 - lib/graphql/filters/activerecord_patch/arel/nodes/contained.rb
@@ -92,6 +93,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
@@ -129,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.20
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Provide a fully typed interface to filter lists in a GraphQL API.