graphql-groups 0.1.1

data/lib/graphql/groups/lookahead_parser.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Groups
+    class LookaheadParser
+      def self.parse(base_selection)
+        LookaheadParser.new.group_selections(base_selection, {})
+      end
+
+      def group_selections(root, hash)
+        selections = root.selections
+        group_selections = selections.select { |selection| selection.field.is_a?(GraphQL::Groups::Schema::GroupField) }
+        group_selections.each do |selection|
+          own_query = get_field_proc(selection.field, selection.arguments)
+          hash[selection.name] ||= { proc: own_query }
+          hash[selection.name][:aggregates] = aggregates(selection)
+        end
+        group_selections
+          .filter { |selection| selection.selects?(:group_by) }
+          .each { |selection| hash[selection.name][:nested] = group_selections(selection.selection(:group_by), {}) }
+        hash
+      end
+
+      def get_field_proc(field, arguments)
+        # TODO: Use authorized instead of using send to circument protection
+        proc { |**kwargs| field.owner.send(:new, {}, nil).public_send(field.query_method, **arguments, **kwargs) }
+      end
+
+      def aggregates(group_selection)
+        aggregate_selections = group_selection.selections.select do |selection|
+          selection.field.is_a?(GraphQL::Groups::Schema::AggregateField)
+        end
+        aggregate_selections.each_with_object({}) do |selection, object|
+          name = selection.name
+          field = selection.field
+          if name == :count
+            proc = proc { |**kwargs| field.owner.send(:new, {}, nil).public_send(field.query_method, **kwargs) }
+            object[name] = { proc: proc }
+          elsif selection.field.own_attributes.present?
+            object[name] = { proc: get_aggregate_proc(field, selection.arguments), attributes: field.own_attributes }
+          end
+        end
+      end
+
+      def get_aggregate_proc(field, arguments)
+        # TODO: Use authorized instead of using send to circument protection
+        proc { |**kwargs| field.owner.send(:new, {}, nil).send(field.query_method, **kwargs, **arguments) }
+      end
+    end
+  end
+end

data/lib/graphql/groups/result_transformer.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Groups
+    class ResultTransformer
+      def run(results)
+        transform_results(results)
+      end
+
+      private
+
+      def transform_results(results)
+        # Because group query returns its results in a way that is not usable by GraphQL we need to transform these results
+        # and merge them into a single dataset.
+        #
+        # The result of a group query usually is a hash where they keys are the values of the columns that were grouped
+        # and the values are the aggregates. What we want is a deep hash where each level contains the statistics for that
+        # level in regards to the parent level.
+        #
+        # It all makes a lot more sense if you look at the GraphQL interface for statistics :)
+        #
+        # We accomplish this by transforming each result set to a hash and then merging them into a single one.
+        results.each_with_object({}) { |(key, value), object| object.deep_merge!(transform_result(key, value)) }
+      end
+
+      def transform_result(key, result)
+        result.each_with_object({}) do |(aggregate_key, value), object|
+          if value.values.any? { |x| x.is_a?(Hash) }
+            value.each { |attribute, value| object.deep_merge!(transform_attribute(key, aggregate_key, attribute, value)) }
+          else
+            object.deep_merge!(transform_aggregate(key, aggregate_key, value))
+          end
+        end
+      end
+
+      # TODO: Merge transform aggregate and transform attribute
+      def transform_aggregate(key, aggregate, result)
+        result.each_with_object({}) do |(keys, value), object|
+          key = Array.wrap(key)
+          keys = keys ? Array.wrap(keys).map { |x| x || 'null' } : ['null']
+          nested = [:nested] * (key.length - 1)
+
+          # See https://stackoverflow.com/a/5095149/2553104
+          with_zipped = key.zip(keys).zip(nested).flatten!.compact
+          with_zipped.append(aggregate)
+          hash = with_zipped.reverse.inject(value) { |a, n| { n => a } }
+          object.deep_merge!(hash)
+        end
+      end
+
+      def transform_attribute(key, aggregate, attribute, result)
+        result.each_with_object({}) do |(keys, value), object|
+          key = Array.wrap(key)
+          keys = keys ? Array.wrap(keys).map { |x| x || 'null' } : ['null']
+          nested = [:nested] * (key.length - 1)
+
+          with_zipped = key.zip(keys).zip(nested).flatten!.compact
+          with_zipped.append(aggregate)
+          with_zipped.append(attribute)
+          hash = with_zipped.reverse.inject(value) { |a, n| { n => a } }
+          object.deep_merge!(hash)
+        end
+      end
+    end
+  end
+end

