autographql 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7e4d990782d44b899b287aeee584ab6834d25ae
-  data.tar.gz: 3a0742a94b32db6e2565a5e0e945c2e0d9e814d2
+  metadata.gz: b3d3b5ac363dd52787ecb2b37909b9d4b54d3220
+  data.tar.gz: b99a0e6d238f0fd26d35e306ca85cbb3cbd88845
 SHA512:
-  metadata.gz: 90a24f0e92c79a7c07362b73fe474d2720ec419b3417fbe3b5457438400374948d961f13fd18baa351fe9a52bd4e7fa6e1e47d5122cfa26a34f6338556f26f28
-  data.tar.gz: e2a5fa39b479f4bd5596555a9ef1ee3f52274053c291ff2f2b871b1a8410cb7a40d46a1ec92cea1b41f27ea3475084866b6aa7f88dfcfa5f84ea5d9e64a65076
+  metadata.gz: 69216651bc19b711674130fc03bdbb245b14a6326c5d9a7f0406e401d842d9deebdfd9f1a83df53d614249a980b09f988f402493b7ed5f6a8f8464625b9f1b32
+  data.tar.gz: 24683a0bb35dc5e79e76feaf15cc50a9e448524984bcc86b95690376864f4cdcf2fc69c88230e470b6d0430cf8b83d5d98cc9af867d787ce523f5fba4293edeb

data/lib/autographql.rb

@@ -1,5 +1,12 @@
-require "autographql/engine"
+require 'active_record'
 
-module Autographql
-  # Your code goes here...
+require_relative 'autographql/autographql'
+
+
+module AutoGraphQL
+  VERSION = '0.0.2'
 end
+
+
+# make api available to all Active Record models
+ActiveRecord::Base.extend AutoGraphQL::ObjectType

data/lib/autographql/autographql.rb

@@ -0,0 +1,49 @@
+require 'set'
+
+require_relative 'object_type'
+
+
+module AutoGraphQL
+  extend self
+
+  @@models = Set.new
+
+
+  # dynamically generate ::QueryType and ::ObjectTypes
+  def const_missing const
+    super unless [ :QueryType, :ObjectTypes ].include? const
+
+    if :ObjectTypes == const
+      return @@models.map(&:graphql)
+    end
+
+    Class.new GraphQL::Schema::Object do
+      def self.name
+        'AutoGraphQL::QueryType'
+      end
+
+      @@models.each do |model|
+        type = model.graphql
+
+        # define field for this type
+        field type.name.downcase, type, null: true do
+          argument :id, GraphQL::Types::ID, required: true
+        end
+
+        # create loader
+        define_method(type.name.downcase) do |id:|
+          model.find id
+        end
+      end
+    end
+  end
+
+
+  ## private
+
+  def register model
+    @@models << model
+  end
+  private_class_method :register
+
+end

data/lib/autographql/object_type.rb

@@ -0,0 +1,70 @@
+require 'graphql'
+require 'set'
+
+
+module AutoGraphQL
+  module ObjectType
+    protected
+
+    def graphql name: self.name, description: '', fields: [], exclude: []
+      columns = Hash[columns_hash.map {|k,v| [k.to_sym, v] }]
+      belongs_to = reflect_on_all_associations(:belongs_to)
+      # has_many = reflect_on_all_associations(:has_many)
+
+      # figure out which active record fields to expose
+      fields = Set.new(
+        (fields.empty? ? columns.keys : fields).map(&:to_sym)
+      )
+
+      # remove blacklisted fields
+      fields -= exclude.map(&:to_sym)
+
+      # remove relationships for now
+      fields -= belongs_to.map(&:association_foreign_key).map(&:to_sym)
+      # exclude += belongs_to.map(&:association_primary_key).map(&:to_sym)
+
+
+      gql_obj = GraphQL::ObjectType.define do
+        name name
+        description description
+
+        fields.each do |f|
+          type = AutoGraphQL::ObjectType.send :convert_type, columns[f].type
+          field f, type
+        end
+      end
+
+      # redefine method to return result
+      define_singleton_method(:graphql) do
+        gql_obj
+      end
+
+      # make publically available
+      singleton_class.send :public, :graphql
+
+      # register new GraphQL::ObjectType
+      AutoGraphQL.send :register, self
+    end
+
+
+    ## private
+
+    def self.convert_type type
+      # convert Active Record type to GraphQL type
+      case type
+      when :boolean
+        GraphQL::BOOLEAN_TYPE
+      when :integer
+        GraphQL::INT_TYPE
+      when :float
+        GraphQL::FLOAT_TYPE
+      when :string
+        GraphQL::STRING_TYPE
+      else
+        raise TypeError.new "unsupported type: #{type}"
+      end
+    end
+    private_class_method :convert_type
+
+  end
+end

