RubyGems - graphiql-rails - Versions diffs - 1.0.0 - Mend

graphiql-rails 1.0.0

Files changed (67) hide show

data/app/controllers/graphiql/rails/editors_controller.rb ADDED Viewed

@@ -0,0 +1,13 @@
+module GraphiQL
+  module Rails
+    class EditorsController < ActionController::Base
+      def show
+      end
+      helper_method :graphql_endpoint_path
+      def graphql_endpoint_path
+        params[:graphql_path] || raise(%|You must include `graphql_path: "/my/endpoint"` when mounting GraphiQL::Rails::Engine|)
+      end
+    end
+  end
+end

data/app/views/graphiql/rails/editors/show.html.erb ADDED Viewed

@@ -0,0 +1,82 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>GraphiQL</title>
+    <%= stylesheet_link_tag("graphiql/rails/application") %>
+    <%= javascript_include_tag("graphiql/rails/application") %>
+  </head>
+  <body>
+    Loading...
+    <script>
+    var parameters = {
+      query: "<%= GraphiQL::Rails.config.initial_query.gsub(/\n/, "\\n") %>"
+    };
+    <% if GraphiQL::Rails.config.query_params %>
+    // Parse the search string to get url parameters.
+    var search = window.location.search;
+    search.substr(1).split('&').forEach(function (entry) {
+     var eq = entry.indexOf('=');
+     if (eq >= 0) {
+       parameters[decodeURIComponent(entry.slice(0, eq))] =
+         decodeURIComponent(entry.slice(eq + 1));
+     }
+    });
+    // if variables was provided, try to format it.
+    if (parameters.variables) {
+     try {
+       parameters.variables =
+         JSON.stringify(JSON.parse(parameters.variables), null, 2);
+     } catch (e) {
+       // Do nothing, we want to display the invalid JSON as a string, rather
+       // than present an error.
+     }
+    }
+    // When the query and variables string is edited, update the URL bar so
+    // that it can be easily shared
+    function onEditQuery(newQuery) {
+     parameters.query = newQuery;
+     updateURL();
+    }
+    function onEditVariables(newVariables) {
+     parameters.variables = newVariables;
+     updateURL();
+    }
+    function updateURL() {
+     var newSearch = '?' + Object.keys(parameters).map(function (key) {
+       return encodeURIComponent(key) + '=' +
+         encodeURIComponent(parameters[key]);
+     }).join('&');
+     history.replaceState(null, null, newSearch);
+    }
+    <% end %>
+    // Defines a GraphQL fetcher using the fetch API.
+    var graphQLEndpoint = "<%= graphql_endpoint_path %>";
+    function graphQLFetcher(graphQLParams) {
+      return fetch(graphQLEndpoint, {
+        method: 'post',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify(graphQLParams),
+        credentials: 'include',
+      }).then(function (response) {
+        return response.json()
+      });
+    }
+    // Render <GraphiQL /> into the body.
+    ReactDOM.render(
+      React.createElement(GraphiQL, {
+        fetcher: graphQLFetcher,
+        query: parameters.query,
+        <% if GraphiQL::Rails.config.query_params %>
+        variables: parameters.variables,
+        onEditQuery: onEditQuery,
+        onEditVariables: onEditVariables
+        <% end %>
+      }),
+      document.body
+    );
+    </script>
+  </body>
+</html>

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,3 @@
+GraphiQL::Rails::Engine.routes.draw do
+  get "/" => "editors#show"
+end

data/lib/graphiql/rails/engine.rb ADDED Viewed

@@ -0,0 +1,7 @@
+module GraphiQL
+  module Rails
+    class Engine < ::Rails::Engine
+      isolate_namespace GraphiQL::Rails
+    end
+  end
+end

data/lib/graphiql/rails/version.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module GraphiQL
+  module Rails
+    VERSION = "1.0.0"
+  end
+end

data/lib/graphiql/rails/welcome_message.rb ADDED Viewed

@@ -0,0 +1,19 @@
+module GraphiQL
+  module Rails
+    WELCOME_MESSAGE = %|
+# Welcome to GraphiQL
+#
+# GraphiQL is an in-browser IDE for writing, validating, and
+# testing GraphQL queries.
+#
+# Type queries into this side of the screen, and you will
+# see intelligent typeaheads aware of the current GraphQL type schema and
+# live syntax and validation errors highlighted within the text.
+#
+# To bring up the auto-complete at any point, just press Ctrl-Space.
+#
+# Press the run button above, or Cmd-Enter to execute the query, and the result
+# will appear in the pane to the right.
+|
+  end
+end

data/lib/graphiql/rails.rb ADDED Viewed

