magic_test 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8157f3ad45a33023af27727450bb43a7a54ef4f390bd21a1d5419f81bfd173d2
-  data.tar.gz: 40eab3d8bfe379bc346f294ed3d881521ddf8defcf7d53a1e60c994050a54b5c
+  metadata.gz: 015de5e14bc97d6b2c2b878fbac4a9e77bce655e1d76c34ef5c8c8f294d4ebfe
+  data.tar.gz: 9e4097db71f6a09517a78a68da450606c4a06413da6ddeef2ca921f9c4009be8
 SHA512:
-  metadata.gz: 91e84e80faf56d07bf8df3540c09c8324f12e85fe395bf75876d3316ec76d810f19436ceb1773d7848d52cc039c95e853aeac8222af3c9da1042c5ab50ea6d99
-  data.tar.gz: 13fad9265f6b3cf86a2d26760628680dc59c6aeeab896963e18d037effe0c8444e2449a48d2adcabdec937c628d1060ab8328e90565c7c6a772c75395226c106
+  metadata.gz: ac6f104c5be822130351be8222231a85ba0512c7a9db07e00938942341df7fc18a12e0f764fc1f81a0e3c83fc251d3d2f3f0f021ae7dd3fa6d7b1359ae488759
+  data.tar.gz: 0647614ed4b0a9ed3882dafeadf668c0b27b7d185eff280079b7bd6dc3512183e68f5c6f3720f7cf6d6a509dae5d631a2ee247e9d9e985da66c20c66e9d3d233

data/.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/

data/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

data/Gemfile.lock

@@ -1,81 +1,87 @@
 PATH
   remote: .
   specs:
-    magic_test (0.0.6)
+    magic_test (0.1.0)
       capybara (>= 3.0)
       pry
       pry-stack_explorer
