graphql-smart_select 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5ca57cd0d224feeea180728e03b39548353d7ce6b325c73b71c074d51c4d9832
+  data.tar.gz: 556d21cf7668437c3610cfe3c8da774612c559a4de3308773c8ee483082fd863
+SHA512:
+  metadata.gz: 8e4a31c7aa8ee42ff911ad401f1823c4ce3c29db929706cf53eaf6755e980b8a5496d1a8c21894928ce26befe27acb89a453cf4f81759117191e3f743c32929e
+  data.tar.gz: 6eed5d0b7fa5531105280d575a3830d963e7c0bdc7429bf9d6d864b08f33b97e770be3aacf3c2f6c3c7746a433d45243b82c492b0a75c83231a227d65ee535c6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alexander Abroskin
+
+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,108 @@
+[![Build Status](https://travis-ci.org/Arkweid/graphql-smart_select.svg?branch=master)](https://travis-ci.org/Arkweid/graphql-smart_select)
+
+# GraphQL::SmartSelect
+
+Plugin for [graphql-ruby](https://github.com/rmosolgo/graphql-ruby) which helps to select only the required fields from the database.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-smart_select'
+```
+
+## Problem explanation
+
+Consider the following query:
+```
+query {
+  posts {
+    id
+    title
+  }
+}
+```
+
+Ruby interface for serve this query:
+```ruby
+module GraphqlAPI
+  module Types
+    class Query < GraphQL::Schema::Object
+      field :posts, Types::Post, null: false
+
+      def posts
+        Post.all
+      end
+    end
+  end
+end
+```
+In the default case, this will lead to the query: ```SELECT * FROM posts```. But we need only ```id``` and ```title```.
+For tables with a large number of columns, this has a negative effect on performance.
+
+## Usage
+
+Let's use our plugin:
+```ruby
+module GraphqlAPI
+  module Types
+    class Query < GraphQL::Schema::Object
+      # use plugin
+      field_class.prepend(GraphQL::SmartSelect)
+
+      # activate plugin
+      field :posts, Types::Post, null: false, smart_select: true
+
+      # You can also explicitly specify which fields
+      # will be added
+      field :posts, Types::Post, null: false, smart_select: [:id]
+
+      def posts
+        Post.all
+      end
+    end
+
+    class Post < GraphQL::Schema::Object
+      field_class.prepend(GraphQL::SmartSelect)
+
+      field :id, ID
+      field :title, String
+      field :raw_content, String
+      field :another_content, String
+  
+      # We'll tell the plugin which fields are needed
+      # for resolve this field
+      field :contents, db_columns: [:raw_content, :another_content]
+      
+      # For one_to_one AR assosiation we include foreign_key
+      field :user, Types::User
+
+      # For has_many AR assosiation we include primary_key
+      field :comments, [Types::Comment]
+
+      def contents
+        [object.id, object.title].join
+      end
+    end
+  end
+end
+```
+
+For this example query:
+```
+query {
+  posts {
+    title
+    contents
+    user { name }
+    comments { id }
+  }
+}
+```
+It perform following request:
+```SELECT id, title, raw_content, another_content, user_id FROM posts```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/graphql/smart_select.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'graphql/smart_select/version'
+require 'graphql/smart_select/resolver'
+
+module GraphQL
+  #
+  # Apply additional scope to the AR query
+  # which selects only the required fields
+  #
+  module SmartSelect
+    attr_reader :db_columns, :smart_select
+
+    def initialize(*args, **kwargs, &block)
+      @smart_select = kwargs.delete(:smart_select)
+      @db_columns = kwargs.delete(:db_columns)
+      super
+    end
+
+    private
+
+    def apply_scope(value, ctx)
+      if smart_select && value.is_a?(ActiveRecord::Relation)
+        fields_for_select = Resolver.new(value, ctx, smart_select).resolve
+
+        value = value.select(fields_for_select)
+      end
+      super
+    end
+  end
+end

data/lib/graphql/smart_select/assosiations.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module SmartSelect
+    #
+    # Provide methods to expose foreign keys
+    # for belongs_to and has_one assosiations
+    #
+    class Assosiations
+      attr_reader :relation, :query_fields
+
+      def initialize(relation, query_fields)
+        @relation = relation
+        @query_fields = query_fields
+      end
+
+      def expose
+        assosiations_keys
+      end
+
+      private
+
+      def assosiations_keys
+        relation.reflections.map do |assosiation_name, reflection|
+          next unless required?(assosiation_name)
+
+          if one_to_one?(reflection)
+            reflection.options[:foreign_key]&.to_s || assosiation_name.foreign_key
+          elsif has_many?(reflection)
+            relation.primary_key
+          else
+            next
+          end
+        end.uniq
+      end
+
+      def required?(assosiation_name)
+        query_fields.include? assosiation_name
+      end
+
+      def one_to_one?(reflection)
+        reflection.is_a?(ActiveRecord::Reflection::BelongsToReflection) ||
+          reflection.is_a?(ActiveRecord::Reflection::HasOneReflection)
+      end
+
+      def has_many?(reflection)
+        reflection.is_a?(ActiveRecord::Reflection::HasManyReflection)
+      end
+    end
+  end
+end

data/lib/graphql/smart_select/options.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module SmartSelect
+    #
+    # Provide methods to expose keys for available
+    # options db_columns and smart_select
+    #
+    class Options
+      attr_reader :list_of_nodes, :smart_select
+
+      def initialize(list_of_nodes, smart_select)
+        @list_of_nodes = list_of_nodes
+        @smart_select = smart_select
+      end
+
+      def expose
+        db_columns_fields | smart_select_fields
+      end
+
+      private
+
+      def db_columns_fields
+        list_of_nodes.flat_map do |_, node|
+          node.definition.metadata[:type_class].db_columns&.map(&:to_s)
+        end
+      end
+
+      def smart_select_fields
+        smart_select.is_a?(Array) ? smart_select.map(&:to_s) : []
+      end
+    end
+  end
+end

data/lib/graphql/smart_select/resolver.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'graphql/smart_select/assosiations'
+require 'graphql/smart_select/options'
+
+module GraphQL
+  module SmartSelect
+    #
+    # Resolve the minimum required fields for the query
+    #
+    class Resolver
+      attr_reader :relation, :ctx, :smart_select
+
+      def initialize(relation, ctx, smart_select)
+        @smart_select = smart_select
+        @relation = relation
+        @ctx = ctx
+      end
+
+      def resolve
+        reject_virtual_fields(
+          query_fields |
+            Assosiations.new(relation, query_fields).expose |
+            Options.new(list_of_nodes, smart_select).expose
+        ).map(&:to_sym)
+      end
+
+      private
+
+      def list_of_nodes
+        @list_of_nodes ||= ctx.irep_node.typed_children[ctx.type.unwrap]
+      end
+
+      def query_fields
+        @query_fields ||= list_of_nodes.keys.map(&:underscore)
+      end
+
+      def reject_virtual_fields(fields_for_select)
+        relation.model.column_names & fields_for_select
+      end
+    end
+  end
+end

data/lib/graphql/smart_select/version.rb

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

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: graphql-smart_select
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Alexander Abroskin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  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'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: 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: 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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+description: Provide logic for select only required fields for query
+email:
+- a.a.abroskin@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/graphql/smart_select.rb
+- lib/graphql/smart_select/assosiations.rb
+- lib/graphql/smart_select/options.rb
+- lib/graphql/smart_select/resolver.rb
+- lib/graphql/smart_select/version.rb
+homepage: https://github.com/Arkweid/graphql-smart_select
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Plugin for graphql-ruby gem
+test_files: []