data/test/test_auto.rb

@@ -0,0 +1,50 @@
+require 'minitest/autorun'
+require 'active_record'
+
+require_relative '../lib/autographql'
+require_relative 'support/db/seed'
+
+
+class AutoGQLTest < Minitest::Test
+
+  def test_type_registration
+    assert AutoGraphQL::ObjectTypes.include? Person.graphql
+    assert AutoGraphQL::ObjectTypes.include? Pet.graphql
+  end
+
+
+  def test_basic
+    # generate schema
+    schema = Class.new GraphQL::Schema do
+      query AutoGraphQL::QueryType
+    end
+
+    query = "
+    {
+      person(id: 1) { name }
+    }"
+    res = schema.execute(query).values.first
+
+    assert_equal(
+      {
+        'name' => Person.find(1).name,
+      },
+      res['person']
+    )
+
+
+    query = "
+    {
+      pet(id: 1) { name }
+    }"
+    res = schema.execute(query).values.first
+
+    assert_equal(
+      {
+        'name' => Pet.find(1).name,
+      },
+      res['pet']
+    )
+  end
+
+end

data/test/test_basic_graphql.rb

@@ -0,0 +1,76 @@
+require 'minitest/autorun'
+require 'graphql'
+
+require_relative '../lib/autographql'
+require_relative 'support/db/seed'
+
+
+###   Setup   ###
+
+# PetType not defined yet, so must use .define style
+PersonType = GraphQL::ObjectType.define do
+  name 'Person'
+
+  field :id, types.ID
+  field :name, types.String
+  field :pets, types[PetType]
+end
+
+
+class PetType < GraphQL::Schema::Object
+  field :id, ID, null: false
+  field :name, String, null: false
+  field :person, PersonType, null: true
+end
+
+
+class QueryType < GraphQL::Schema::Object
+  # describe the field signature:
+  field :person, PersonType, null: true do
+    argument :id, ID, required: true
+  end
+
+  # then provide an implementation:
+  def person(id:)
+    Person.find(id)
+  end
+end
+
+
+class Schema < GraphQL::Schema
+  query QueryType
+end
+
+
+###   Actual Tests   ###
+class ModelTest < Minitest::Test
+
+  def test_stuff
+    assert_equal('Daniel', Person.first.name)
+    assert_equal(
+      ['Shelby', 'Brownie'],
+      Person.first.pets.pluck(:name)
+    )
+
+    $query = "
+    {
+      person(id: 1) {
+        name
+        pets { name }
+      }
+    }"
+    res = Schema.execute($query).values.first
+
+    assert_equal(
+      {
+        'name' => 'Daniel',
+        'pets' => [
+          { 'name' => 'Shelby' },
+          { 'name' => 'Brownie' },
+        ],
+      },
+      res['person']
+    )
+  end
+
+end

data/test/test_models.rb

@@ -0,0 +1,21 @@
+require 'minitest/autorun'
+
+require_relative '../lib/autographql'
+require_relative 'support/db/seed'
+
+
+class ModelTest < Minitest::Test
+
+  def test_stuff
+    assert_equal(
+      ['Daniel', 'Bjorn'],
+      Person.all.pluck(:name)
+    )
+
+    assert_equal(
+      ['Shelby', 'Brownie'],
+      Person.find_by(name: 'Daniel').pets.pluck(:name)
+    )
+  end
+
+end

metadata

@@ -1,29 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: autographql
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
-- Daniel O'Brien
+- Daniel Pepper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-15 00:00:00.000000000 Z
+date: 2018-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: 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: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !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: 5.0.1
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -38,31 +94,19 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Automagic GraphQL Schema Generation for Rails and ActiveRecord.
-email:
-- dan@dobs.org
+description: Automagically generate GraphQL types and queries
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
-- README.md
-- Rakefile
-- app/assets/config/autographql_manifest.js
-- app/assets/javascripts/autographql/application.js
-- app/assets/stylesheets/autographql/application.css
-- app/controllers/autographql/application_controller.rb
-- app/helpers/autographql/application_helper.rb
-- app/jobs/autographql/application_job.rb
-- app/mailers/autographql/application_mailer.rb
-- app/models/autographql/application_record.rb
-- app/views/layouts/autographql/application.html.erb
-- config/routes.rb
 - lib/autographql.rb
