Merge pull request #76 from bullet-train-co/add-dummy-app

Add dummy app to gem
bullet-train-co · Dec 27, 2022 · a2827a5 · a2827a5
2 parents 765be6a + e685af0
commit a2827a5
Show file tree

Hide file tree

Showing 63 changed files with 1,078 additions and 17 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,12 @@
 /_yardoc/
 /coverage/
 /doc/
+/log/*.log
 /pkg/
 /spec/reports/
 /tmp/
+/test/dummy/db/*.sqlite3
+/test/dummy/db/*.sqlite3-*
+/test/dummy/log/*.log
+/test/dummy/storage/
+/test/dummy/tmp/
diff --git a/Gemfile b/Gemfile
@@ -2,5 +2,8 @@ source "https://rubygems.org"
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
+gem "sqlite3"
+gem "sprockets-rails"
+
 # Specify your gem's dependencies in magic_test.gemspec
 gemspec
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -131,8 +131,6 @@ GEM
     nokogiri (1.13.3)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    nokogiri (1.13.3-x86_64-darwin)
-      racc (~> 1.4)
     parallel (1.21.0)
     parser (3.0.3.2)
       ast (~> 2.4.1)
@@ -192,6 +190,15 @@ GEM
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
+    sprockets (4.1.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.5.4)
+      mini_portile2 (~> 2.8.0)
     standard (1.5.0)
       rubocop (= 1.23.0)
       rubocop-performance (= 1.12.0)
@@ -217,6 +224,8 @@ DEPENDENCIES
   magic_test!
   minitest (>= 5.0)
   rake (>= 13.0)
+  sprockets-rails
+  sqlite3
   standard
 
 BUNDLED WITH

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ Magic Test allows you to write Rails system tests interactively through a combin
 
 > Magic Test is still in early development, and that includes the documentation. Any questions you have that aren't already address in the documentation should be [opened as issues](https://github.com/bullet-train-co/magic_test/issues/new) so they can be appropriately addressed in the documentation. 
 
-Magic Test was created by [Andrew Culver](http://twitter.com/andrewculver) and [Adam Pallozzi](https://twitter.com/adampallozzi).
+Magic Test was created by [Andrew Culver](http://twitter.com/andrewculver) and [Adam Pallozzi](https://twitter.com/adampallozzi) and maintained by [Adrian Valenzuela](https://twitter.com/adrianvalenz_).
 
 ## Sponsored By
 
@@ -36,10 +36,10 @@ rails g magic_test:install
 
 With this we will:
 
- - Create a sample system test at `test/system/basics_test.rb` that invokes Magic Test.
- - If your application was previously configured to run system tests with `:headless_chrome` or `:headless_firefox`, we will attempt to update your configuration so you can see the browser when you run tests with `MAGIC_TEST=1` as an environment variable.
-
- Finally, because it’s hard for us to do automatically, you will need to add the following before any closing `</head>` tags in any of the files in `app/views/layouts`:
+- Create a sample system test at `test/system/basics_test.rb` that invokes Magic Test via the `magic_test` method.
+- Update your configuration to run a visible browser test if `MAGIC_TEST=1` is set as an environment variable, and a headless browser setting if the environment variable is not present.
+- Insert a snippet to render a partial before any closing `</head>` tags in your `*.html.erb` views within the `app/views/layouts` directory.
+> If you have any views containing `<head></head>` tags then please place this snippet so Magic Test can work accordingly.
 
 ```ruby+erb
 <%= render 'magic_test/support' if Rails.env.test? %>
@@ -60,7 +60,7 @@ This results in three windows:
   2. **A browser** where you can click around the application and have your actions automatically converted into Capybara code.
   3. **A editor** where you mostly just watch test code appear magically, but you can also edit it by hand should you need to.
 
-If you have the screen real estate, we recommend organizing the three windows so you can see them all at the same time. This is the intended Magic Test developer experience.
+If you have the screen real estate, we recommend organizing the three windows so you can see them all at the same time. This is the intended Magic Test developer experience. The browser will always open to the left at a width of 800 pixels. This is done so you can set up your other windows just once and expect your browser to appear in the same place during every test.
 
 > #### Using Magic Test in New or Existing Tests
 > Just add a call to `magic_test` anywhere you want to start interactively developing test behavior and run the test the same way we've described above.
@@ -71,7 +71,7 @@ You’re now free to issue Capybara commands in the debugger and see their resul
 
 When you’re done writing the test interactively, you can press <kbd>Control</kbd> + <kbd>D</kbd> to finish running the test.
 
-You can re-run `MAGIC_TEST=1 rails test test/system/basics_test.rb` to have the test execute up until the point where you stopped, and then re-enter the debugging session to continue writing the test. This is a great workflow for testing your work as you go.
+You can re-run `MAGIC_TEST=1 rails test test/system/basics_test.rb` or `bin/magic test test/system/basics_test.rb` to have the test execute up until the point where you stopped, and then re-enter the debugging session to continue writing the test. This is a great workflow for testing your work as you go.
 
 When you’re actually done writing the test, be sure to remove the `magic_test` reference in the test file.
 

diff --git a/bin/rails b/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/magic_test/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"
diff --git a/lib/generators/magic_test/install_generator.rb b/lib/generators/magic_test/install_generator.rb
@@ -14,15 +14,62 @@ def install
         end
       end
 
+      create_sample_test
+      update_config_file
+      update_layout_templates
+      show_install_message
+    end
+
+    private
+
+    def create_sample_test
       generate "system_test", "basic"
-      gsub_file "test/system/basics_test.rb", "# ", ""
-      gsub_file "test/system/basics_test.rb", "#", ""
-      gsub_file "test/system/basics_test.rb", "visiting the index", "getting started"
-      gsub_file "test/system/basics_test.rb", "visit basics_url", "visit root_path"
-      gsub_file "test/system/basics_test.rb", 'assert_selector "h1", text: "Basic"', "magic_test"
-
-      gsub_file "test/application_system_test_case.rb", "using: :headless_chrome", "using: (ENV['SHOW_TESTS'] ? :chrome : :headless_chrome)"
-      gsub_file "test/application_system_test_case.rb", "using: :headless_firefox", "using: (ENV['SHOW_TESTS'] ? :firefox : :headless_firefox)"
+      test_file = "test/system/basics_test.rb"
+      gsub_file test_file, "# ", ""
+      gsub_file test_file, "#", ""
+      gsub_file test_file, "visiting the index", "getting started"
+      gsub_file test_file, "visit basics_url", "visit root_path"
+      gsub_file test_file, 'assert_selector "h1", text: "Basic"', "magic_test"
+    end
+
+    def update_config_file
+      config_file = "test/application_system_test_case.rb"
+
+      gsub_file config_file, "using: :chrome", "using: :headless_chrome"
+      gsub_file config_file, "using: :firefox", "using: :headless_firefox"
+
+      gsub_file config_file, "using: :headless_chrome", "using: (ENV['MAGIC_TEST'] ? :chrome : :headless_chrome)"
+      gsub_file config_file, "using: :headless_firefox", "using: (ENV['MAGIC_TEST'] ? :firefox : :headless_firefox)"
+
+      gsub_file config_file, "screen_size: [1400, 1400]", "screen_size: (ENV['MAGIC_TEST'] ? [800, 1400] : [1400, 1400])"
+    end
+
+    def update_layout_templates
+      templates = layout_templates
+      string = "    <%= render 'magic_test/support' if Rails.env.test? %>\n"
+      templates.each do |file|
+        insert_into_file file, string, before: /^\s*<\/head>/
+      end
+    end
+
+    def layout_templates
+      layouts = Dir.glob("#{Rails.root}/app/views/layouts/**/*.html.erb")
+      layouts.reject { |file| file =~ /mailer/ }
+    end
+
+    def show_install_message
+      message = %q(
+        We just inserted:
+        `<%= render 'magic_test/support' if Rails.env.test? %>`
+        before each closing `</head>` tag in your all of your templates in your `layouts` directory.
+        If there is another template or partial containing any `<head></head>` tags any where else in
+        your project (Example: `views/shared/_head.html.erb`), please paste the render snippet above within the head tags to ensure Magic Test
+        will work as expected.
+        Run your first Magic Test by typing `MAGIC_TEST=1 rails test test/system/basics_test.rb` or generate an executable
+        with `bundle binstubs magic_test` and then run `bin/magic test test/system/basics_test.rb` into your terminal!
+        )
+
+      puts message
     end
   end
 end
