graphql-preview 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9fc8eeb565f36949ee6ce15c4609e1c2ee5efd65
+  data.tar.gz: da5d69a6fe681251fab40176c5f6073f18ec3954
+SHA512:
+  metadata.gz: 3fb8a0333e507048dfddb56e6a4b3c7798f5ea762a02975f7882c4546e0445e70fc6b753cf0875b16af08c63cadeb640c68164c3f5168724c1d548eeff9375ca
+  data.tar.gz: f84fdaa16c52c932d4731b5e57a55a0e6a57995d19c1edf3c186b07560174b8ef1b0c06cd731c17b88449701dce8ba49318b5dd9b0e9db403114bd9413f30bfb

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_gem:
+  rubocop-github:
+    - config/default.yml
+    - config/rails.yml
+
+Style/FileName:
+  Enabled: false

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,96 @@
+# GraphQLPreview
+
+Easily toggle parts of a GraphQL schema on.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-preview'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphql-preview
+
+## Usage
+
+The basic premise of this gem is to provide an easier interface to toggling parts of a GraphQL schema. You define a single class that contains all the definitions for how your toggler should behave, and this gem will handle the flipping for you.
+
+The easiest use case to imagine for this gem is to think of something like a public API preview. Perhaps you want to be able to expose certain objects or fields if and only if a client provides a specific `Accept` header. This gem will help you do that!
+
+### Class definition
+
+To get started, define a class that inherits from `GraphQLPreview::SchemaModification`. This class can be given various properties, but the two most important are `toggled_by` and `toggled_on`:
+
+``` ruby
+class TestPreview < GraphQLPreview::SchemaModification
+  # A human-readable name of your preview
+  title "TestPreview"
+  # A description of your preview
+  description "Enable various library items"
+
+  # A symbol that uniquely identifies this preview -- explained below
+  toggled_by :enabled_library
+
+  # A date defining when this preview was announced, with an optional URL announcing it
+  announced_on Date.new(2017, 11, 1), url: "http://example.com"
+
+  # A date defining when this preview was updated, with an optional URL announcing it
+  updated_on Date.new(2017, 11, 2), url: "http://example.com"
+  # You can have more than one of these!
+  updated_on Date.new(2017, 11, 3), url: "http://example.com"
+
+  # The parts of your GraphQL schema you want toggled by this preview
+  toggled_on [
+    Library::Author, # an object
+    Library::ExtraInfo, # an interface,
+    Library::Author.fields["socialSecurityNumber"], # a field
+    Library::Book.fields["author"].arguments["includeMiddleInitial"], # an argument
+    Library::Likeable, # a union,
+    Library::Cover, # an enum
+    Library::Cover.values["DIGITAL"], # an enum value
+    Library::BookOrder, # an input object
+    Library::AddLike, # a mutation
+  ]
+end
+```
+
+### Toggling the preview on your schema
+
+This gem introduces a new method to apply on your schema, `enabled_previews`. It takes an array,
+and you should pass in the list of preview classes you want enabled on your schema. For example:
+
+``` ruby
+GraphQL::Schema.define do
+  query(query_type)
+  enabled_previews [
+    TestPreview
+  ]
+end
+```
+
+### Passing information to `Schema.execute`
+
+After your preview class is configured, you'll need to make two minor changes to the way the schema is executed.
+
+First, ensure that your `context` object has a key called `schema_previews`. Within this key, you'll provide an array of symbols that identify which previews you want enabled. For example:
+
+``` ruby
+context = { schema_previews: [:enabled_library] }
+```
+
+Next, simply pass in the `GraphQLPreview::Mask` class to the `except` kwarg.
+
+Putting it all together, this looks like:
+
+``` ruby
+Schema.execute(query, context: context, except: GraphQLPreview::Mask)
+```
+
+It's up to you to decide how to determine the array in `context[:schema_previews]`. It could be based on the `Accept` header, some random `Flipper` percentage, or anything else!

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/preview"
+
+# 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-preview.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "graphql-preview/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphql-preview"
+  spec.version       = GraphQLPreview::VERSION
+  spec.authors       = ["Garen J. Torikian", "Christian Joudrey"]
+  spec.email         = ["gjtorikian@gmail.com", "cmallette@gmail.com"]
+
+  spec.summary       = "Provide a system for toggling parts of a GraphQL schema on."
+  spec.homepage      = "https://github.com/github/graphql-preview"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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 "graphql", "~> 1.7"
+
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry", "~> 0.10.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rubocop-github"
+end

data/lib/graphql-preview/extensions/enabled_previews.rb