-- lib/autographql/engine.rb
-- lib/autographql/version.rb
-- lib/tasks/autographql_tasks.rake
-homepage: https://github.com/dobs/autographql
+- lib/autographql/autographql.rb
+- lib/autographql/object_type.rb
+- test/test_auto.rb
+- test/test_basic_graphql.rb
+- test/test_models.rb
+homepage: https://github.com/dpep/rb_autographql
 licenses:
 - MIT
 metadata: {}
@@ -82,8 +126,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Automatic GraphQL Schema Generation for Rails and ActiveRecord.
-test_files: []
+summary: AutoGraphQL
+test_files:
+- test/test_auto.rb
+- test/test_basic_graphql.rb
+- test/test_models.rb

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2017 Daniel O'Brien
-
-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

@@ -1,64 +0,0 @@
-# AutoGraphQL
-
-Automatic GraphQL Schema Generation for Rails and ActiveRecord.
-
-This project is currently a very early WIP. See *Roadmap* below for requirements leading up to a usable state.
-
-## Usage
-**WIP; TBD**
-
-## Installation
-**WIP; TBD**
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'autographql'
-```
-
-And then execute:
-```bash
-$ bundle
-```
-
-Or install it yourself as:
-```bash
-$ gem install autographql
-```
-
-## Roadmap
-
-  * v0.1.0 - Initial Release.
-    * Discovery
-      * [ ] Initializer
-      * [ ] Automatic model discovery.
-      * [ ] Default controller.
-      * [ ] Custom endpoint support.
-      * [ ] Custom controller support.
-    * Typing
-      * [ ] Simple model-to-type generation.
-      * [ ] Automatic attribute support.
-      * [ ] Simple relation support.
-      * [ ] Complex relation support.
-      * [ ] Scope support.
-      * [ ] Custom attribute support.
-    * Security
-      * [ ] Cancan(can) support.
-      * [ ] Pundit support.
-      * [ ] Whitelisting support.
-      * [ ] Optional schema hiding.
-    * Performance
-      * [ ] Eager loading based on query analysis.
-    * Miscellaneous
-      * [ ] Schema nesting.
-      * [ ] Support outside of Rails.
-      * [ ] "Eject" support.
-      * [ ] Documentation generation.
-
-## Contributing
-
-Contributions currently accepted in the form of pull requests, gists or issues. This project and its contributors endeavor to follow the [Ruby on Rails Code of Conduct](http://rubyonrails.org/conduct/).
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,37 +0,0 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Autographql'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
-
-
-load 'rails/tasks/statistics.rake'
-
-
-
-require 'bundler/gem_tasks'
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-
-task default: :test

data/app/assets/config/autographql_manifest.js

@@ -1,2 +0,0 @@
-//= link_directory ../javascripts/autographql .js
-//= link_directory ../stylesheets/autographql .css

data/app/assets/javascripts/autographql/application.js

@@ -1,13 +0,0 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file. JavaScript code in this file should be added after the last require_* statement.
-//
-// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-//= require_tree .

data/app/assets/stylesheets/autographql/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/app/controllers/autographql/application_controller.rb

@@ -1,5 +0,0 @@
-module Autographql
-  class ApplicationController < ActionController::Base
-    protect_from_forgery with: :exception
-  end
-end

data/app/helpers/autographql/application_helper.rb

@@ -1,4 +0,0 @@
-module Autographql
-  module ApplicationHelper
-  end
-end

data/app/jobs/autographql/application_job.rb

@@ -1,4 +0,0 @@
-module Autographql
-  class ApplicationJob < ActiveJob::Base
-  end
-end

data/app/mailers/autographql/application_mailer.rb

@@ -1,6 +0,0 @@
-module Autographql
-  class ApplicationMailer < ActionMailer::Base
-    default from: 'from@example.com'
-    layout 'mailer'
-  end
-end

data/app/models/autographql/application_record.rb

@@ -1,5 +0,0 @@
-module Autographql
-  class ApplicationRecord < ActiveRecord::Base
-    self.abstract_class = true
-  end
-end

data/app/views/layouts/autographql/application.html.erb

@@ -1,14 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Autographql</title>
-  <%= stylesheet_link_tag    "autographql/application", media: "all" %>
-  <%= javascript_include_tag "autographql/application" %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>

data/config/routes.rb

@@ -1,2 +0,0 @@
-Autographql::Engine.routes.draw do
-end

data/lib/autographql/engine.rb

@@ -1,5 +0,0 @@
-module Autographql
-  class Engine < ::Rails::Engine
-    isolate_namespace Autographql
-  end
-end

data/lib/autographql/version.rb

@@ -1,3 +0,0 @@
-module Autographql
-  VERSION = '0.0.1'
-end

data/lib/tasks/autographql_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :autographql do
-#   # Task goes here
-# end