-      rails (>= 6.0)
+      rails (>= 5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.0.0)
-      actionpack (= 7.0.0)
-      activesupport (= 7.0.0)
+    actioncable (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.0)
-      actionpack (= 7.0.0)
-      activejob (= 7.0.0)
-      activerecord (= 7.0.0)
-      activestorage (= 7.0.0)
-      activesupport (= 7.0.0)
+    actionmailbox (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activestorage (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
       mail (>= 2.7.1)
-    actionmailer (7.0.0)
-      actionpack (= 7.0.0)
-      actionview (= 7.0.0)
-      activejob (= 7.0.0)
-      activesupport (= 7.0.0)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      actionview (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
       mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
       rails-dom-testing (~> 2.0)
-    actionpack (7.0.0)
-      actionview (= 7.0.0)
-      activesupport (= 7.0.0)
+    actionpack (7.0.2.3)
+      actionview (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
       rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.0)
-      actionpack (= 7.0.0)
-      activerecord (= 7.0.0)
-      activestorage (= 7.0.0)
-      activesupport (= 7.0.0)
+    actiontext (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activestorage (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.0.0)
-      activesupport (= 7.0.0)
+    actionview (7.0.2.3)
+      activesupport (= 7.0.2.3)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.0)
-      activesupport (= 7.0.0)
+    activejob (7.0.2.3)
+      activesupport (= 7.0.2.3)
       globalid (>= 0.3.6)
-    activemodel (7.0.0)
-      activesupport (= 7.0.0)
-    activerecord (7.0.0)
-      activemodel (= 7.0.0)
-      activesupport (= 7.0.0)
-    activestorage (7.0.0)
-      actionpack (= 7.0.0)
-      activejob (= 7.0.0)
-      activerecord (= 7.0.0)
-      activesupport (= 7.0.0)
+    activemodel (7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activerecord (7.0.2.3)
+      activemodel (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activestorage (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
       marcel (~> 1.0)
       mini_mime (>= 1.1.0)
-    activesupport (7.0.0)
+    activesupport (7.0.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     binding_of_caller (1.0.0)
       debug_inspector (>= 0.0.1)
     builder (3.2.4)
-    capybara (3.36.0)
+    capybara (3.38.0)
       addressable
       matrix
       mini_mime (>= 0.1.3)
@@ -87,28 +93,39 @@ GEM
     coderay (1.1.3)
     concurrent-ruby (1.1.9)
     crass (1.0.6)
+    date (3.3.2)
     debug_inspector (1.1.0)
     erubi (1.10.0)
     globalid (1.0.0)
       activesupport (>= 5.0)
-    i18n (1.8.11)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    loofah (2.13.0)
+    loofah (2.14.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    mail (2.7.1)
+    mail (2.8.0)
       mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
     marcel (1.0.2)
     matrix (0.4.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
-    mini_portile2 (2.6.1)
+    mini_portile2 (2.8.0)
     minitest (5.15.0)
-    nio4r (2.5.8)
-    nokogiri (1.12.5)
-      mini_portile2 (~> 2.6.1)
-      racc (~> 1.4)
-    nokogiri (1.12.5-x86_64-darwin)
+    net-imap (0.3.2)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
+    nio4r (2.5.9)
+    nokogiri (1.13.3)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     parallel (1.21.0)
     parser (3.0.3.2)
@@ -119,33 +136,33 @@ GEM
     pry-stack_explorer (0.6.1)
       binding_of_caller (~> 1.0)
       pry (~> 0.13)
-    public_suffix (4.0.6)
+    public_suffix (5.0.1)
     racc (1.6.0)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (7.0.0)
-      actioncable (= 7.0.0)
-      actionmailbox (= 7.0.0)
-      actionmailer (= 7.0.0)
-      actionpack (= 7.0.0)
-      actiontext (= 7.0.0)
-      actionview (= 7.0.0)
-      activejob (= 7.0.0)
-      activemodel (= 7.0.0)
-      activerecord (= 7.0.0)
-      activestorage (= 7.0.0)
-      activesupport (= 7.0.0)
+    rails (7.0.2.3)
+      actioncable (= 7.0.2.3)
+      actionmailbox (= 7.0.2.3)
+      actionmailer (= 7.0.2.3)
+      actionpack (= 7.0.2.3)
+      actiontext (= 7.0.2.3)
+      actionview (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activemodel (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activestorage (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
       bundler (>= 1.15.0)
-      railties (= 7.0.0)
+      railties (= 7.0.2.3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (7.0.0)
-      actionpack (= 7.0.0)
-      activesupport (= 7.0.0)
+    railties (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
@@ -169,10 +186,20 @@ 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)
-    thor (1.1.0)
+    thor (1.2.1)
+    timeout (0.3.1)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
@@ -181,7 +208,7 @@ GEM
     websocket-extensions (0.1.5)
     xpath (3.2.0)
       nokogiri (~> 1.8)
-    zeitwerk (2.5.1)
+    zeitwerk (2.6.6)
 
 PLATFORMS
   ruby
@@ -192,7 +219,9 @@ DEPENDENCIES
   magic_test!
   minitest (>= 5.0)
   rake (>= 13.0)
+  sprockets-rails
+  sqlite3
   standard
 
 BUNDLED WITH
-   2.2.22
+   2.5.10

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Andrew Culver
+Copyright (c) 2020 Bullet Train, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -8,9 +8,7 @@ Magic Test was created by [Andrew Culver](http://twitter.com/andrewculver) and [
 
 ## Sponsored By
 
-<a href="https://bullettrain.co" target="_blank">
-  <img src="https://github.com/CanCanCommunity/cancancan/raw/develop/logo/bullet_train.png" alt="Bullet Train" width="400"/>
-</a>
+<a href="https://bullettrain.co" target="_blank"><img src="https://github.com/CanCanCommunity/cancancan/raw/develop/logo/bullet_train.png" alt="Bullet Train" width="400"/></a>
 <br/>
 <br/>
 
@@ -38,15 +36,26 @@ 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? %>
 ```
 
+Generate binstubs by running `bundle binstubs magic_test` in the root of your Rails application. Now you'll be able to run Magic Test
+with the following command:
+
+```
+bin/magic test test/system/basics_test.rb # for MiniTest
+bin/magic spec spec/system/basics_spec.rb # for RSpec
+```
+
+The bin executable is implicitly running your Rails test with an environment variable that Magic Test looks for. 
+The full command looks like this: `MAGIC_TEST=1 rails test test/system/basics_test.rb`.
+
 You should be done now! To review what we’ve done for you, be sure to do a `git diff` at this point and make sure our generators didn’t break anything!
 
 ## Usage
@@ -54,7 +63,7 @@ You should be done now! To review what we’ve done for you, be sure to do a `gi
 ### Running the Example Test
 
 1. Open `test/system/basics_test.rb` in your editor of choice.
-2. Run `MAGIC_TEST=1 rails test:system test/system/basics_test.rb` on the shell.
+2. Run `bin/magic test test/system/basics_test.rb` on your shell.
 
 This results in three windows:
 
@@ -62,7 +71,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.
@@ -73,7 +82,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:system 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.
 
@@ -85,7 +94,11 @@ You can click on buttons, click on links, fill in forms, and do many other thing
 
 ### Generating Assertions in the Browser
 
-If you want to add an assertion that some content exists on the page, simply highlight some text and press <kbd>Control</kbd><kbd>Shift</kbd> + <kbd>A</kbd>. You should see an alert dialog confirming the assertion has been generated.
+#### Method 1:
+If you want to add an assertion that some content exists on the page, simply highlight some text and press <kbd>Control</kbd><kbd>Shift</kbd> + <kbd>A</kbd>. You should see a confirm dialog asking for if you want to move forward with the assertion or cancel. 
+
+#### Method 2:
+You can now generate assertions by selecting your text and right-clicking with your mouse or touchpad. 
 
 ### Flushing In Browser Actions and Assertions to the Test File
 

data/app/views/magic_test/_context_menu.html.erb

@@ -0,0 +1,90 @@
+<script>
+  function ready(fn) {
+    if (document.readyState !== 'loading'){
+      fn();
+    } else {
+      document.addEventListener('DOMContentLoaded', fn);
+    }
+  }
+
+  ready(function() {
+    enableKeyboardShortcuts();
+  });
+
+
+  function enableKeyboardShortcuts() {
+    // Ctrl+A to generate an assertion
+    function keydown(event) {
+      if (event.ctrlKey && event.shiftKey && event.key === 'A') {
+        event.preventDefault();
+        generateAssertion();
+      }
+    }
+
+    document.addEventListener('keydown', keydown, false);
+
+    function generateAssertion() {
+      var text = selectedText().trim();
+      if (text.length > 0) {
+        var action = assertMethod() + text.replace("'", "\\\'") +  "'";
+        var testingOutput = JSON.parse(sessionStorage.getItem("testingOutput"));
+        var target = "";
+        var options = "";
+        var accept = "You selected:\n\r" + text + "\n\rOk: Type `flush` into debugger console to add to test.\nCancel: To select new text."
+        if (window.confirm(accept)) {
+          testingOutput.push({action: action, target: target, options: options});
+          sessionStorage.setItem("testingOutput", JSON.stringify(testingOutput));
+        }
+        else {
+          console.log("Assertion was not generated.")
+        }
+      }
+    }
+
+    // Right-click to generate an assertion
+    function riteklick(event) {
+      if (event.button == 2) {
+        window.addEventListener("contextmenu", e => e.preventDefault());
+        setupAssertion(event);
+      }
+    }
+
+    document.addEventListener('mousedown', riteklick);
+
+    function setupAssertion(event) {
+      var text = selectedText().trim();
+      if (text.length > 0) {
+        var action = assertMethod() + text.replace("'", "\\\'") +  "'";
+        var testingOutput = JSON.parse(sessionStorage.getItem("testingOutput"));
+        var target = "";
+        var options = "";
+        var accept = "You selected:\n\r" + text + "\n\rOk: Type `flush` into debugger console to add to test.\nCancel: To select new text."
+        if (window.confirm(accept)) {
+          testingOutput.push({action: action, target: target, options: options});
+          sessionStorage.setItem("testingOutput", JSON.stringify(testingOutput));
+        }
+        else {
+          console.log("Assertion was not generated.")
+        }
+      }
+    }
+
+    function assertMethod(){
+      <%- if defined? RSpec %>
+        return "expect(page).to have_content '"
+      <%- else %>
+        return "assert page.has_content? '"
+      <%- end %>
+    }
+
+    function selectedText() {
+      var text = "";
+      if (window.getSelection) {
+          text = window.getSelection().toString();
+      } else if (document.selection && document.selection.type != "Control") {
+          text = document.selection.createRange().text;
+      }
+      return text;
+    }
+  }
+</script>

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/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"

data/exe/magic

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+option = ARGV[0]
+file_path = ARGV[1]
+
+def run_magic_test(suite, option, file_path)
+  system("MAGIC_TEST=1 #{suite} #{option} #{file_path}")
+end
+
+case option
+when "test"
+  suite = "rails"
+  run_magic_test(suite, option, file_path)
+when "spec"
+  suite = "rspec"
+  run_magic_test(suite, option, file_path)
+when "--help"
+  help_info = %q(
+    Usage: `bin/magic [option] [path/to/file]`
+
+    option = 'test' # will run MiniTest
+    option = 'spec' # will run RSpec
+
+    Assign `file_path` to the path of the file you want to test
+
+    Each run will implicitly pass the `MAGIC_TEST=1` environment variable in order to run Magic Test and it's debugger
+  )
+
+  puts help_info
+else
+  quick_tip = %q(
+    To run Magic Test: `bin/magic [option] [path/to/file.rb]`
+
+    Run `bin/magic --help` for more information
+  )
+
+  puts quick_tip
+end

data/lib/generators/magic_test/install_generator.rb

@@ -14,15 +14,62 @@ module MagicTest
         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_url"
-      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

data/lib/magic_test/support.rb

@@ -76,10 +76,11 @@ module MagicTest
     end
 
     def magic_test
+      return unless ENV["MAGIC_TEST"].present?
       empty_cache
       @test_lines_written = 0
       begin
-        # 👋 This isn't helpful context. Type `up` and hit enter to see where you really are.
+        magic_test_pry_hook
         binding.pry
       rescue
         retry
@@ -88,6 +89,17 @@ module MagicTest
 
     private
 
+    def magic_test_pry_hook
+      Pry.hooks.add_hook(:before_session, "magic_test") do |output, binding, pry|
+        Pry.hooks.delete_hook(:before_session, 'magic_test')
+        magic_test_file_index = pry.backtrace.index{|line| line.include?(__FILE__)}
+        # walk up backtrace until finding the original caller
+        until pry.backtrace[magic_test_file_index + 1].include?(pry.last_file) do
+          pry.run_command('up')
+        end
+      end
+    end
+
     def get_last
       history_lines = Readline::HISTORY.to_a.last(20)
       i = 2

data/lib/magic_test/version.rb

@@ -1,3 +1,3 @@
 module MagicTest
-  VERSION = "0.0.7"
+  VERSION = "0.1.0"
 end

data/magic_test.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email = ["andrew.culver@gmail.com", "adampallozzi@gmail.com"]
 
   spec.summary = "Create system tests interactively."
-  spec.homepage = "https://github.com/bullet-train/magic_test"
+  spec.homepage = "https://github.com/bullet-train-co/magic_test"
   spec.license = "MIT"
 
   # Specify which files should be added to the gem when it is released.
@@ -29,5 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "pry"
   spec.add_dependency "pry-stack_explorer"
   spec.add_dependency "capybara", ">= 3.0"
-  spec.add_dependency "rails", ">= 6.0"
+  spec.add_dependency "rails", ">= 5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magic_test
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrew Culver
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-16 00:00:00.000000000 Z
+date: 2024-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,19 +115,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.0'
 description:
 email:
 - andrew.culver@gmail.com
 - adampallozzi@gmail.com
-executables: []
+executables:
+- magic
 extensions: []
 extra_rdoc_files: []
 files:
@@ -140,7 +141,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- app/views/magic_test/_context_menu.html
+- app/views/magic_test/_context_menu.html.erb
 - app/views/magic_test/_finders.html
 - app/views/magic_test/_javascript_helpers.html
 - app/views/magic_test/_key_codes.html
@@ -149,7 +150,9 @@ files:
 - app/views/magic_test/_storage.html
 - app/views/magic_test/_support.html.erb
 - bin/console
+- bin/rails
 - bin/setup
+- exe/magic
 - lib/generators/magic_test/install_generator.rb
 - lib/magic_test.rb
 - lib/magic_test/engine.rb
@@ -158,7 +161,7 @@ files:
 - lib/magic_test/version.rb
 - lib/tasks/magic_test.rake
 - magic_test.gemspec
-homepage: https://github.com/bullet-train/magic_test
+homepage: https://github.com/bullet-train-co/magic_test
 licenses:
 - MIT
 metadata: {}
@@ -177,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Create system tests interactively.

data/app/views/magic_test/_context_menu.html

@@ -1,48 +0,0 @@
-<script>
-  function ready(fn) {
-    if (document.readyState !== 'loading'){
-      fn();
-    } else {
-      document.addEventListener('DOMContentLoaded', fn);
-    }
-  }
-
-  ready(function() {
-    enableKeyboardShortcuts();
-  });
-
-
-  function enableKeyboardShortcuts() {
-    function keydown(event) {
-      if (event.ctrlKey && event.shiftKey && event.key === 'A') {
-        event.preventDefault();
-        generateAssertion();
-      }
-    }
-
-    document.addEventListener('keydown', keydown, false);
-
-    function generateAssertion() {
-      var text = selectedText().trim();
-      if (text.length > 0) {
-        var action = "assert page.has_content? '" + text.replace("'", "\\\'") +  "'";
-        var testingOutput = JSON.parse(sessionStorage.getItem("testingOutput"));
-        var target = "";
-        var options = "";
-        testingOutput.push({action: action, target: target, options: options});
-        sessionStorage.setItem("testingOutput", JSON.stringify(testingOutput));
-        alert("Generated an assertion for \"" + selectedText() + "\". Type `flush` in the debugger console to add it to your test file.");
-      }
-    }
-
-    function selectedText() {
-      var text = "";
-      if (window.getSelection) {
-          text = window.getSelection().toString();
-      } else if (document.selection && document.selection.type != "Control") {
-          text = document.selection.createRange().text;
-      }
-      return text;
-    }
-  }
-</script>