@@ -0,0 +1,23 @@
+module GraphQLPreview
+  module Extensions
+    module EnabledPreviews
+      def enabled_previews
+        @enabled_previews
+      end
+
+      def enabled_previews=(previews)
+        unless previews.is_a?(Array)
+          raise ArgumentError, "Expected `enabled_previews` to be an array, but it was `#{previews.class}`"
+        end
+
+        previews.each do |preview|
+          unless preview.ancestors.any? { |ancestor| ancestor == GraphQLPreview::SchemaModification }
+            raise ArgumentError, "One of your `enabled_previews` items does not descend from `GraphQLPreview::SchemaModification`"
+          end
+        end
+
+        @enabled_previews = previews
+      end
+    end
+  end
+end

data/lib/graphql-preview/mask.rb

@@ -0,0 +1,13 @@
+module GraphQLPreview
+  class Mask
+    def self.call(member, context)
+      unless context.key?(:schema_previews)
+        raise ArgumentError, "You are using the `GraphQLPreview::Mask`, but key `:schema_previews` was not provided to the `context`"
+      end
+      return false if Library::Schema.enabled_previews.nil?
+      return false unless member.metadata.key?(:preview_toggled_by)
+
+      !context[:schema_previews].include?(member.metadata[:preview_toggled_by].toggled_by)
+    end
+  end
+end

data/lib/graphql-preview/schema_modification.rb

@@ -0,0 +1,97 @@
+module GraphQLPreview
+  class SchemaModification
+    def self.masks
+      ObjectSpace.each_object(Class).select { |klass| klass < self }
+    end
+
+    def self.to_h
+      {
+        title: title,
+        description: description,
+        toggled_by: toggled_by,
+        announcement: announcement,
+        updates: updates,
+        toggled_on: toggled_on
+      }
+    end
+
+    def self.title(new_title = nil)
+      if new_title
+        @title = new_title
+      else
+        @title
+      end
+    end
+
+    def self.description(new_description = nil)
+      if new_description
+        @description = new_description
+      else
+        @description
+      end
+    end
+
+    def self.toggled_by(new_toggled_by = nil)
+      if new_toggled_by
+        @toggled_by = new_toggled_by
+      else
+        @toggled_by
+      end
+    end
+
+    def self.announced_on(date, url: nil)
+      @announcement = {
+        date: date,
+        url: url
+      }
+    end
+
+    def self.announcement
+      @announcement
+    end
+
+    def self.updated_on(date, url: nil)
+      @updates ||= []
+
+      @updates <<  {
+        date: date,
+        url: url
+      }
+    end
+
+    def self.updates
+      @updates
+    end
+
+    def self.toggled_on(types = nil)
+      if types
+        types.each do |type|
+          unless type.respond_to?(:metadata)
+            raise MethodError, "`#{type}` cannot have its metadata set"
+          end
+
+          if type.metadata.key?(:preview_toggled_by)
+            raise ArgumentError, "Couldn't add `#{self.toggled_by}` to `#{type.name}`: it's already toggled with `#{type.metadata[:preview_toggled_by].toggled_by}`"
+          end
+
+          type.metadata[:preview_toggled_by] = self
+
+          if type.is_a?(GraphQL::InterfaceType)
+            mark_children(type)
+          end
+        end
+        @toggled_on = types
+      else
+        @toggled_on
+      end
+    end
+
+    private
+
+    def self.mark_children(type)
+      type.fields.each_value do |field|
+        field.metadata[:preview_toggled_by] = self
+      end
+    end
+  end
+end

data/lib/graphql-preview/version.rb

@@ -0,0 +1,3 @@
+module GraphQLPreview
+  VERSION = "0.0.1"
+end

data/lib/graphql-preview.rb

@@ -0,0 +1,18 @@
+require "graphql"
+require "graphql-preview/version"
+require "graphql-preview/schema_modification"
+require "graphql-preview/mask"
+require "graphql-preview/extensions/enabled_previews"
+
+module GraphQLPreview
+
+end
+
+module GraphQL
+  Schema.class_eval do
+    include GraphQLPreview::Extensions::EnabledPreviews
+
+    accepts_definitions \
+      enabled_previews: GraphQLPreview::Extensions::EnabledPreviews
+  end
+end

data/script/single_test

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+set -e
+export CC=gcc
+
+ruby -I"lib:test" test/graphql-preview/$1

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: graphql-preview
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Garen J. Torikian
+- Christian Joudrey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.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: rubocop-github
+  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:
+- gjtorikian@gmail.com
+- cmallette@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql-preview.gemspec
+- lib/graphql-preview.rb
+- lib/graphql-preview/extensions/enabled_previews.rb
+- lib/graphql-preview/mask.rb
+- lib/graphql-preview/schema_modification.rb
+- lib/graphql-preview/version.rb
+- script/single_test
+homepage: https://github.com/github/graphql-preview
+licenses: []
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Provide a system for toggling parts of a GraphQL schema on.
+test_files: []