altair-rails 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 073d47c7db152d67e61edaa10a53289026a6816ef6da55036223239f2516fa7e
+  data.tar.gz: b93b8ad0b079abfaae4807e2c9ab331c103a8bd0ee35a17d8dcf4afe70c680fb
+SHA512:
+  metadata.gz: dfa4259a2aaf0e57a72e0d88d9726ab5c2608b35c79e96a5a6c96de8ae08e081dadef221a9e314abc12c0bee5f8003a53efb07198528faa0cac77f8bca4e3f01
+  data.tar.gz: bf0bda9c47faf2d8d097c28240db179e62470ba3418ffff1077a17b5db0a00d2ca84f16cad53ff1da2504f9b0892e153d7d33335aa4e799bcecab7a1d937bc62

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Jeremy Jackson
+
+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,60 @@
+# Altair Rails - The Altair GraphQL Client for Rails
+
+[![Gem Version](https://badge.fury.io/rb/altair-rails.svg)](https://badge.fury.io/rb/altair-rails)
+[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
+[![Maintainability](https://api.codeclimate.com/v1/badges/22128c5c828a8eed6f95/maintainability)](https://codeclimate.com/github/jejacks0n/altair-rails/maintainability)
+
+Altair Rails is a Rails engine that provides a mountable endpoint for the [Altair GraphQL Client](https://altairgraphql.dev/).
+
+## Download and Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem "altair-rails"
+```
+
+Or install the latest version with RubyGems:
+
+```bash
+gem install altair-rails
+```
+
+Source code can be downloaded as part of the project on GitHub:
+
+* https://github.com/jejacks0n/altair-rails
+
+## Configuration
+
+By default the Altair GraphQL Client is mounted at `/altair`. It can be configured by adding an initializer to your Rails application:
+
+```ruby 
+Altair::Rails.configure do |config|
+  # Where you want to mount the engine in your application. If set to nil,
+  # the engine will not be mounted automatically and it will need to be
+  # mounted manually. E.g.: in your routes.rb file, adding:
+  #   mount Altair::Rails::Engine => "/altair"`
+  config.mount_at = "/altair"
+
+  # The path to your GraphQL endpoint. This is used to set the endpointURL.
+  config.graphql_path = "/graphql"
+
+  # The path to your ActionCable endpoint. This is used to set the
+  # subscriptionsEndpoint.
+  config.action_cable_path = "/cable"
+
+  # Any options you want to pass to AltairGraphQL.init(). For more details:
+  # https://github.com/altair-graphql/altair/blob/f433ee1bf6c52c8639b6448fa7e0c31c6ad955d1/packages/altair-core/src/config.ts
+  config.altair_options = {}
+end
+```
+
+## License
+
+Active Experiment is released under the MIT license:
+
+* https://opensource.org/licenses/MIT
+
+Copyright 2023 [jejacks0n](https://github.com/jejacks0n)
+
+## Make Code Not War

data/lib/altair/rails/configuration.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Altair
+  module Rails
+    class Configuration
+      include Singleton
+
+      cattr_accessor(*[:mount_at, :graphql_path, :action_cable_path, :altair_options, :altair_version])
+
+      # Where you want to mount the engine in your application. If set to nil,
+      # the engine will not be mounted automatically and it will need to be
+      # mounted manually. E.g.: in your routes.rb file, adding:
+      #   mount Altair::Rails::Engine => "/altair"`
+      #
+      # Defaults to "/altair".
+      @@mount_at = "/altair"
+
+      # The path to your GraphQL endpoint. This is used to set the endpointURL.
+      @@graphql_path = "/graphql"
+
+      # The path to your ActionCable endpoint. This is used to set the
+      # subscriptionsEndpoint.
+      @@action_cable_path = "/cable"
+
+      # Any options you want to pass to AltairGraphQL.init(). For more details:
+      # https://github.com/altair-graphql/altair/blob/f433ee1bf6c52c8639b6448fa7e0c31c6ad955d1/packages/altair-core/src/config.ts
+      @@altair_options = {}
+
+      # Generally this should be left to the release version of altair-rails,
+      # but if you really want, you can override it here.
+      @@altair_version = "5.0.28" # Altair::Rails.version
+    end
+
+    mattr_accessor :configuration
+    @@configuration = Configuration
+
+    def self.configure
+      yield @@configuration
+    end
+
+    singleton_class.send(:alias_method, :setup, :configure)
+  end
+end

data/lib/altair/rails/engine.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Altair
+  module Rails
+    class Engine < ::Rails::Engine
+      isolate_namespace Altair::Rails
+
+      altair_rails = Altair::Rails.configuration
+
+      if altair_rails.mount_at.present?
+        config.after_initialize do |app|
+          app.routes.prepend { mount Altair::Rails::Engine => altair_rails.mount_at }
+        end
+      end
+
+      routes do
+        root to: ->(_) { [200, {}, <<~HTML_BODY] }
+          <!DOCTYPE html>
+          <html>
+          <head>
+            <meta charset="utf-8" />
+            <title>Altair</title>
+            <base href="https://cdn.jsdelivr.net/npm/altair-static@#{altair_rails.altair_version}/build/dist/">
+            <meta name="viewport" content="width=device-width,initial-scale=1" />
+            <link href="styles.css" rel="stylesheet" />
+            <style>.loading-screen { display: none }</style>
+          </head>
+          <body>
+          <script>
+            // window.__ALTAIR_WEB_APP__ = 1;
+            const defaultOptions = {
+              endpointURL: window.location.origin + "#{altair_rails.graphql_path}",
+              subscriptionsEndpoint: "ws://" + window.location.host + "#{altair_rails.action_cable_path}",
+              initialSubscriptionsProvider: "action-cable"
+            };
+            document.addEventListener('DOMContentLoaded', function() {
+              AltairGraphQL.init(Object.assign({}, defaultOptions, #{altair_rails.altair_options.to_json})); 
+            });
+          </script>          
+          <app-root>
+            <div class="loading-screen styled">
+              <div class="loading-screen-inner">
+                <div class="loading-screen-logo-container">
+                  <img src="assets/img/logo_350.svg" alt="Altair" />
+                </div>
+                <div class="loading-screen-loading-indicator">
+                  <span class="loading-indicator-dot"></span>
+                  <span class="loading-indicator-dot"></span>
+                  <span class="loading-indicator-dot"></span>
+                </div>
+              </div>
+            </div>
+          </app-root>
+          <script rel="preload" as="script" type="text/javascript" src="runtime.js"></script>
+          <script rel="preload" as="script" type="text/javascript" src="polyfills.js" ></script>
+          <script rel="preload" as="script" type="text/javascript" src="main.js" ></script>
+          </body>
+          </html>
+        HTML_BODY
+      end
+    end
+  end
+end

data/lib/altair/rails/version.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Altair
+  module Rails
+    # Returns the currently loaded version of Active Experiment as a
+    # +Gem::Version+.
+    def self.version
+      Gem::Version.new(VERSION::STRING)
+    end
+
+    module VERSION
+      MAJOR = 0
+      MINOR = 0
+      TINY  = 2
+      PRE   = nil
+
+      STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+    end
+  end
+end

data/lib/altair/rails.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "altair/rails/version"
+require "altair/rails/configuration"
+require "altair/rails/engine"

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: altair-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jeremy Jackson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  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'
+description: A static version of the Altair GraphQL Client, for Rails and ActionCable
+  subscriptions.
+email: jejacks0n@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- lib/altair/rails.rb
+- lib/altair/rails/configuration.rb
+- lib/altair/rails/engine.rb
+- lib/altair/rails/version.rb
+homepage: https://github.com/jejacks0n/altair-rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jejacks0n/altair-rails
+  source_code_uri: https://github.com/jejacks0n/altair-rails
+  bug_tracker_uri: https://github.com/jejacks0n/altair-rails/issues
+  changelog_uri: https://github.com/jejacks0n/altair-rails/CHANGELOG.md
+  documentation_uri: https://github.com/jejacks0n/altair-rails/README.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.14
+signing_key:
+specification_version: 4
+summary: Altair GraphQL Client for Rails.
+test_files: []