graphiti 2.0.0.beta.2 → 2.0.0.beta.4

data/website/static/1.13/template

@@ -0,0 +1,161 @@
+
+Thor::Base.shell = Thor::Shell::Color
+require 'yaml'
+
+def truthy?(statement)
+  val = ask(statement)
+  ['y', 'yes', ''].include?(val)
+end
+
+def eval_template(name)
+  instance_eval(File.read(File.dirname(__FILE__) + "/#{name}.rb"))
+end
+
+def update_config!(attrs)
+  config = File.exists?('.graphiticfg.yml') ? YAML.load_file('.graphiticfg.yml') : {}
+  config.merge!(attrs)
+  File.open('.graphiticfg.yml', 'w') { |f| f.write(config.to_yaml) }
+end
+
+def api_namespace
+  @api_namespace ||= begin
+    ns = prompt \
+      header: "What is your API namespace?",
+      description: "This will be used as a route prefix, e.g. if you want the route '/books_api/v1/authors' your namespace would be '/books_api/v1'",
+      default: '/api/v1'
+    update_config!('namespace' => ns)
+    ns
+  end
+end
+
+def prompt(header: nil, description: nil, default: nil)
+  say(set_color("\n#{header}", :magenta, :bold)) if header
+  say("\n#{description}") if description
+  answer = ask(set_color("\n(default: #{default}):", :magenta, :bold))
+  answer = default if answer.blank? && default != 'nil'
+  say(set_color("\nGot it!\n", :white, :bold))
+  answer
+end
+
+welcome = <<-STR
+\n
+Welcome to the Graphiti generator!
+=======================================
+
+This will take care of some boilerplate for you, like adding gem dependencies and rspec helpers.
+
+If you're worried there might be too much magic here, feel free to run 'git diff' at the end to see what happened. You can also learn more at our documentation website, https://jsonapi-suite.github.io/jsonapi_suite
+STR
+
+say(set_color(welcome.rstrip, :cyan, :bold))
+api_namespace
+
+require 'rails/version'
+
+gem 'graphiti'
+gem 'graphiti-rails'
+gem 'vandal_ui'
+gem 'kaminari', '~> 1.1'
+
+if Rails::VERSION::MAJOR == 5
+  gem 'responders', '~> 2.4'
+else
+  gem 'responders', '~> 3.0'
+end
+
+gem_group :development, :test do
+  if Rails::VERSION::MAJOR == 5
+    gem 'rspec-rails', '~> 3.5.2'
+  else
+    gem 'rspec-rails', '~> 4.0.0beta2'
+  end
+
+  gem 'factory_bot_rails', '~> 5.0'
+  gem 'faker', '~> 2.5' # keep here for seeds.rb
+  gem 'graphiti_spec_helpers'
+end
+
+gem_group :test do
+  gem 'database_cleaner', '~> 1.7'
+end
+
+after_bundle do
+unless Rails::VERSION::MAJOR > 6
+run 'bin/spring stop'
+end
+
+git :init
+git add: '.'
+run "bundle binstub rspec-core"
+rails_command "generate rspec:install"
+run "rm -rf test"
+
+insert_into_file "spec/rails_helper.rb", :after => "require 'rspec/rails'\n" do
+  "require 'graphiti_spec_helpers/rspec'\n"
+end
+
+insert_into_file "spec/rails_helper.rb", :after => "RSpec.configure do |config|\n" do
+  <<-STR
+
+  # bootstrap database cleaner
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.around(:each) do |example|
+    begin
+      DatabaseCleaner.cleaning do
+        example.run
+      end
+    ensure
+      DatabaseCleaner.clean
+    end
+  end
+
+  STR
+end
+
+insert_into_file "spec/rails_helper.rb", :after => "RSpec.configure do |config|\n" do
+  <<-STR
+
+  config.before :each do
+    handle_request_exceptions(false)
+  end
+  STR
+end
+
+insert_into_file "spec/rails_helper.rb", :after => "RSpec.configure do |config|\n" do
+  "  config.include Graphiti::Rails::TestHelpers\n"
+end
+
+insert_into_file "spec/rails_helper.rb", :after => "RSpec.configure do |config|\n" do
+  "  config.include GraphitiSpecHelpers::Sugar\n"
+end
+
+insert_into_file "spec/rails_helper.rb", :after => "RSpec.configure do |config|\n" do
+  "  config.include GraphitiSpecHelpers::RSpec\n"
+end
+
+insert_into_file "spec/rails_helper.rb", :after => "RSpec.configure do |config|\n" do
+  "  config.include FactoryBot::Syntax::Methods\n"
+end
+
+gsub_file "spec/rails_helper.rb", 'config.fixture_path = "#{::Rails.root}/spec/fixtures"' do |match|
+  "# #{match}"
+end
+
+gsub_file "spec/rails_helper.rb", 'config.use_transactional_fixtures = true' do |match|
+  "# #{match}"
+end
+
+run "mkdir spec/factories"
+
+rails_command('generate graphiti:install')
+run 'bundle binstubs bundler --force'
+rake('vandal:install')
+say(set_color("\nYou're all set!
+", :green, :bold))
+end
+
+

data/website/static/1.13/tutorial/index.html

@@ -0,0 +1,250 @@
+<!DOCTYPE html>
+<html lang="en">
+
+  <head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <link href="https://fonts.googleapis.com/css?family=Roboto+Mono" rel="stylesheet">
+  <link href="https://fonts.googleapis.com/css?family=Boogaloo" rel="stylesheet">
+
+  <link rel="apple-touch-icon" sizes="180x180" href="/1.13/assets/favicons/apple-touch-icon.png">
+  <link rel="icon" type="image/png" sizes="32x32" href="/1.13/assets/favicons/favicon-32x32.png">
+  <link rel="icon" type="image/png" sizes="16x16" href="/1.13/assets/favicons/favicon-16x16.png">
+  <link rel="manifest" href="/1.13/assets/favicons/site.webmanifest">
+  <link rel="mask-icon" href="/1.13/assets/favicons/safari-pinned-tab.svg" color="#F86DA7">
+  <link rel="shortcut icon" href="/1.13/assets/favicons/favicon.ico">
+  <meta name="msapplication-TileColor" content="#F86DA7">
+  <meta name="msapplication-config" content="/1.13/assets/favicons/browserconfig.xml">
+  <meta name="theme-color" content="#F86DA7">
+
+  <title>Graphiti</title>
+  <meta name="description" content="Stylish Graph APIs">
+
+  <link rel="stylesheet" href="/1.13/assets/main.css?ref=wh4t3v45">
+  <link rel="alternate" type="application/rss+xml" title="Graphiti" href="/1.13/feed.xml">
+
+  <!-- Global site tag (gtag.js) - Google Analytics -->
+  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-127904727-1"></script>
+  <script>
+    window.dataLayer = window.dataLayer || [];
+    function gtag(){dataLayer.push(arguments);}
+    gtag('js', new Date());
+
+    gtag('config', 'UA-127904727-1');
+  </script>
+
+  <!-- javascript -->
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
+  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
+
+  
+</head>
+
+
+  <body>
+    <main class="page-content" aria-label="Content">
+      <div class="wrapper">
+        <header class="navbar navbar-inverse normal" role="banner">
+  <div class="container">
+    <div class="navbar-header">
+      <a href="/1.13/1.13" class="navbar-brand">
+        <img alt="logo" src="/1.13/assets/img/logo.png">
+      </a>
+    </div>
+    <nav class="" role="navigation">
+      <ul class="nav navbar-nav nav-links">
+        <li>
+          <a class="quickstart nav-link" href="/1.13/quickstart">Quickstart</a>
+        </li>
+        <li>
+          <a class="guides nav-link" href="/1.13/guides">Guides</a>
+        </li>
+        <li>
+          <a class="tutorial nav-link" href="/1.13/tutorial">Tutorial</a>
+        </li>
+        <li>
+          <a class="spraypaint nav-link" href="/1.13/js">Spraypaint</a>
+        </li>
+      </ul>
+      <ul class="nav gh navbar-nav navbar-right visible-lg visible-md">
+        <li>
+          <span class="star">⭐</span>
+          <a href="https://github.com/graphiti-api/graphiti">
+            <img alt="github-star" style="margin-right: 65px;margin-top: -20px" src="/1.13/assets/img/gh.png">
+          </a>
+        </li>
+      </ul>
+    </nav>
+  </div>
+</header>
+
+        <div class="container">
+          <p align="center">
+  <img src="https://user-images.githubusercontent.com/55264/45711831-c87dbd80-bb58-11e8-9c67-84ba9427d60a.gif" />
+</p>
+
+<h1 id="tutorial">Tutorial</h1>
+
+<p>This tutorial serves as a deeper-dive into Graphiti development,
+building an Employee Directory application. We purposefully built this
+to illustrate common - but non-trivial - scenarios present in many
+applications.</p>
+
+<p>A core concept of Graphiti is <strong>Test-First</strong> - the most pleasant way to
+develop Graphiti is by starting with an <a href="/1.13/guides/concepts/testing">integration test</a>. But that can add a lot of noise to a tutorial like this. Though we’ll occasionally touch on testing - and the git diffs at the top of each section contain the necessary tests - we won’t test first for the purposes of this tutorial.</p>
+
+<div class="clearfix">
+<div class="tutorial col-md-6">
+
+    <h3 id="server-side-rails">Server Side: Rails</h3>
+
+    <p><a href="https://github.com/graphiti-api/employee_directory">Rails Sample Application</a></p>
+
+    <ul>
+      <li><a href="/1.13/tutorial/step_0">Step 0: Bootstrapping</a></li>
+      <li><a href="/1.13/tutorial/step_1">Step 1: Initial Resource</a></li>
+      <li><a href="/1.13/tutorial/step_2">Step 2: Has Many</a></li>
+      <li><a href="/1.13/tutorial/step_3">Step 3: Belongs To</a></li>
+      <li><a href="/1.13/tutorial/step_4">Step 4: Customizing Queries</a></li>
+      <li><a href="/1.13/tutorial/step_5">Step 5: Has One</a></li>
+      <li><a href="/1.13/tutorial/step_6">Step 6: Customizing Writes</a></li>
+      <li><a href="/1.13/tutorial/step_7">Step 7: Many-to-Many</a></li>
+      <li><a href="/1.13/tutorial/step_8">Step 8: Polymorphic
+Relationships</a></li>
+      <li><a href="/1.13/tutorial/step_9">Step 9: Polymorphic Resources</a></li>
+    </ul>
+
+  </div>
+
+<div class="tutorial col-md-6">
+
+    <h3 id="client-side-vuejs-diff-only">Client Side: VueJS (diff-only)</h3>
+
+    <p><a href="https://github.com/graphiti-api/employee-directory-vue">VueJS Sample Application</a></p>
+
+    <ul>
+      <li><a href="https://github.com/graphiti-api/employee-directory-vue/commit/be690c3038380e17e326935d595a0b83fc8004f9">Step 0: Setup</a>
+        <ul>
+          <li>Run after <code class="language-plaintext highlighter-rouge">vue create employee-directory-vue</code> using <a href="https://cli.vuejs.org">Vue CLI</a>.</li>
+        </ul>
+      </li>
+      <li><a href="https://github.com/graphiti-api/employee-directory-vue/compare/step_0_setup...step_1_models">Step 1: Define Models</a></li>
+      <li><a href="https://github.com/graphiti-api/employee-directory-vue/compare/step_1_models...step_2_data_grid">Step 2: Data Grid</a></li>
+      <li><a href="https://github.com/graphiti-api/employee-directory-vue/compare/step_2_data_grid...step_3_includes">Step 3: Relationships</a></li>
+      <li><a href="https://github.com/graphiti-api/employee-directory-vue/compare/step_3_includes...step_4_filtering">Step 4: Filtering</a></li>
+      <li><a href="https://github.com/graphiti-api/employee-directory-vue/compare/step_4_filtering...step_5_sorting">Step 5: Sorting</a></li>
+      <li><a href="https://github.com/graphiti-api/employee-directory-vue/compare/step_5_sorting...step_6_stats">Step 6: Total Count</a></li>
+      <li><a href="https://github.com/graphiti-api/employee-directory-vue/compare/step_6_stats...step_7_pagination">Step 7: Pagination</a></li>
+      <li><a href="https://github.com/graphiti-api/employee-directory-vue/compare/step_7_pagination...step_8_basic_form_setup">Step 8: Basic Form Setup</a></li>
+      <li><a href="https://github.com/graphiti-api/employee-directory-vue/compare/step_8_basic_form_setup...step_9_dropdown">Step 9: Dropdown</a></li>
+      <li><a href="https://github.com/graphiti-api/employee-directory-vue/compare/step_9_dropdown...step_10_nested_create">Step 10: Nested Form Submission</a></li>
+      <li><a href="https://github.com/graphiti-api/employee-directory-vue/compare/step_10_nested_create...step_11_validations">Step 11: Validation Errors</a></li>
+      <li><a href="https://github.com/graphiti-api/employee-directory-vue/compare/step_11_validations...step_12_nested_destroy">Step 12: Nested Destroy</a></li>
+      <li><a href="https://github.com/graphiti-api/employee-directory-vue/compare/step_12_nested_destroy...step_13_vue">Step 13: Vue-Specific Glue Code</a></li>
+    </ul>
+
+  </div>
+</div>
+
+<p><br />
+<br />
+<br />
+<br />
+<br /></p>
+
+        </div>
+      </div>
+    </main>
+    <div class="main-footer main-footer--dark">
+  <div class="container">
+    <div class="row">
+      <div class="col-sm-4 menu">
+        <h3>Overview</h3>
+        <ul>
+          <li>
+            <a href="/1.13/quickstart">Quickstart</a>
+          </li>
+          <li>
+            <a href="/1.13/tutorial">Tutorial</a>
+          </li>
+          <li>
+            <a href="/1.13/guides">Guides</a>
+          </li>
+        </ul>
+      </div>
+      <div class="col-sm-4 menu">
+        <h3>Contact</h3>
+        <ul>
+          <li>
+            <a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
+          </li>
+          <li>
+            <a href="mailto:richmolj@gmail.com">Email</a>
+          </li>
+        </ul>
+      </div>
+      <div class="col-sm-4 menu">
+        <h3>Related</h3>
+        <ul>
+          <li>
+            <a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
+          </li>
+          <li>
+            <a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
+          </li>
+          <li>
+            <a target="_blank" href="https://vuejs.org/">VueJS</a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+</div>
+
+    <script type="text/javascript">
+$(function () {
+
+  var flipTabs = function() {
+    var isTS = true;
+    if (localStorage.getItem('js-lang') === 'javascript') {
+      isTS = false;
+    }
+
+    $('.code-tabs').each(function(index, el) {
+      if (isTS) {
+        console.log('hiding js');
+        $($(el).children()[1]).hide();
+        $($(el).children()[0]).show();
+      } else {
+        console.log('hiding ts');
+        $($(el).children()[0]).hide();
+        $($(el).children()[1]).show();
+      }
+    });
+
+    if (isTS) {
+      $('.tab.typescript').addClass('active');
+      $('.tab.javascript').removeClass('active');
+    } else {
+      $('.tab.typescript').removeClass('active');
+      $('.tab.javascript').addClass('active');
+    }
+  }
+
+  $('.tab').click(function() {
+    if ($(this).hasClass('typescript')) {
+      localStorage.setItem('js-lang', 'typescript');
+    } else {
+      localStorage.setItem('js-lang', 'javascript');
+    }
+
+    flipTabs();
+  });
+
+  flipTabs();
+})
+</script>
+
+  </body>
+</html>