diff --git a/test/dummy/Rakefile b/test/dummy/Rakefile
@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks
diff --git a/test/dummy/app/assets/config/manifest.js b/test/dummy/app/assets/config/manifest.js
@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css
+//= link magic_test/application.js
diff --git a/test/dummy/app/assets/images/.keep b/test/dummy/app/assets/images/.keep
diff --git a/test/dummy/app/assets/javascript/application.js b/test/dummy/app/assets/javascript/application.js
diff --git a/test/dummy/app/assets/stylesheets/application.css b/test/dummy/app/assets/stylesheets/application.css
@@ -0,0 +1,29 @@
+/*
+ * 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
+ */
+
+/* Bullet Train blue #047bf8; */
+
+:root {
+  --light-blue: 	hsl(211, 97%, 83%);
+  --blue: 	hsl(211, 97%, 49%);
+  --dark-blue: 	hsl(211, 97%, 33%);
+}
+
+.site-header {
+  background-color: var(--blue);
+  color: var(--light-blue);
+  padding: 1rem;
+}
diff --git a/test/dummy/app/channels/application_cable/channel.rb b/test/dummy/app/channels/application_cable/channel.rb
@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end
diff --git a/test/dummy/app/channels/application_cable/connection.rb b/test/dummy/app/channels/application_cable/connection.rb
@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end
diff --git a/test/dummy/app/controllers/application_controller.rb b/test/dummy/app/controllers/application_controller.rb
@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end
diff --git a/test/dummy/app/controllers/concerns/.keep b/test/dummy/app/controllers/concerns/.keep
diff --git a/test/dummy/app/controllers/home_controller.rb b/test/dummy/app/controllers/home_controller.rb
@@ -0,0 +1,4 @@
+class HomeController < ApplicationController
+  def show
+  end
+end
diff --git a/test/dummy/app/helpers/application_helper.rb b/test/dummy/app/helpers/application_helper.rb
@@ -0,0 +1,2 @@
+module ApplicationHelper
+end
diff --git a/test/dummy/app/helpers/home_helper.rb b/test/dummy/app/helpers/home_helper.rb
@@ -0,0 +1,2 @@
+module HomeHelper
+end
diff --git a/test/dummy/app/jobs/application_job.rb b/test/dummy/app/jobs/application_job.rb
@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end
diff --git a/test/dummy/app/mailers/application_mailer.rb b/test/dummy/app/mailers/application_mailer.rb
@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: "[email protected]"
+  layout "mailer"
+end
diff --git a/test/dummy/app/models/application_record.rb b/test/dummy/app/models/application_record.rb
@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  primary_abstract_class
+end
diff --git a/test/dummy/app/models/concerns/.keep b/test/dummy/app/models/concerns/.keep
diff --git a/test/dummy/app/views/home/show.html.erb b/test/dummy/app/views/home/show.html.erb
@@ -0,0 +1,4 @@
+<section class="site-header">
+  <h1>Homepage Main App</h1>
+  <p>Find me in app/views/home/show.html.erb</p>
+</section>
diff --git a/test/dummy/app/views/layouts/application.html.erb b/test/dummy/app/views/layouts/application.html.erb
@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy Magic Test | Application layout</title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag "application" %>
+    <%= render 'magic_test/support' if Rails.env.test? %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+
+</html>
diff --git a/test/dummy/app/views/layouts/mailer.html.erb b/test/dummy/app/views/layouts/mailer.html.erb
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>
diff --git a/test/dummy/app/views/layouts/mailer.text.erb b/test/dummy/app/views/layouts/mailer.text.erb
@@ -0,0 +1 @@
+<%= yield %>
diff --git a/test/dummy/bin/rails b/test/dummy/bin/rails
@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path("../config/application", __dir__)
+require_relative "../config/boot"
+require "rails/commands"
diff --git a/test/dummy/bin/rake b/test/dummy/bin/rake
@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../config/boot"
+require "rake"
+Rake.application.run
diff --git a/test/dummy/bin/setup b/test/dummy/bin/setup
@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+# path to your application root.
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   FileUtils.cp "config/database.yml.sample", "config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system! "bin/rails db:prepare"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! "bin/rails log:clear tmp:clear"
+
+  puts "\n== Restarting application server =="
+  system! "bin/rails restart"
+end
diff --git a/test/dummy/config.ru b/test/dummy/config.ru
@@ -0,0 +1,6 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative "config/environment"
+
+run Rails.application
+Rails.application.load_server
diff --git a/test/dummy/config/application.rb b/test/dummy/config/application.rb
@@ -0,0 +1,25 @@
+require_relative "boot"
+
+require "rails/all"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+require "magic_test"
+
+module Dummy
+  class Application < Rails::Application
+    config.load_defaults Rails::VERSION::STRING.to_f
+
+    # For compatibility with applications that use this config
+    config.action_controller.include_all_helpers = false
+
+    # Configuration for the application, engines, and railties goes here.
+    #
+    # These settings can be overridden in specific environments using the files
+    # in config/environments, which are processed later.
+    #
+    # config.time_zone = "Central Time (US & Canada)"
+    # config.eager_load_paths << Rails.root.join("extras")
+  end
+end
diff --git a/test/dummy/config/boot.rb b/test/dummy/config/boot.rb
@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../../Gemfile", __dir__)
+
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+$LOAD_PATH.unshift File.expand_path("../../../lib", __dir__)
diff --git a/test/dummy/config/cable.yml b/test/dummy/config/cable.yml
@@ -0,0 +1,10 @@
+development:
+  adapter: async
+
+test:
+  adapter: test
+
+production:
+  adapter: redis
+  url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+  channel_prefix: dummy_production
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		class ApplicationController < ActionController::Base
		end