graphql-association_batch_resolver 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e1d2f53b7e68d2fde0df4435ceaf595c0cab576a7b465275e1888a11348c977f
+  data.tar.gz: b0f420d3ddaa0ceda0a5a23d724197beaff213d85b50d6e11898bd206c632258
+SHA512:
+  metadata.gz: f0182b2ab4ef4400eea1682fd788026068e6c1462f022b7fbfa7e18e13703533853baca820074c09dc4c26b80460230917a0c7b1fab0ed3be035aae9b4079782
+  data.tar.gz: b914a4945c385e33da8bc3881546bbdc6ddbae54317a9530194f66fa0f866e8653faf94bcbdf7e14ce8559bd4e39d965ccf78101d8210c2d55a58a1448d8398f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+/.idea/
+/.byebug_history

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.6
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in graphql-association_batch_resolver.gemspec
+gemspec

data/README.md

@@ -0,0 +1,51 @@
+# GraphQL::AssociationBatchResolver
+
+A resolver for [graphql-ruby](https://github.com/rmosolgo/graphql-ruby) that batch loads active record associations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'association_batch_resolver'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphql-association_batch_resolver
+
+## Usage
+
+```ruby
+# Model definition
+class Player < ActiveRecord::Base
+  belongs_to :team
+  
+end
+
+# Type definition
+class PlayerType < GraphQL::Schema::Object
+  field :team, resolver: GraphQL::AssociationBatchResolver.for(Player, :team) 
+end
+
+```
+
+**GraphQL::AssociationBatchResolver#for**
+ * Arguments
+   * model - ActiveRecord::Base descendant
+   * association - Any ActiveRecord association name on `model`
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/derenge/graphql-association_batch_resolver.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'graphql/association_batch_resolver'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/graphql-association_batch_resolver.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphql/association_batch_resolver/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'graphql-association_batch_resolver'
+  spec.version       = GraphQL::AssociationBatchResolver::VERSION
+  spec.authors       = ['Andrew Derenge']
+  spec.email         = ['andrew@rigup.com']
+
+  spec.summary       = 'GraphQL Resolver for ActiveRecord Associations'
+
+
+  # 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 { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '~> 5.2.0'
+  spec.add_dependency 'graphql', '~> 1.9.0'
+  spec.add_dependency 'graphql-batch', '~> 0.4.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'pry-byebug', '~> 3.7.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.74.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.4.1'
+end

data/lib/graphql/association_batch_resolver.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'graphql/association_batch_resolver/version'
+require 'graphql'
+require 'graphql/batch'
+require 'graphql/association_batch_resolver/resolver_builder'
+
+module GraphQL
+  module AssociationBatchResolver
+    class Error < StandardError; end
+    class InvalidModel < Error; end
+    class InvalidAssociation < Error; end
+
+    class << self
+      attr_writer :configuration
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+    end
+
+    def self.for(model, association)
+      ResolverBuilder.new(model, association).resolver
+    end
+
+    def self.configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+
+    class Configuration
+      attr_accessor :loader
+
+      def initialize
+        @loader = GraphQL::AssociationBatchResolver::AssociationLoader
+      end
+    end
+  end
+end

data/lib/graphql/association_batch_resolver/association_loader.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative 'column_aggregator'
+
+module GraphQL
+  module AssociationBatchResolver
+    class AssociationLoader < GraphQL::Batch::Loader
+      attr_reader :model, :model_primary_key, :association_name, :is_collection, :association_model,
+                  :association_primary_key
+      attr_accessor :scope, :model_primary_key_to_association_primary_keys
+
+      def self.validate(model, association_name)
+        new(model, association_name)
+        nil
+      end
+
+      def initialize(model, association_name)
+        @model = model
+        @association_name = association_name
+        validate
+        @model_primary_key = model.primary_key
+        association = @model.reflect_on_association(association_name)
+        @is_collection = association.collection?
+        @association_model = association.klass
+        @association_primary_key = @association_model.primary_key
+      end
+
+      def load(record)
+        raise TypeError, "#{model} loader can't load association for #{record.class}" unless record.is_a?(model)
+
+        super
+      end
+
+      # We want to load the associations on all records, even if they have the same id
+      def cache_key(record)
+        record.object_id
+      end
+
+      def perform(records)
+        preload_association(records)
+        records.each { |record| fulfill(record, read_association(record)) }
+      end
+
+      private
+
+      def validate
+        association_exists = !model.reflect_on_association(association_name).nil?
+        raise ArgumentError, "No association #{association_name} on #{model}" unless association_exists
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      def preload_association(records)
+        select_model_primary_keys = ColumnAggregator.aggregate([model.arel_table[model_primary_key]])
+
+        id_map = model.where(model_primary_key => records)
+                      .joins(association_name)
+                      .select(association_model.arel_table[Arel.star])
+                      .select(select_model_primary_keys.as('model_primary_keys'))
+                      .group(association_model.arel_table[association_primary_key])
+
+        # .merge(Pundit.policy_scope!(context[:user], association.klass))
+
+        self.scope = association_model.find_by_sql(id_map.to_sql).to_a
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      def read_association(model_record)
+        key = model_record.send(model_primary_key)
+
+        association_scope = scope.select do |association_record|
+          ColumnAggregator.deserialize(association_record.model_primary_keys).include?(key.to_s)
+        end
+
+        is_collection ? association_scope : association_scope.first
+      end
+    end
+  end
+end

data/lib/graphql/association_batch_resolver/association_resolver.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module GraphQL
+  module AssociationBatchResolver
+    class AssociationResolver < GraphQL::Schema::Resolver
+      class << self
+        attr_accessor :model, :association
+
+        def validate!
+          validate_model!
+          validate_association!
+        end
+
+        def validate_model!
+          is_active_record_model = model < ActiveRecord::Base
+
+          raise InvalidModel, "Model (#{model}) must be an ActiveRecord::Base descendant" unless is_active_record_model
+        end
+
+        def validate_association!
+          is_association = !model.reflect_on_association(association).nil?
+
+          raise InvalidAssociation, "Association :#{association} does not exist on #{model}" unless is_association
+        end
+      end
+
+      extend Forwardable
+
+      def_delegators :'self.class', :model, :association
+      attr_accessor :loader
+
+      def initialize(*args, loader_class: GraphQL::AssociationBatchResolver.configuration.loader, **keywargs, &block)
+        super(*args, **keywargs, &block)
+        @loader = loader_class.for(model, association)
+      end
+
+      def resolve(*)
+        loader.load(object)
+      end
+    end
+  end
+end

data/lib/graphql/association_batch_resolver/column_aggregator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'column_aggregators/mysql_column_aggregator'
+require_relative 'column_aggregators/postgres_column_aggregator'
+
+module GraphQL
+  module AssociationBatchResolver
+    module ColumnAggregator
+      def self.aggregate(expression)
+        adapter.aggregate(expression)
+      end
+
+      def self.deserialize(column)
+        adapter.deserialize(column)
+      end
+
+      def self.adapter
+        case ActiveRecord::Base.connection.adapter_name
+        when 'SQLite', 'Mysql2'
+          MysqlColumnAggregator
+        when 'PostgreSQL'
+          PostgresColumnAggregator
+        end
+      end
+    end
+  end
+end

data/lib/graphql/association_batch_resolver/column_aggregators/mysql_column_aggregator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module AssociationBatchResolver
+    module MysqlColumnAggregator
+      def self.aggregate(expression)
+        Arel::Nodes::NamedFunction.new('GROUP_CONCAT', expression)
+      end
+
+      def self.deserialize(column)
+        column.split(',')
+      end
+    end
+  end
+end

data/lib/graphql/association_batch_resolver/column_aggregators/postgres_column_aggregator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module AssociationBatchResolver
+    module PostgresColumnAggregator
+      def self.aggregate(expression)
+        Arel::Nodes::NamedFunction.new('ARRAY_AGG', expression)
+      end
+
+      def self.deserialize(column)
+        column
+      end
+    end
+  end
+end

data/lib/graphql/association_batch_resolver/resolver_builder.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'graphql/association_batch_resolver/association_resolver'
+require 'graphql/association_batch_resolver/association_loader'
+
+module GraphQL
+  module AssociationBatchResolver
+    class ResolverBuilder
+      attr_accessor :model, :association
+
+      def initialize(model, association)
+        @model = model
+        @association = association
+      end
+
+      def resolver_class_name
+        @resolver_class_name ||= "#{association_class_name}Resolver"
+      end
+
+      def association_class_name
+        association.to_s.classify
+      end
+
+      def resolver
+        define_resolver unless model.const_defined?(resolver_class_name)
+
+        model.const_get(resolver_class_name)
+      end
+
+      def define_resolver
+        resolver = Class.new(AssociationResolver)
+        resolver.model = model
+        resolver.association = association
+
+        model.const_set(resolver_class_name, resolver)
+
+        resolver.validate!
+      end
+    end
+  end
+end

data/lib/graphql/association_batch_resolver/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module AssociationBatchResolver
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: graphql-association_batch_resolver
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Derenge
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: graphql-batch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+description: 
+email:
+- andrew@rigup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql-association_batch_resolver.gemspec
+- lib/graphql/association_batch_resolver.rb
+- lib/graphql/association_batch_resolver/association_loader.rb
+- lib/graphql/association_batch_resolver/association_resolver.rb
+- lib/graphql/association_batch_resolver/column_aggregator.rb
+- lib/graphql/association_batch_resolver/column_aggregators/mysql_column_aggregator.rb
+- lib/graphql/association_batch_resolver/column_aggregators/postgres_column_aggregator.rb
+- lib/graphql/association_batch_resolver/resolver_builder.rb
+- lib/graphql/association_batch_resolver/version.rb
+homepage: 
+licenses: []
+metadata: {}
+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: GraphQL Resolver for ActiveRecord Associations
+test_files: []