graphql_activerecord_autoselect 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fffb18c54e73d6cb101b8c56dc3bd5e5d1419230d69a6bad9c8d7ad3a88326f7
+  data.tar.gz: 651b2014ca1fc9c0396f37dd4b3e0ca641f2580a64f8dc9045e9c3799c732a2b
+SHA512:
+  metadata.gz: ef4bed4908f6ccd253dcec80d9545e28df2ba967a88106d9ed97560d0570620411b87e2546174a89753fa3e25fc92cf27c89b420277567d154d6ba7d3c669a43
+  data.tar.gz: 7843c8142c0752bba929f1f71f961702c8abe7c11bbdd7238ac20331b638e3876215c02ad187a21f81c3b65688a68bc65c5c0a892ac5a7c4a96ecd0a1520de92

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v1.0.0
+
+* Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Michael van Rooijen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,276 @@
+# GraphQL ActiveRecord AutoSelect
+
+[![Gem Version](https://badge.fury.io/rb/graphql_activerecord_autoselect.svg)](https://badge.fury.io/rb/graphql_activerecord_autoselect)
+[![Test Status](https://github.com/mrrooijen/graphql_activerecord_autoselect/workflows/Test/badge.svg)](https://github.com/mrrooijen/graphql_activerecord_autoselect/actions)
+
+Automatic [ActiveRecord] column selection for [GraphQL (Ruby)] fields.
+
+This library was developed for- and extracted from [HireFire].
+
+The documentation can be found on [RubyDoc].
+
+
+### Compatibility
+
+- Ruby 2.5+
+- ActiveRecord 6.0+
+- GraphQL (Ruby) 1.9+
+
+
+### Installation
+
+Add the gem to your Gemfile and run `bundle`.
+
+```ruby
+gem "graphql_activerecord_autoselect", "~> 1"
+```
+
+
+### Example
+
+```rb
+class Types::Actor < Types::Base::Object
+  using GraphQLActiveRecordAutoSelect
+
+  field :organizations, Types::Organization, null: false, extras: [:lookahead]
+
+  def organizations(lookahead:)
+    object.organizations.autoselect(lookahead)
+  end
+
+  field :organization, Types::Organization, null: false, extras: [:lookahead] do
+    argument :id, ID, required: true
+  end
+
+  def organization(id:, lookahead:)
+    object.organizations.autoselect(lookahead).find(id)
+  end
+end
+```
+
+In this example an actor has many organizations. We allow the client to query all of the actor's organizations, or a specific one by id. We acquire the lookahead functionality provided by GraphQL Ruby and pass it to `autoselect`.
+
+The `autoselect` method is made available to all instances of ActiveRecord::Base and ActiveRecord::Relations in classes where the GraphQLActiveRecordAutoSelect refinement is used (`using GraphQLActiveRecordAutoSelect`).
+
+If you submit the following query to the server:
+
+```
+query {
+  actor {
+    organizations {
+      name
+      time_zone
+    }
+  }
+}
+```
+
+It'll translate this:
+
+```rb
+object.organizations.autoselect(lookahead)
+```
+
+Into this:
+
+```rb
+object.organizations.select(:id, :actor_id, :name, :time_zone)
+```
+
+Notice that it didn't only select the `:name` and `:time_zone` fields, but `:id` and `:actor_id` as well. These kinds of identifiers are always selected in order to avoid potential lookup issues on other relations where they're mandatory.
+
+The following fields are always selected:
+
+* The primary key field (typically id)
+* The type field
+* Fields that end in _id
+* Fields that end in _type
+
+The example above builds a select on a has many relation, but the same works for belongs to.
+
+```rb
+class Types::Organization < Types::Base::Object
+  using GraphQLActiveRecordAutoSelect
+
+  field :actor, Types::Actor, null: false, extras: [:lookahead]
+
+  def actor(lookahead:)
+    Actor.autoselect(lookahead).find(object.actor_id)
+  end
+end
+```
+
+And with this query:
+
+```
+query {
+  organization {
+    actor {
+      email
+    }
+  }
+}
+```
+
+It'll translate this:
+
+```rb
+Actor.autoselect(lookahead).find(object.actor_id)
+```
+
+Into this:
+
+```rb
+Actor.select(:id, :email).find(object.actor_id)
+```
+
+
+#### Dependents
+
+You might have fields or methods that depend on the presence of one or more fields. You can specify dependents to ensure that the requested field or method will be able to successfully compute:
+
+```rb
+class Actor < ActiveRecord::Base
+  def secret
+    decrypt(secret_digest)
+  end
+
+  private
+
+  def decrypt(column)
+    # ...
+  end
+end
+
+class Types::Actor < Types::Base::Object
+  # ...
+
+  field :email, String, null: false
+  field :full_name, String, null: false
+  field :secret, String, null: false
+
+  def self.dependents
+    {
+      :full_name => [:first_name, :last_name],
+      :secret    => [:secret_digest],
+    }
+  end
+
+  def full_name
+    "#{object.first_name} #{object.last_name}"
+  end
+
+  # ...
+end
+
+class Types::Organization < Types::Base::Object
+  using GraphQLActiveRecordAutoSelect
+
+  field :actor, Types::Actor, null: false, extras: [:lookahead]
+
+  def actor(lookahead:)
+    Actor.autoselect(lookahead, Types::Actor.dependents).find(object.actor_id)
+  end
+end
+```
+
+There's a few things to note here.
+
+1. We've defined the `secret` method in the Actor model which decrypts and returns the encrypted data stored in the `secret_digest` column.
+2. We've defined `self.dependents` on the `Types::Actor` class which describes which fields depend on what columns.
+3. We've passed in that dependent configuration to the second argument of `autoselect`.
+
+We're essentially telling autoselect that if the client selects the `full_name` field, that it has to select the `first_name` and `last_name` columns on the model. Likewise, when selecting the `secret` field, it'll select the `secret_digest` column on the model so that it has the encrypted data it needs to decrypt and return.
+
+```
+query {
+  organization {
+    actor {
+      email
+      full_name
+      secret
+    }
+  }
+}
+```
+
+It'll translates this:
+
+```rb
+Actor.autoselect(lookahead, Actor.dependents).find(object.actor_id)
+```
+
+Into this:
+
+```rb
+Actor.select(:id, :email, :first_name, :last_name, :secret_digest).find(object.actor_id)
+```
+
+Since we've selected the `full_name` and `secret` fields, autoselect selects the `first_name`, `last_name`, and `secret_digest` columns, as these are necessary in order to compute `full_name` and `secret`.
+
+
+### Contributing
+
+Bug reports and pull requests are welcome on GitHub at:
+
+https://github.com/mrrooijen/graphql_activerecord_autoselect
+
+To install the dependencies:
+
+```
+$ bundle
+```
+
+To open an interactive console:
+
+```
+$ bundle console
+```
+
+To run the tests:
+
+```
+$ bundle exec rake
+```
+
+To view the code coverage (generated after each test run):
+
+```
+$ open coverage/index.html
+```
+
+To run the local documentation server:
+
+```
+$ bundle exec rake doc
+```
+
+To build a gem:
+
+```
+$ bundle exec rake build
+```
+
+To build and install a gem on your local machine:
+
+```
+$ bundle exec rake install
+```
+
+For a list of available tasks:
+
+```
+$ bundle exec rake --tasks
+```
+
+
+### Author / License
+
+Released under the [MIT License] by [Michael van Rooijen].
+
+[Michael van Rooijen]: https://michael.vanrooijen.io
+[HireFire]: https://www.hirefire.io
+[RubyDoc]: https://rubydoc.info/gems/graphql_activerecord_autoselect
+[MIT License]: https://github.com/mrrooijen/graphql_activerecord_autoselect/blob/master/LICENSE.txt
+[GraphQL (Ruby)]: https://github.com/rmosolgo/graphql-ruby
+[ActiveRecord]: https://github.com/rails/rails/tree/master/activerecord

data/lib/graphql_activerecord_autoselect.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "graphql_activerecord_autoselect/version"
+require "active_record"
+
+module GraphQLActiveRecordAutoSelect
+  extend self
+
+  refine ::ActiveRecord::Base.singleton_class do
+    def autoselect(lookahead, dependents = {})
+      select(
+        GraphQLActiveRecordAutoSelect.call(
+          :model      => self,
+          :lookahead  => lookahead,
+          :dependents => dependents,
+        )
+      )
+    end
+  end
+
+  refine ::ActiveRecord::Relation do
+    def autoselect(lookahead, dependents = {})
+      select(
+        GraphQLActiveRecordAutoSelect.call(
+          :model      => model,
+          :lookahead  => lookahead,
+          :dependents => dependents
+        )
+      )
+    end
+  end
+
+  def call(model:, lookahead:, dependents:)
+    primary_key = model.primary_key
+    columns     = model.column_names
+    fields      = get_fields(lookahead)
+
+    Array.new.tap do |selection|
+      selection.concat filter_by_columns(fields, columns)
+      selection.concat include_identifier_columns(primary_key, columns)
+      selection.concat include_dependents(fields, dependents)
+      selection.compact!
+      selection.uniq!
+    end
+  end
+
+  private
+
+  def filter_by_columns(fields, columns)
+    fields.select { |name| columns.include?(name) }
+  end
+
+  def include_identifier_columns(primary_key, columns)
+    columns.select do |name|
+      name == primary_key || name == "type" || name.end_with?("_type") || name.end_with?("_id")
+    end
+  end
+
+  def include_dependents(fields, dependents)
+    dependents.reduce([]) do |selection, (field, columns)|
+      if fields.include?(field.to_s)
+        selection + columns.map(&:to_s)
+      else
+        selection
+      end
+    end
+  end
+
+  def get_fields(lookahead)
+    get_selections(lookahead).map(&:name).map(&:to_s)
+  end
+
+  def get_selections(lookahead)
+    if lookahead.selection(:edges).selects?(:node)
+      lookahead.selection(:edges).selection(:node).selections
+    elsif lookahead.selects?(:nodes)
+      lookahead.selection(:nodes).selections
+    else
+      lookahead.selections
+    end
+  end
+end

data/lib/graphql_activerecord_autoselect/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GraphQLActiveRecordAutoSelect
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: graphql_activerecord_autoselect
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michael van Rooijen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.14.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+- !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
+description:
+email:
+- michael@vanrooijen.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/graphql_activerecord_autoselect.rb
+- lib/graphql_activerecord_autoselect/version.rb
+homepage: https://github.com/mrrooijen/graphql_activerecord_autoselect
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mrrooijen/graphql_activerecord_autoselect
+  source_code_uri: https://github.com/mrrooijen/graphql_activerecord_autoselect
+  changelog_uri: https://github.com/mrrooijen/graphql_activerecord_autoselect/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/mrrooijen/graphql_activerecord_autoselect/issues
+  documentation_uri: https://rubydoc.info/gems/graphql_activerecord_autoselect
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Automatic ActiveRecord column selection for GraphQL (Ruby) fields.
+test_files: []