graphql_lazy_load 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f712c10800162f814d8f7d170e10231adf25aa518aab8c08b5f7d6459a8b9efe
+  data.tar.gz: 98fd3434f3a11930cdd5e7e87be35e03054d7652108f45ecf837cffb7deba177
+SHA512:
+  metadata.gz: 70c960dc556b35794248ac96afcbb067067c8a2f07b1e72987d935afe3a9a7d4eb61bbd40024f3f9dffdb27c2e624caf023080c17ae8a2387fc1ee13db760fc5
+  data.tar.gz: 13f918ac5f4d57099d5543c4fa48749ae69179c0026a71ecfef973cdbbcb61673fcbf6fb24bfbe403f6d2df6cdeb0de0b0326f538d47e7e6949a28fd4b3d18cf

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,10 @@
+require: rubocop-performance
+AllCops:
+  TargetRubyVersion: 2.5.1
+inherit_gem:
+  rubocop-rails_config:
+    - config/rails.yml
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+Metrics/LineLength:
+  Max: 110

data/.ruby-version

@@ -0,0 +1 @@
+graphql

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jonathag@cisco.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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_lazy_load.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,106 @@
+PATH
+  remote: .
+  specs:
+    graphql_lazy_load (0.1.0)
+      activerecord (>= 4.1.16)
+      graphql (>= 1.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    ast (2.4.0)
+    builder (3.2.3)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    erubi (1.8.0)
+    graphql (1.9.11)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.3)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    psych (3.1.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.2.0)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.67.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    rubocop-performance (1.1.0)
+      rubocop (>= 0.67.0)
+    rubocop-rails_config (0.5.1)
+      railties (>= 3.0)
+      rubocop (~> 0.60)
+    ruby-progressbar (1.10.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  graphql_lazy_load!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  rubocop (~> 0.67.2)
+  rubocop-performance (~> 1.1)
+  rubocop-rails_config (~> 0.5.1)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Jonathon Gardner
+
+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,90 @@
+# GraphqlLazyLoad
+
+Lazy executor for activerecord associations and graphql gem.
+
+## Installation
+
+GraphqlLazyLoad requires ActiveRecord >= 4.1.16 and Graphql >= 1.3.0. To use add this line to your application's Gemfile:
+```ruby
+gem 'graphql_lazy_load'
+```
+Then run `bundle install`.
+
+Or install it yourself as:
+
+    $ gem install graphql_lazy_load
+
+## Usage
+To use, first add the executor (`GraphqlLazyLoad::ActiveRecordRelation`) to graphqls schema:
+```ruby
+class MySchema < GraphQL::Schema
+  mutation(Types::MutationType)
+  query(Types::QueryType)
+
+  lazy_resolve(GraphqlLazyLoad::ActiveRecordRelation, :result)
+end
+```
+
+Now you can start using it! Wherever you have an association, the syntax is:
+```ruby
+field :field_name, Types::AssociationType, null: false
+def field_name
+  GraphqlLazyLoad::ActiveRecordRelation.new(self, :association_name)
+end
+```
+## Examples
+If you have two models `Team` which can have many `Players`. To lazy load players from teams do the following:
+```ruby
+module Types
+  class PlayerType < Types::BaseObject
+    ...
+    field :players, [Types::PlayerType], null: false
+    def players
+      GraphqlLazyLoad::ActiveRecordRelation.new(self, :players)
+    end
+  end
+end
+```
+And to lazy load teams from players do the following:
+```ruby
+module Types
+  class TeamType < Types::BaseObject
+    ...
+    field :team, Types::TeamType, null: false
+    def team
+      GraphqlLazyLoad::ActiveRecordRelation.new(self, :team)
+    end
+  end
+end
+```
+### Scoping
+The great thing about `GraphqlLazyLoad::ActiveRecordRelation` is it allows scopes to be passed! So for the example above if you want to allow sorting (or query, paging, etc) do the following.
+```ruby
+module Types
+  class PlayerType < Types::BaseObject
+    ...
+    field :players, [Types::PlayerType], null: false do
+      argument :order, String, required: false
+    end
+    def players(order: nil)
+      scope = Player.all
+      scope = scope.sort(order.underscore) if order
+      GraphqlLazyLoad::ActiveRecordRelation.new(self, :players, scope: scope)
+    end
+  end
+end
+```
+
+To test this out try the example app at [graph_test](https://github.com/jonathongardner/graph_test)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jonathongardner/graphql_lazy_load. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GraphqlLazyLoad project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/graphql_lazy_load/blob/master/CODE_OF_CONDUCT.md).

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,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'graphql_lazy_load'
+
+# 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_lazy_load.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_lazy_load/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphql_lazy_load"
+  spec.version       = GraphqlLazyLoad::VERSION
+  spec.authors       = ["Jonathon Gardner"]
+  spec.email         = ["theappgarnder@gmail.com"]
+
+  spec.summary       = "Lazy executor for activerecord associations and graphql gem."
+  spec.description   = "Lazy executor for activerecord associations and graphql gem."
+  spec.homepage      = "http://github.com/jonathongardner/graphql_lazy_load"
+  spec.license       = "MIT"
+
+  # 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", ">= 4.1.16"
+  spec.add_dependency "graphql", ">= 1.3.0"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rubocop", "~> 0.67.2"
+  spec.add_development_dependency "rubocop-performance", "~> 1.1"
+  spec.add_development_dependency "rubocop-rails_config", "~> 0.5.1"
+end

data/lib/graphql_lazy_load/version.rb

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

data/lib/graphql_lazy_load.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "graphql_lazy_load/version"
+require "active_record"
+
+module GraphqlLazyLoad
+  class ActiveRecordRelation
+    def initialize(type, association, scope: nil)
+      @object_class = type.object.class
+      @object_id = type.object.id
+      @association = association
+      @scope = scope
+      # Initialize the loading state for this query,
+      # or get the previously-initiated state
+      # scope cant be used as a hash key because when .hash is called on diff
+      # for ~same~ scopes its diff every time but scope == scope will return true if ~same~
+      @lazy = (type.context[context_key] ||= []).find { |c| c[:scope] == scope }
+      unless @lazy
+        @lazy = {
+          objects_to_load: Set.new,
+          ids: Set.new,
+          results: {},
+          scope: scope
+        }
+        type.context[context_key].push(@lazy)
+      end
+      # Register this to be loaded later unless we've already queued or loaded it
+      return if already_loaded_or_queued?
+      # use copy of object so it doesnt add preload to associations.
+      # this is so associations dont get loaded to object passed so different scopes get reloaded
+      lazy_objects.add(object_class.new(type.object.attributes))
+      lazy_ids.add(object_id)
+    end
+
+    # Return the loaded record, hitting the database if needed
+    def result
+      if !already_loaded? && any_to_load?
+        ActiveRecord::Associations::Preloader.new.preload(lazy_objects.to_a, association, scope)
+        lazy_objects.each do |object|
+          lazy_results[object.id] = object.send(association)
+        end
+        lazy_objects.clear
+      end
+      lazy_results[object_id]
+    end
+
+    private
+      attr_reader :object_class, :object_id, :association, :scope
+
+      def context_key
+        [object_class, association]
+      end
+
+      def already_loaded_or_queued?
+        lazy_objects.include?(object_id)
+      end
+
+      def already_loaded?
+        lazy_results.key?(object_id)
+      end
+
+      def any_to_load?
+        lazy_objects.any?
+      end
+
+      def lazy_ids
+        @lazy[:ids]
+      end
+
+      def lazy_objects
+        @lazy[:objects_to_load]
+      end
+
+      def lazy_results
+        @lazy[:results]
+      end
+  end
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: graphql_lazy_load
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathon Gardner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.16
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !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: 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: 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.67.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.67.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+description: Lazy executor for activerecord associations and graphql gem.
+email:
+- theappgarnder@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql_lazy_load.gemspec
+- lib/graphql_lazy_load.rb
+- lib/graphql_lazy_load/version.rb
+homepage: http://github.com/jonathongardner/graphql_lazy_load
+licenses:
+- MIT
+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.1
+signing_key: 
+specification_version: 4
+summary: Lazy executor for activerecord associations and graphql gem.
+test_files: []