graphql-active_record 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6414d67ab6d1c132f21b9d5f524f02e4b5f40ad
+  data.tar.gz: 603ea87d0c8c312fdb45e2f6ffec35042b6ccbd1
+SHA512:
+  metadata.gz: 899d39dd4050f0ba6ef263ea8b2cb32b243191e64d4032458c93b4fa240e47915e3f20c9cc66fc150e68f98b8480f536049bdc18894da27ec09cbbab06345817
+  data.tar.gz: 8137736c092baa4e4c7dc56b123f2a7137ee3c53271179bb8facc8dcbccf114a794009cffea633f8ec08160a60f8bb89eba4977ce204550d06a2d5e62395ec2a

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in graphql-active-record.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Brett Jurgens
+
+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,41 @@
+# Graphql::Active::Record
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/graphql/active/record`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-active-record'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphql-active-record
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/graphql-active-record.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+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/active_record"
+
+# 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

data/bin/setup

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

data/graphql-active-record.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphql/active_record/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphql-active_record"
+  spec.version       = Graphql::ActiveRecord::VERSION
+  spec.authors       = ["Brett Jurgens"]
+  spec.email         = ["brett@brettjurgens.com"]
+
+  spec.summary       = "Active Record Helpers for graphql-ruby"
+  spec.homepage      = "http://github.com/brettjurgens/graphql-active-record"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "graphql", "~> 0.8"
+  spec.add_runtime_dependency "rails/activerecord"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/graphql/active_record.rb

@@ -0,0 +1,137 @@
+require 'rails/activerecord'
+require 'graphql'
+
+require "graphql/active_record/version"
+
+##
+# This class allows GraphQL to translate ActiveRecord objects into
+# GraphQL objects easily and does an auto-include to make it
+# somewhat more efficient (hopefully)
+class Graphql::ActiveRecord < ::GraphQL::Field
+  def initialize(model:, type:, use_uuid: false)
+    @model = model
+    @use_uuid = use_uuid
+
+    self.type = type
+    self.description = "Find a #{model.name} by ID"
+    self.arguments = {
+      id: GraphQL::Argument.define do
+        type !GraphQL::ID_TYPE
+        description "Id for record"
+      end
+    }
+  end
+
+  ##
+  # override of GraphQL::Field.resolve
+  # basically just provides the final object (in this case an AR model)
+  # can check RDoc for graphql-ruby gem
+  #
+  # @param object not used
+  # @param arguments List[GraphQL::Argument] List of Arguments for the field (i.e. id, uuid, etc.)
+  # @param ctx [GraphQL::Context] the context of the GraphQL query
+  #
+  # @return eager-loaded ActiveRecord model
+  def resolve(object, arguments, ctx)
+    includes = map_includes(@model, ctx.ast_node.selections, ctx)
+
+    model_with_includes = @model.includes(*includes)
+    if @use_uuid
+      model_with_includes.find_by_uuid(arguments['id'])
+    else
+      model_with_includes.find(arguments['id'])
+    end
+
+    rescue ActiveRecord::ConfigurationError => e
+      @model.find(arguments['id'])
+  end
+
+  private
+  ##
+  # generates an array for use in AR::QueryMethods.includes
+  # allows for nested includes as well
+  # supports fragments
+  #
+  # @param model [ActiveRecord::Base] an ActiveRecord model
+  # @param selections [GraphQL::Selection] selections on the current model
+  # @param ctx [GraphQL::Context] the context of the GraphQL query. Used to map fragments to models
+  #
+  # @return Array of tables to include in the query
+  def map_includes(model, selections, ctx)
+    selections.map do |selection|
+
+      table_name, node = handle_fragments(selection, ctx)
+
+      if node.present? && node.selections.present?
+        singular = table_name.singularize.to_sym
+        plural   = table_name.pluralize.to_sym
+
+        # make sure that the next model is an ActiveRecord model
+        next_model = singular.to_s.classify.safe_constantize
+
+        if next_model.blank? || !(next_model < ActiveRecord::Base)
+          next_model = model
+        end
+
+        nested = map_includes(next_model, node.selections, ctx)
+
+        final_type =  if model.reflections[singular].present?
+                        # this is for has_one relationships
+                        singular
+
+                      elsif model.reflections[plural].present?
+                        # this is for has_many relationships
+                        plural
+
+                      else
+                        # this is for non-AR models (i.e. Product)
+                        # so they use the correct parent
+                        # TODO Try to get possible_types and include those
+                        nil
+                      end
+
+        if nested.present?
+          if final_type
+            # flatten is used for cases like Interfaces
+            # i.e. Customer -> Product -> Loan
+            # Product isn't an AR type
+            { final_type => nested.flatten }
+          else
+            nested.compact
+          end
+
+        else
+          final_type
+        end
+      else
+        nil
+      end
+    end.compact
+  end
+
+  ##
+  # method to handle fragments in GQL Query
+  # works by finding the fragment reference in the context
+  #
+  # @param node [GraphQL::Language::Nodes::*] current node
+  # @param ctx [GraphQL::Context] GQL Context used to map fragment to node
+  #
+  # @return [String, GraphQL::Language::Nodes::*] tuple of node name and node
+  def handle_fragments(node, ctx)
+    if node.class == GraphQL::Language::Nodes::FragmentSpread
+      fragment = ctx.query.fragments[node.name]
+      [fragment.type.underscore, fragment]
+    elsif node.class == GraphQL::Language::Nodes::InlineFragment
+      ##
+      # avoid auto-including things in InlineFragments
+      # If using an interface, not all fields are guaranteed to
+      # exist in all of the implementing types, but at this point,
+      # we can't tell if it will, because we don't know what type
+      # we are dealing with.
+      ##
+      [nil, nil]
+    else
+      [node.name, node]
+    end
+  end
+end

data/lib/graphql/active_record/version.rb

@@ -0,0 +1,5 @@
+module Graphql
+  module ActiveRecord
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: graphql-active_record
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brett Jurgens
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rails/activerecord
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  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'
+description: 
+email:
+- brett@brettjurgens.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql-active-record.gemspec
+- lib/graphql/active_record.rb
+- lib/graphql/active_record/version.rb
+homepage: http://github.com/brettjurgens/graphql-active-record
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Active Record Helpers for graphql-ruby
+test_files: []