data/lib/graphql/groups/schema/aggregate_field.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Groups
+    module Schema
+      class AggregateField < GraphQL::Schema::Field
+        attr_reader :own_attributes, :query_method
+
+        def initialize(query_method:, **kwargs, &definition_block)
+          @query_method = query_method
+          super(**kwargs, &definition_block)
+        end
+
+        def attribute(attribute)
+          @own_attributes ||= []
+          @own_attributes += Array.wrap(attribute)
+        end
+      end
+    end
+  end
+end

data/lib/graphql/groups/schema/aggregate_type.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'graphql'
+
+module GraphQL
+  module Groups
+    module Schema
+      class AggregateType < GraphQL::Schema::Object
+        alias aggregate object
+
+        class << self
+          def add_fields(fields)
+            fields.each do |attribute|
+              resolve_method = "resolve_#{attribute}".to_sym
+              field attribute, Float, null: false, resolver_method: resolve_method
+
+              define_method resolve_method do
+                object[attribute]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/groups/schema/group_field.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Groups
+    module Schema
+      class GroupField < GraphQL::Schema::Field
+        attr_reader :query_method
+
+        def initialize(query_method:, **options, &definition_block)
+          @query_method = query_method
+          super(**options, &definition_block)
+        end
+      end
+    end
+  end
+end

data/lib/graphql/groups/schema/group_result_type.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'graphql'
+require 'graphql/groups/schema/group_type'
+
+module GraphQL
+  module Groups
+    module Schema
+      class GroupResultType < GraphQL::Schema::Object
+        include HasAggregates
+
+        alias group_result object
+
+        field :key, String, null: false
+
+        field :count, Integer, null: false
+
+        aggregate_field :count, Integer, null: false, query_method: :count, resolver_method: :resolve_count
+
+        def key
+          group_result[0]
+        end
+
+        def count(scope:, **_)
+          scope.size
+        end
+
+        def resolve_count
+          group_result[1][:count]
+        end
+      end
+    end
+  end
+end

data/lib/graphql/groups/schema/group_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'graphql'
+
+module GraphQL
+  module Groups
+    module Schema
+      class GroupType < GraphQL::Schema::Object
+        include HasGroups
+
+        alias group object
+
+        def initialize(object, context)
+          super(object, context)
+        end
+
+        field_class(GroupField)
+      end
+    end
+  end
+end

data/lib/graphql/groups/version.rb

@@ -0,0 +1,5 @@
+module Graphql
+  module Groups
+    VERSION = '0.1.1'.freeze
+  end
+end

metadata

@@ -0,0 +1,235 @@
+--- !ruby/object:Gem::Specification
+name: graphql-groups
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Hans-Jörg Schnedlitz
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  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: gqli
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.88'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.88'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.42'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.42'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+description: "GraphQL Groups makes it easy to add aggregation queries to your GraphQL
+  schema. It combines a simple, flexible \nschema definition with high performance'\n"
+email:
+- hans.schnedlitz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/build.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql-groups.gemspec
+- lib/graphql/groups.rb
+- lib/graphql/groups/executor.rb
+- lib/graphql/groups/extensions/wrap.rb
+- lib/graphql/groups/has_aggregates.rb
+- lib/graphql/groups/has_groups.rb
+- lib/graphql/groups/lookahead_parser.rb
+- lib/graphql/groups/result_transformer.rb
+- lib/graphql/groups/schema/aggregate_field.rb
+- lib/graphql/groups/schema/aggregate_type.rb
+- lib/graphql/groups/schema/group_field.rb
+- lib/graphql/groups/schema/group_result_type.rb
+- lib/graphql/groups/schema/group_type.rb
+- lib/graphql/groups/version.rb
+homepage: https://github.com/hschne/graphql-groups
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hschne/graphql-groups
+  source_code_uri: https://github.com/hschne/graphql-groups
+  changelog_uri: https://github.com/hschne/graphql-groups/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Create flexible and performant aggregation queries with graphql-ruby
+test_files: []