@@ -0,0 +1,23 @@
+require "rails"
+ActiveSupport::Inflector.inflections(:en) do |inflect|
+  inflect.acronym("GraphiQL")
+end
+require "graphiql/rails/engine"
+require "graphiql/rails/version"
+require "graphiql/rails/welcome_message"
+module GraphiQL
+  module Rails
+    class << self
+      attr_accessor :config
+    end
+    self.config = OpenStruct.new({
+      query_params: false,
+      initial_query: GraphiQL::Rails::WELCOME_MESSAGE
+    })
+  end
+end

data/readme.md ADDED Viewed

@@ -0,0 +1,42 @@
+# GraphiQL-Rails [![Gem Version](https://badge.fury.io/rb/graphiql-rails.svg)](https://badge.fury.io/rb/graphiql-rails) [![Build Status](https://travis-ci.org/rmosolgo/graphiql-rails.svg)](https://travis-ci.org/rmosolgo/graphiql-rails)
+Mount the [GraphiQL IDE](https://github.com/graphql/graphiql) in Ruby on Rails.
+![image](https://cloud.githubusercontent.com/assets/2231765/12101544/4779ed54-b303-11e5-918e-9f3d3e283170.png)
+## Installation
+Add to your Gemfile:
+```ruby
+gem "graphiql-rails"
+```
+## Usage
+### Mount the Engine
+Add the engine to `routes.rb`:
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  # ...
+  if Rails.env.development?
+    mount GraphiQL::Rails::Engine, at: "/graphiql", graphql_path: "/your/endpoint"
+  end
+end
+```
+- `at:` is the path where GraphiQL will be served. You can access GraphiQL by visiting that path in your app.
+- `graphql_path:` is the path to the GraphQL endpoint. GraphiQL will send queries to this path.
+### Configuration
+You can override `GraphiQL::Rails` configs in an initializer (eg, `config/initializers/graphiql.rb`). The configs are:
+```ruby
+# These are the default values:
+GraphiQL::Rails.config.query_params = false # if true, the GraphQL query string will be persisted the page's query params.
+GraphiQL::Rails.config.initial_query = GraphiQL::Rails::WELCOME_MESSAGE # This string is presented to a new user
+```

data/test/controllers/editors_controller_test.rb ADDED Viewed

@@ -0,0 +1,45 @@
+require "test_helper"
+puts GraphiQL::Rails.constants
+module GraphiQL
+  module Rails
+    class EditorsControllerTest < ActionController::TestCase
+      setup do
+        @routes = GraphiQL::Rails::Engine.routes
+      end
+      teardown do
+        GraphiQL::Rails.config.query_params = false
+        GraphiQL::Rails.config.initial_query = GraphiQL::Rails::WELCOME_MESSAGE
+      end
+      test "renders GraphiQL" do
+        get :show, graphql_path: "/my/endpoint"
+        assert_response(:success)
+        assert_includes(@response.body, "React.createElement(GraphiQL", "it renders GraphiQL")
+        assert_includes(@response.body, "my/endpoint", "it uses the provided path")
+        assert_match(/application-\w+\.js/, @response.body, "it includes assets")
+      end
+      test "it uses initial_query config" do
+        get :show, graphql_path: "/my/endpoint"
+        assert_includes(@response.body, "Welcome to GraphiQL")
+        GraphiQL::Rails.config.initial_query = "{ customQuery }"
+        get :show, graphql_path: "/my/endpoint"
+        refute_includes(@response.body, "Welcome to GraphiQL")
+        assert_includes(@response.body, "{ customQuery }")
+      end
+      test "it uses query_params config" do
+        get :show, graphql_path: "/my/endpoint"
+        refute_includes(@response.body, "onEditQuery")
+        GraphiQL::Rails.config.query_params = true
+        get :show, graphql_path: "/my/endpoint"
+        assert_includes(@response.body, "onEditQuery")
+      end
+    end
+  end
+end

data/test/dummy/config/application.rb ADDED Viewed

@@ -0,0 +1,15 @@
+require File.expand_path('../boot', __FILE__)
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "sprockets/railtie"
+require "rails/test_unit/railtie"
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+module Dummy
+  class Application < Rails::Application
+  end
+end

data/test/dummy/config/boot.rb ADDED Viewed

@@ -0,0 +1,3 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' # Set up gems listed in the Gemfile.

data/test/dummy/config/environment.rb ADDED Viewed

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb ADDED Viewed

@@ -0,0 +1,41 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+  # Do not eager load code on boot.
+  config.eager_load = false
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/test/dummy/config/environments/production.rb ADDED Viewed

@@ -0,0 +1,79 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like
+  # NGINX, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end

data/test/dummy/config/environments/test.rb ADDED Viewed

@@ -0,0 +1,42 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+  # Configure static file server for tests with Cache-Control for performance.
+  config.serve_static_files   = true
+  config.static_cache_control = 'public, max-age=3600'
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+  # Randomize the order test cases are executed.
+  config.active_support.test_order = :random
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end