grate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 28c2c1bea030e41a2d31403b2b04ba9de140eb6f52c030ffa022beef9d9c50ce
+  data.tar.gz: 222cffb32ece9b10dd0af67cc276ac164b5fb1d5e819cb936efbe6ddfe80e52e
+SHA512:
+  metadata.gz: 6b93863c3f53e5c352d112fe85094346ee6e57cdd21f5458d15939c48f3703782dfa2d19f048a8088eae20fba2a8fbc911627425bb9ff7a26878b7a1055b8df9
+  data.tar.gz: 38745cd507af1160354a3c0a7b4c8ccdbfea6656f07a1a6a2561c754e8e4e794e399363f77977f48c6b032b4a1b60ffbf3072e508fd8d1e689562545f01256c0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.env
+*.gem
+\.#*

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

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 ny585@nyu.edu. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in grate.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Nicholas Yang
+
+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,50 @@
+# Grate
+
+Grate is a GraphQL framework inspired by Rails. Grate aims to make
+writing GraphQL APIs as simple and consistent as possible. Therefore,
+Grate applies the principles of least surprise and developer happiness.
+
+But enough buzzwords, what does Grate actually do? Grate uses
+Ruby's metaprogramming features to add a domain specific language that
+allows you to automatically make queries on certain types.
+
+For instance, if you have an Article type, you can write `queryable_on
+:title, String` and Grate will automatically create an
+`ArticleByTitle` query for you!
+
+## Installation
+
+You can install grate using the following:
+
+    $ gem install grate
+	
+To generate a new project, make a directory, then run
+
+    $ grate new NAME
+	
+All the necessary files will be generated.
+
+## Development
+
+Grate is build using Rack, so all you have to do to run your Grate application is run 
+
+    $ rackup
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/nicholaslyang/grate. 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 Grate project’s codebases, issue
+trackers, chat rooms and mailing lists is expected to follow the [code
+of
+conduct](https://github.com/nicholaslyang/grate/blob/master/CODE_OF_CONDUCT.md).

data/ROADMAP.md

@@ -0,0 +1,7 @@
+# Roadmap
+
+- Convert to Ruby gem
+- Add generators for new model, type or controller
+- Add CLI helpers (`grate queries`)
+- Add mutation helpers
+- Add auth helpers

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/grate

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/grate'
+Grate::CLI.start(ARGV)

data/grate.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "grate/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "grate"
+  spec.version       = Grate::VERSION
+  spec.authors       = ["Nicholas Yang"]
+  spec.email         = ["ny585@nyu.edu"]
+
+  spec.summary       = %q{A compact but effective GraphQL framework}
+  spec.description   = %q{Grate is a framework that allows you to use a declarative, compact DSL to design GraphQL APIs quickly and effectively}
+  spec.homepage      = "https://grate.github.io"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"  
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'thor', '~> 0.20.0'
+  spec.add_dependency 'graphql', '~> 1.8', '>= 1.8.10'
+  spec.add_dependency 'sequel', '~> 5.12', '>= 5.12.0'
+  spec.add_dependency 'pg', '~> 1.1', '>= 1.1.3'
+  spec.add_dependency 'dotenv', '~> 2.5', '>= 2.5.0'
+  spec.add_dependency 'activesupport', '~> 5.2', '>= 5.2.1'
+
+end

data/lib/grate/cli.rb

@@ -0,0 +1,8 @@
+require 'thor'
+require_relative './new_project'
+module Grate
+  class CLI < Thor
+    register(Grate::NewProject, 'new', 'new NAME', 'Creates a new project')
+  end
+end
+  

data/lib/grate/graphql_object.rb

@@ -0,0 +1,48 @@
+require 'graphql'
+class GraphQL::Schema::Object
+  include GraphQL::Schema::Member::GraphQLTypeNames
+
+  def self.camelize(name)
+    name.split('_').collect(&:capitalize).join
+  end
+  def self.is_valid_type_name
+    self.to_s.chars.last(4).join == 'Type'
+  end
+
+  def self.get_controller(model_name)
+    controller_name = "#{model_name.pluralize}Controller"
+    Object.const_get(controller_name)
+  end
+  
+  def self.queryable_on(field_name, field_type)
+    raise NameError,
+          "#{self} is invalid type name. Types must end in -Type" unless is_valid_type_name
+
+    # Gets all the various model, type and controller names.
+    model = self.to_s.chomp('Type')
+    type_name = self
+    model_name = model.downcase
+    controller = get_controller(model)
+    
+    if field_name == :id
+      query_name = function_name = model_name
+      return_type = type_name
+    else
+      query_name = "#{model_name}By#{camelize(field_name.to_s)}"
+      function_name = "#{model_name}_by_#{field_name}"
+      return_type = [type_name]
+    end
+    
+    QueryType.class_eval do
+      field query_name,
+            return_type,
+            null: true do
+        description "Query #{model} by #{field_name}"
+        argument field_name, field_type, required: true
+      end
+      define_method function_name do |query_args|
+        controller.find_by(query_args[field_name], field_name)
+      end
+    end
+  end
+end

data/lib/grate/new_project.rb

@@ -0,0 +1,38 @@
+require 'find'
+module Grate
+  class NewProject < Thor::Group
+    include Thor::Actions
+
+    argument :name
+
+    def self.source_root
+      File.dirname(__FILE__)
+    end
+
+
+    def create_directory
+      Dir.mkdir name
+    end
+    
+    def create_files
+      templates_dir = File.join(__dir__, "..", "..", 'templates')
+      Find.find(templates_dir) do |file|
+        case File.extname(file)
+        when ".tt"
+          template(file, File.join(Dir.pwd, name, to_relative(file).gsub(".tt", "")))
+        when ".dot"
+          template(file, File.join(Dir.pwd, name, ".#{to_relative(file).chomp(".dot")}"))
+        when /\.[A-Za-z]+/
+          template(file, File.join(Dir.pwd, name, to_relative(file)))
+        end
+      end
+    end
+
+    private 
+    def to_relative(path)
+      path.gsub(/.*templates\//, "")
+    end
+
+  end
+end
+

data/lib/grate/version.rb

@@ -0,0 +1,3 @@
+module Grate
+  VERSION = "0.1.0"
+end

data/lib/grate.rb

@@ -0,0 +1,7 @@
+require "grate/version"
+require "grate/cli"
+require "grate/graphql_object"
+
+module Grate
+  # Your code goes here...
+end

data/templates/app/controllers/application_controller.rb.tt

@@ -0,0 +1,2 @@
+class ApplicationController
+end

data/templates/app/models/application_model.rb.tt

@@ -0,0 +1,3 @@
+ApplicationModel = Class.new(Sequel::Model)
+class ApplicationModel
+end

data/templates/app/schema.rb.tt

@@ -0,0 +1,3 @@
+class Schema < GraphQL::Schema
+  query QueryType
+end

data/templates/app/types/query_type.rb.tt

@@ -0,0 +1,8 @@
+class QueryType < GraphQL::Schema::Object
+  description "The query root of this schema"
+  field :test_field, String, null: false,
+      description: "An example field added by the generator"
+  def test_field
+    "Hello World!"
+  end
+end

data/templates/config/database.yml.tt

@@ -0,0 +1,5 @@
+development:
+  database: <%= "#{name}_database" %>
+  username: nicholas
+  host: localhost
+  password:

data/templates/config.ru.tt

@@ -0,0 +1,29 @@
+require 'dotenv/load'
+require 'json'
+require 'sequel'
+require 'graphql'
+require 'grate'
+
+# Ideally should move off this, but it's so damn useful
+require 'active_support/inflector'
+
+# Load the database first
+require_relative './db/database'
+
+# Then load all the abstract
+require_relative './app/types/query_type'
+require_relative './app/models/application_model'
+require_relative './app/controllers/application_controller.rb'
+require_relative './app/schema'
+
+
+class <%= name.capitalize %>Application
+  def call(env)
+    req = Rack::Request.new(env)
+    params = JSON.parse(req.body.read)
+    res = Schema.execute(params["query"])
+    ['200', {'Content-Type' => 'text/html'}, [res.to_json]]
+  end
+end
+
+run <%= name.capitalize %>Application.new

data/templates/db/database.rb.tt

@@ -0,0 +1,10 @@
+require 'sequel'
+require 'pg'
+require 'yaml'
+require 'erb'
+
+config_template = ERB.new(File.read('config/database.yml'))
+database_config = YAML.load(config_template.result)
+config = database_config[ENV["ENVIRONMENT"]]
+
+Sequel.connect("postgres://#{config[:username]}:#{config[:password]}@#{config[:host]}/#{config[:database]}")

data/templates/db/seed.rb.tt

@@ -0,0 +1,5 @@
+require "dotenv/load"
+require_relative "database"
+require_relative "../app/models/post"
+
+Post.create(title: "My Article", content: "blah blah blah")

data/templates/env.dot

@@ -0,0 +1,3 @@
+# Add any environment specific information here. Do NOT commit to
+# source control
+ENVIRONMENT=development

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: grate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicholas Yang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-26 00:00:00.000000000 Z
+dependencies:
+- !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: 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: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.10
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.12.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+description: Grate is a framework that allows you to use a declarative, compact DSL
+  to design GraphQL APIs quickly and effectively
+email:
+- ny585@nyu.edu
+executables:
+- grate
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- ROADMAP.md
+- Rakefile
+- bin/grate
+- grate.gemspec
+- lib/grate.rb
+- lib/grate/cli.rb
+- lib/grate/graphql_object.rb
+- lib/grate/new_project.rb
+- lib/grate/version.rb
+- templates/app/controllers/application_controller.rb.tt
+- templates/app/models/application_model.rb.tt
+- templates/app/schema.rb.tt
+- templates/app/types/query_type.rb.tt
+- templates/config.ru.tt
+- templates/config/database.yml.tt
+- templates/db/database.rb.tt
+- templates/db/development.db
+- templates/db/seed.rb.tt
+- templates/env.dot
+- templates/gitignore.dot
+homepage: https://grate.github.io
+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.7.3
+signing_key: 
+specification_version: 4
+summary: A compact but effective GraphQL framework
+test_files: []