factory_bot_instrumentation 0.1.0

data/app/assets/stylesheets/factory_bot_instrumentation/application.css

@@ -0,0 +1,91 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will
+ * include all the files listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets,
+ * vendor/assets/stylesheets, or any plugin's vendor/assets/stylesheets
+ * directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear
+ * at the bottom of the compiled file so the styles you add here take
+ * precedence over styles defined in any other CSS/SCSS files in this
+ * directory. Styles in this file should be added after the last require_*
+ * statement.  It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */
+
+.row { margin-top: 5em }
+.result-container { background-color: #f8f8f8 }
+.hljs { background-color: #fff; }
+.jumbotron { padding: 1rem }
+.jumbotron .row { margin-top: 0 }
+.badge { cursor: pointer }
+.btn-link:hover, .btn-link:active, .btn-link:focus { text-decoration: none }
+
+pre {
+  margin-bottom: 0;
+  white-space: pre-wrap;
+  white-space: -moz-pre-wrap;
+  white-space: -pre-wrap;
+  white-space: -o-pre-wrap;
+  word-wrap: break-word;
+}
+
+pre + .btn {
+  margin-top: 1rem;
+}
+
+.spinner {
+  margin: 100px auto;
+  width: 50px;
+  height: 40px;
+  text-align: center;
+  font-size: 10px;
+}
+
+.spinner > div {
+  background-color: #333;
+  height: 100%;
+  width: 6px;
+  display: inline-block;
+
+  -webkit-animation: sk-stretchdelay 1.2s infinite ease-in-out;
+  animation: sk-stretchdelay 1.2s infinite ease-in-out;
+}
+
+.spinner .rect2 {
+  -webkit-animation-delay: -1.1s;
+  animation-delay: -1.1s;
+}
+
+.spinner .rect3 {
+  -webkit-animation-delay: -1.0s;
+  animation-delay: -1.0s;
+}
+
+.spinner .rect4 {
+  -webkit-animation-delay: -0.9s;
+  animation-delay: -0.9s;
+}
+
+.spinner .rect5 {
+  -webkit-animation-delay: -0.8s;
+  animation-delay: -0.8s;
+}
+
+@-webkit-keyframes sk-stretchdelay {
+  0%, 40%, 100% { -webkit-transform: scaleY(0.4) }
+  20% { -webkit-transform: scaleY(1.0) }
+}
+
+@keyframes sk-stretchdelay {
+  0%, 40%, 100% {
+    transform: scaleY(0.4);
+    -webkit-transform: scaleY(0.4);
+  }  20% {
+    transform: scaleY(1.0);
+    -webkit-transform: scaleY(1.0);
+  }
+}

data/app/controllers/factory_bot/instrumentation/application_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module FactoryBot::Instrumentation
+  # A base engine application controller.
+  class ApplicationController < ActionController::API
+  end
+end

data/app/controllers/factory_bot/instrumentation/root_controller.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module FactoryBot::Instrumentation
+  # The Instrumentation engine controller with frontend and API actions.
+  class RootController < ApplicationController
+    # This is required to make API controllers template renderable
+    include ActionView::Layouts
+
+    # Configure the default application layout
+    layout 'factory_bot/instrumentation/application'
+
+    # Show the instrumentation frontend which features the output of configured
+    # dynamic seeds scenarios. The frontend allows humans to generate new seed
+    # data on the fly.
+    def index
+      @instrumentation = instrumentation
+      @scenarios = scenarios
+      @config = FactoryBot::Instrumentation.configuration
+      render :index, layout: true
+    end
+
+    # Create a new entity with the given factory settings to create on demand
+    # dependencies for your testing needs. You can pass in requests without
+    # authentication in the following JSON format:
+    #
+    #   {
+    #     "factory": "user",
+    #     "traits": ["confirmed"],
+    #     "overwrite": {
+    #       "first_name": "Bernd",
+    #       "last_name": "Müller",
+    #       "email": "bernd.mueller@example.com",
+    #       "password": "secret"
+    #     }
+    #   }
+    #
+    # The result is the API v1 representation of the created entity.
+    def create
+      # Reload the factories to improve the test development experience
+      FactoryBot.reload
+      # Call the factory construction with the user given parameters
+      entity = FactoryBot.create(*factory_params)
+      # Render the resulting entity as an API v1 representation
+      render plain: entity.to_json, content_type: 'application/json'
+    rescue StandardError => err
+      # Log for local factory debugging and re-raise for canary onwards
+      Rails.logger.error("#{err}\n#{err.backtrace.join("\n")}")
+      raise err
+    end
+
+    private
+
+    # Parse the given parameters from the request and build
+    # a valid FactoryBot options set.
+    #
+    # @return [Array<Mixed>] the FactoryBot options
+    def factory_params
+      data = params.permit(:factory, traits: [])
+      overwrite = params.to_unsafe_h.fetch(:overwrite, {}).deep_symbolize_keys
+
+      [
+        data.fetch(:factory).to_sym,
+        *data.fetch(:traits, []).map(&:to_sym),
+        **overwrite
+      ]
+    end
+
+    # Unfortunately +Rails.configuration.instrumentation+ is only read once and
+    # do not hot-reload on changes. Thats why we read this file manually to get
+    # always a fresh state.
+    #
+    # @return [Hash{String => Mixed}] the instrumentation scenarios
+    def instrumentation
+      config_file = FactoryBot::Instrumentation.configuration.config_file.to_s
+      content = Pathname.new(config_file).read
+      template = ERB.new(content)
+      YAML.load(template.result(binding))[Rails.env]
+    end
+
+    # Map all the instrumentation scenarios into groups and pass them back.
+    #
+    # @return [Hash{String => Array}] the grouped scenarios
+    def scenarios
+      instrumentation['scenarios'].each_with_object({}) do |scenario, memo|
+        group = scenario_group(scenario['name'])
+        scenario['group'] = group
+        memo[group] = [] unless memo.key? group
+        memo[group] << scenario
+      end
+    end
+
+    # Map all the configured scenario groups to a useable hash.
+    #
+    # @return [Hash{Regexp => String}] the group mapping
+    def groups
+      instrumentation['groups'].each_with_object({}) do |(key, val), memo|
+        memo[Regexp.new(Regexp.quote(key))] = val
+      end
+    end
+
+    # Fetch the group name for a given scenario name. This will utilize the
+    # +SCENARIO_GROUPS+ map.
+    #
+    # @param name [String] the scenario name
+    # @return [String] the group name
+    def scenario_group(name)
+      groups.map do |pattern, group_name|
+        next unless pattern.match? name
+        group_name
+      end.compact.first || 'Various'
+    end
+  end
+end

data/app/views/factory_bot/instrumentation/application/_config.html.erb

@@ -0,0 +1,5 @@
+<script>
+window.config = <%== @config.config.to_json %>;
+window.scenarios = <%== @scenarios.to_json %>;
+window.createUrl = '<%= root_path %>';
+</script>

data/app/views/factory_bot/instrumentation/application/_scripts.html.erb

@@ -0,0 +1,18 @@
+<script src="https://cdnjs.cloudflare.com/ajax/libs/async/2.6.1/async.min.js"
+        integrity="sha256-QRRHCc3xM0GNZvTCvi0vm2f9zdOiOptAy6xGq7qN5hI="
+        crossorigin="anonymous"></script>
+<script src="https://code.jquery.com/jquery-3.3.1.min.js"
+        integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8="
+        crossorigin="anonymous"></script>
+<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.1/js/bootstrap.bundle.min.js"
+        integrity="sha384-u/bQvRA/1bobcXlcEYpsEdFVK/vJs3+T+nXLsBYJthmdBuavHvAW6UsmqO2Gd/F9"
+        crossorigin="anonymous"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"
+        integrity="sha256-/BfiIkHlHoVihZdc6TFuj7MmJ0TWcWsMXkeDFwhi0zw="
+        crossorigin="anonymous"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/json.min.js"
+        integrity="sha256-KPdGtw3AdDen/v6+9ue/V3m+9C2lpNiuirroLsHrJZM="
+        crossorigin="anonymous"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.1/clipboard.js"
+        integrity="sha256-OBi1PBVEbUGcnFd3wGpTEGuz/VKAdU0Zvux5ovdamtI="
+        crossorigin="anonymous"></script>

data/app/views/factory_bot/instrumentation/application/_spinner.html.erb

@@ -0,0 +1,7 @@
+<div id="spinner" class="spinner" style="display: none">
+  <div class="rect1"></div>
+  <div class="rect2"></div>
+  <div class="rect3"></div>
+  <div class="rect4"></div>
+  <div class="rect5"></div>
+</div>

data/app/views/factory_bot/instrumentation/application/_styles.html.erb

@@ -0,0 +1,20 @@
+<link href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.1/css/bootstrap.min.css"
+      rel="stylesheet"
+      integrity="sha384-WskhaSGFgHYWDcbwN70/dfYBj47jz9qbsMId/iRN3ewGhXQFZCSftd1LZCfmhktB"
+      crossorigin="anonymous">
+<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css"
+      rel="stylesheet"
+      integrity="sha256-3YM6A3pH4QFCl9WbSU8oXF5N6W/2ylvW0o2g+Z6TmLQ="
+      crossorigin="anonymous" />
+<link href="https://use.fontawesome.com/releases/v5.1.0/css/solid.css"
+      rel="stylesheet"
+      integrity="sha384-TbilV5Lbhlwdyc4RuIV/JhD8NR+BfMrvz4BL5QFa2we1hQu6wvREr3v6XSRfCTRp"
+      crossorigin="anonymous">
+<link href="https://use.fontawesome.com/releases/v5.1.0/css/regular.css"
+      rel="stylesheet"
+      integrity="sha384-avJt9MoJH2rB4PKRsJRHZv7yiFZn8LrnXuzvmZoD3fh1aL6aM6s0BBcnCvBe6XSD"
+      crossorigin="anonymous">
+<link href="https://use.fontawesome.com/releases/v5.1.0/css/fontawesome.css"
+      rel="stylesheet"
+      integrity="sha384-ozJwkrqb90Oa3ZNb+yKFW2lToAWYdTiF1vt8JiH5ptTGHTGcN7qdoR1F95e0kYyG"
+      crossorigin="anonymous">

data/app/views/factory_bot/instrumentation/root/index.html.erb

@@ -0,0 +1,31 @@
+<div class="row">
+  <div class="col-xl-4 col-lg-12">
+    <form id="generate" class="jumbotron">
+      <div class="form-group">
+        <select class="form-control scenario">
+          <% @scenarios.each do |group, scenarios| %>
+            <optgroup label="<%= group %>">
+              <% scenarios.each_with_index do |scenario, idx| %>
+                <option value="<%= group %>/<%= idx %>">
+                  <%= scenario['name'] %>
+                </option>
+              <% end %>
+            </optgroup>
+          <% end %>
+        </select>
+        <small class="form-text text-muted description"></small>
+      </div>
+      <button type="submit" class="btn btn-primary btn-block">Generate</button>
+    </form>
+    <%= render partial: 'factory_bot_instrumentation/blocks' %>
+  </div>
+  <div class="col-xl-8 col-lg-12">
+    <%= render partial: 'spinner' %>
+    <div id="result"
+         class="jumbotron result-container"
+         style="display: none"></div>
+  </div>
+</div>
+<script>
+  $(() => { (new CreateForm()).bind(); });
+</script>

data/app/views/factory_bot_instrumentation/_blocks.html.erb

@@ -0,0 +1,6 @@
+<%#
+You can replace this file at you application to add custom blocks.
+Create a new file at
++app/views/factory_bot_instrumentation/_blocks.html.erb+
+to make use of this feature.
+%>

data/app/views/factory_bot_instrumentation/_navigation.html.erb

@@ -0,0 +1,13 @@
+<%#
+You can replace this file at you application to add navigation entries.
+Create a new file at
++app/views/factory_bot_instrumentation/_navigation.html.erb+
+to make use of this feature.
+
+<li class="nav-item active">
+  <a class="nav-link" href="#">Home</span></a>
+</li>
+<li class="nav-item">
+  <a class="nav-link" href="#">Link</a>
+</li>
+%>

data/app/views/factory_bot_instrumentation/_scripts.html.erb

@@ -0,0 +1,5 @@
+<%#
+You can replace this file at you application to add custom scripts.
+Create a new file at +app/views/factory_bot_instrumentation/_scripts.html.erb+
+to make use of this feature.
+%>

data/app/views/factory_bot_instrumentation/_styles.html.erb

@@ -0,0 +1,5 @@
+<%#
+You can replace this file at you application to add custom styles.
+Create a new file at +app/views/factory_bot_instrumentation/_styles.html.erb+
+to make use of this feature.
+%>

data/app/views/layouts/factory_bot/instrumentation/application.html.erb

@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title><%= @config.application_name %> Instrumentation</title>
+    <%= render partial: 'styles' %>
+    <%= stylesheet_link_tag 'factory_bot_instrumentation/application',
+                            media: 'all' %>
+    <%= render 'factory_bot_instrumentation/styles' %>
+  </head>
+  <body>
+    <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
+      <a class="navbar-brand" href="#">
+        <%= @config.application_name %> Instrumentation
+      </a>
+      <ul class="navbar-nav mr-auto">
+        <%= render 'factory_bot_instrumentation/navigation' %>
+      </ul>
+    </nav>
+    <%= render partial: 'scripts' %>
+    <%= render partial: 'config' %>
+    <%= javascript_include_tag 'factory_bot_instrumentation/application' %>
+    <%= render 'factory_bot_instrumentation/scripts' %>
+    <main role="main" class="container">
+      <%= yield %>
+    </main>
+  </body>
+</html>

data/bin/rails

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/factory_bot_instrumentation/engine', __dir__)
+APP_PATH = File.expand_path('../test/dummy/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/instrumentation.yml

@@ -0,0 +1,55 @@
+# Define new dynamic seed scenarios here which can be used on the API
+# instrumentation frontend.
+
+default: &default
+  # Each group consists of a key (the pattern to match) and the value (group
+  # name).  The patterns are put inside a quoted regex and the first matching
+  # one will be used so the configuration order is important.
+  groups:
+    UX: UX Scenarios
+    user: Users
+
+  # All the scenarios which can be generated.
+  scenarios:
+    - name: Empty user
+      desc: Create a new user without any dependent data.
+      factory: :user
+      traits:
+        - :confirmed
+      overwrite: {}
+
+    - name: User with a single friend
+      desc: Create a new user with a single friend.
+      factory: :user
+      traits:
+        - :confirmed
+        - :with_friend
+      overwrite: {}
+
+    - name: User with a single friend named Bob
+      desc: Create a new user with a single friend whoes name is Bob.
+      factory: :user
+      traits:
+        - :confirmed
+        - :with_friend
+      overwrite:
+        friend_overwrites:
+          first_name: Bob
+
+    - name: User with multiple friends
+      desc: Create a new user with 5 friends.
+      factory: :user
+      traits:
+        - :confirmed
+        - :with_friends
+      overwrite:
+        friends_amount: 5
+
+test:
+  <<: *default
+
+development:
+  <<: *default
+
+production:
+  <<: *default