magic_test 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dd7c21ea35cc7ae4dee04062fbe0dde585a74606ed6f930b57b3f60a533a35ae
+  data.tar.gz: 5a1e4c3b4f0c7d2d172c3837e6fcabd3820d80a0ff96e4cd0cd08146e38626e6
+SHA512:
+  metadata.gz: bf114c2b6804a3d815b3f4527c8402738a16431768b8d88491ebb2446a9302743bd30779494f8d87c2fd62e60b46628ac334446c0779761bc34f284387cac0e3
+  data.tar.gz: 6228f530035cc236b34b226e36eeca8092fef7ff545c2952d5740a430689c776c6ffdc9266fc6b911cd35151ece8d1fb4f4f8d6b79e480e153d3309c089f3e2d

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 1.17.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+andrew@bullettrain.co.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in magic_test.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,172 @@
+PATH
+  remote: .
+  specs:
+    magic_test (0.1.0)
+      capybara (~> 3.0)
+      pry
+      rails (~> 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.3)
+      actionpack (= 6.1.3)
+      activesupport (= 6.1.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.3)
+      actionpack (= 6.1.3)
+      activejob (= 6.1.3)
+      activerecord (= 6.1.3)
+      activestorage (= 6.1.3)
+      activesupport (= 6.1.3)
+      mail (>= 2.7.1)
+    actionmailer (6.1.3)
+      actionpack (= 6.1.3)
+      actionview (= 6.1.3)
+      activejob (= 6.1.3)
+      activesupport (= 6.1.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.3)
+      actionview (= 6.1.3)
+      activesupport (= 6.1.3)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.3)
+      actionpack (= 6.1.3)
+      activerecord (= 6.1.3)
+      activestorage (= 6.1.3)
+      activesupport (= 6.1.3)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.3)
+      activesupport (= 6.1.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.3)
+      activesupport (= 6.1.3)
+      globalid (>= 0.3.6)
+    activemodel (6.1.3)
+      activesupport (= 6.1.3)
+    activerecord (6.1.3)
+      activemodel (= 6.1.3)
+      activesupport (= 6.1.3)
+    activestorage (6.1.3)
+      actionpack (= 6.1.3)
+      activejob (= 6.1.3)
+      activerecord (= 6.1.3)
+      activesupport (= 6.1.3)
+      marcel (~> 0.3.1)
+      mimemagic (~> 0.3.2)
+    activesupport (6.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    builder (3.2.4)
+    capybara (3.35.3)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (>= 1.5, < 3.0)
+      xpath (~> 3.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    crass (1.0.6)
+    erubi (1.10.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    loofah (2.9.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.5.0)
+    minitest (5.14.4)
+    nio4r (2.5.5)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    nokogiri (1.11.1-x86_64-darwin)
+      racc (~> 1.4)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.3)
+      actioncable (= 6.1.3)
+      actionmailbox (= 6.1.3)
+      actionmailer (= 6.1.3)
+      actionpack (= 6.1.3)
+      actiontext (= 6.1.3)
+      actionview (= 6.1.3)
+      activejob (= 6.1.3)
+      activemodel (= 6.1.3)
+      activerecord (= 6.1.3)
+      activestorage (= 6.1.3)
+      activesupport (= 6.1.3)
+      bundler (>= 1.15.0)
+      railties (= 6.1.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.3)
+      actionpack (= 6.1.3)
+      activesupport (= 6.1.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (~> 1.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-20
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  magic_test!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.2.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Andrew Culver
+
+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,95 @@
+# Magic Test
+
+Magic Test allows you to write Rails system tests interactively through a combination of trial-and-error in a debugger session and also just simple clicking around in the application being tested, all without the slowness of constantly restarting the testing environment.
+
+## Installation
+
+Magic Test currently requires your application to have jQuery enabled.
+
+Add this line to your application’s `Gemfile`:
+
+```ruby
+gem 'magic_test', group: :test
+```
+
+Then run the following in your shell:
+
+```
+bundle install
+```
+
+Next, run the install generator. If your application already includes jQuery, you can just run:
+
+```
+rails g magic_test:install
+```
+
+(If your application doesn't include jQuery, you'll need to let Magic Test know to include it as needed. Just add `no` to the end of the line above or adjust your configuration afterward in `config/initializers/magic_test.rb`. We'll only inject jQuery when Magic Test is actively running. It will never show up on CI.)
+
+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`:
+
+```
+<%= render 'magic_test/support' if Rails.env.test? %>
+```
+
+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
+
+### 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.
+
+This results in three windows:
+
+  1. **A debugger** where you can interactively write Capybara test code in the same context it would normally run.
+  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.
+
+### 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.
+
+### Writing Tests Manually in the Debugger Console
+
+You’re now free to type Capybara commands in the debugger and see their results in the Chrome browser. If you type something and you’re with the result, type `ok` and hit enter to have the last line of code you wrote added to the test.
+
+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.
+
+When you’re actually done writing the test, be sure to remove the `magic_test` reference in the test file.
+
+### Recording Your Test Actions in the Browser
+
+You can also write your tests by simply using your app in the browser window. This isn’t perfect yet by any means, but you’ll definitely get a sense for where we’re going with this and it’s already a pretty magical experience and a major productivity booster.
+
+You can click on buttons, click on links, fill in forms, and do many other things the way you would as a normal user. You may find there are certain shortcomings here, but our goal is to tackle all of those edge cases over time.
+
+### 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.
+
+### Flushing In Browser Actions and Assertions to the Test File
+
+The interactive actions you make in your app are not automatically written to your test.  When you are ready to write your actions out to the test, go to the terminal window and type `flush`.  This will flush all your recent actions out to the test file. It’s still early days for Magic Test, so you may find you need to clean up some of the output. Please don’t hesitate to submit new issues highlighting these scenarios so we can try to improve the results.
+
+### Ambiguous Labels and Elements
+
+When generating test code, we check to ensure a given label or element identifier won’t result in multiple or ambiguous matches the next time a test runs. If that situation arises, we’ll try to generate the appropriate `within` blocks and selectors to ensure the target button or field is disambiguated.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bullet-train-co/magic_test. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/app/views/magic_test/_context_menu.html

@@ -0,0 +1,41 @@
+<script>
+
+  // TODO do we have to do this differently for turbo?
+  $(document).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();
+      if (text.trim().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>

data/app/views/magic_test/_finders.html

@@ -0,0 +1,51 @@
+<script>
+
+  function getPathTo(element) {
+    if (element.tagName == 'HTML') {
+      return '/HTML[1]';
+    }
+    if (element===document.body) {
+      return '/HTML[1]/BODY[1]';
+    }
+    var ix = 0;
+    var siblings = element.parentNode.childNodes;
+    for (var i= 0; i<siblings.length; i++) {
+      var sibling= siblings[i];
+      if (sibling===element) {
+        return getPathTo(element.parentNode)+'/'+element.tagName+'['+(ix+1)+']';
+      }
+      if (sibling.nodeType===1 && sibling.tagName===element.tagName) {
+        ix++;
+      }
+    }
+  }
+
+  // Chrome doesn't respond to the jQuery :visible selector properly so we have to do this:
+  function visibleFilter(){
+    return $(this).css('display') != 'none' && $(this).css('visibility') != 'hidden';
+  }
+
+
+  function finderForElement(element) {
+    // Try to find just using the element tagName
+    var tagName = element.tagName.toLowerCase();
+    if ($(tagName).length == 1) {
+      return `find('${tagName}')`;
+    }
+    // Try adding in the classes of the element
+    var classList = [].slice.apply(element.classList)
+    var classString = classList.length ? "." + classList.join('.') : "";
+    if (classList.length && $(tagName + classList).length == 1) {
+      return `find('${tagName}${classString}')`;
+    }
+    // Try adding in the text of the element
+    var text = element.textContent.trim();
+    if (text && $(tagName + classString + `:contains(${text}):visible`).filter(visibleFilter).length == 1) {
+      return `find('${tagName}${classString}', text: '${text}')`;
+    }
+    // use the xpath to the element
+    return `find(:xpath, '${getPathTo(element)}')`;
+  }
+
+
+</script>

data/app/views/magic_test/_javascript_helpers.html

@@ -0,0 +1,132 @@
+<script text="text/javascript">
+
+  $(function() {
+    console.log("🪄 Magic Test activated in the browser!")
+    initializeStorage();
+    initializeMutationObserver();
+  });
+
+  function clickFunction(event) {
+    var tagName = event.currentTarget.tagName
+    var action = ""
+    var target = ""
+    var options = ""
+    if (tagName == "BUTTON" || tagName == "A" || (tagName == "INPUT" && event.currentTarget.type == 'submit')) {
+      action = "click_on"
+      var target = event.currentTarget.value || event.currentTarget.text
+      if (!target) {
+        return;
+      }
+      target = "\'" + target.trim().replace("'", "\\\'") + "\'"
+    } else if (tagName == "INPUT") {
+      let ignoreType = ['text', 'password', 'date', 'email', 'month', 'number', 'search']
+      if (ignoreType.includes(event.currentTarget.type)) {
+        return;
+      }
+      var path = getPathTo(event.currentTarget)
+      action = `find(:xpath, '${path}').click`
+    } else {
+      return;
+    }
+    var testingOutput = JSON.parse(sessionStorage.getItem("testingOutput"));
+    testingOutput.push({action: action, target: target, options: options });
+    sessionStorage.setItem("testingOutput", JSON.stringify(testingOutput));
+  };
+
+  function keypressFunction(evt) {
+    evt = evt || window.event;
+    var charCode = evt.keyCode || evt.which;
+    var charStr = String.fromCharCode(charCode);
+    if (!evt.target.labels) {
+      return;
+    }
+    var label = evt.target.labels[0].textContent;
+    var text = (evt.target.value + charStr).trim().replace("'", "\\\'");
+    var action = "fill_in";
+    var target = evt.target.labels[0].textContent;
+    var options = ", with: '" + text + "'";
+    var testingOutput = JSON.parse(sessionStorage.getItem("testingOutput"));
+    var lastAction = testingOutput[testingOutput.length - 1];
+    if (lastAction && lastAction.action == action && lastAction.target == "\'" + target + "\'") {
+      lastAction.options = options;
+    } else {
+      testingOutput.push({action: action, target: "\'" + target + "\'", options: options});
+    }
+    sessionStorage.setItem("testingOutput", JSON.stringify(testingOutput));
+  }
+
+  function keyDownFunction(evt){
+    if (evt.target.labels) {
+      return;
+    }
+    evt = evt || window.event;
+    var charCode = evt.keyCode || evt.which;
+    var charStr = capybaraFromCharCode(charCode);
+    var letter = evt.key == "'" ? "\\\'" : evt.key;
+    var tagName = evt.target.tagName.toLowerCase();
+    var action = finderForElement(evt.target) + "." // `find('${tagName}').`;
+    var target = ""
+    if (charStr) {
+      target = `send_keys(${charStr})`;
+    } else {
+      target = `send_keys('${letter}')`;
+    }
+    var options = "";
+    var testingOutput = JSON.parse(sessionStorage.getItem("testingOutput"));
+    var lastAction = testingOutput[testingOutput.length - 1];
+    // If the last key pressed was enter, always start a new action (otherwise with trix mentions, it happens too fast and we don't actually select the mentioned user correctly.)
+    if (lastAction && lastAction.target.substr(lastAction.target.length - 7 , 6) == ":enter") {
+      lastAction = null;
+    }
+    if (lastAction && lastAction.action == action && lastAction.target.substr(0,9) == 'send_keys') {
+      if (charStr) {
+        lastAction.target = lastAction.target.substr(0, lastAction.target.length - 1) + ', ' + charStr + ')'
+      } else {
+        if (lastAction.target.substr(lastAction.target.length - 2, 1) == "'") {
+          lastAction.target = lastAction.target.substr(0, lastAction.target.length - 2) + letter + '\'' + ')'
+        } else {
+          lastAction.target = lastAction.target.substr(0, lastAction.target.length - 1) + ', \'' + letter + '\'' + ')'
+        }
+      }
+    } else {
+      testingOutput.push({action: action, target: target, options: options});
+    }
+    sessionStorage.setItem("testingOutput", JSON.stringify(testingOutput));
+  }
+
+  function keyUpFunction(evt){
+    if (evt.target.labels) {
+      return;
+    }
+
+    evt = evt || window.event;
+    var charCode = evt.keyCode || evt.which;
+    var charStr = capybaraKeyUpFromCharCode(charCode);
+    if (!charStr) {
+      return;
+    }
+    var letter = String.fromCharCode(charCode);
+    var tagName = evt.target.tagName.toLowerCase();
+    var action = `find('${tagName}').`;
+    var target = ""
+    if (charStr) {
+      target = `send_keys(${charStr})`;
+    } else {
+      target = `send_keys('${letter}')`;
+    }
+    var options = "";
+    var testingOutput = JSON.parse(sessionStorage.getItem("testingOutput"));
+    var lastAction = testingOutput[testingOutput.length - 1];
+    if (lastAction && lastAction.action == action && lastAction.target.substr(0,9) == 'send_keys') {
+      if (charStr) {
+        lastAction.target = lastAction.target.substr(0, lastAction.target.length - 1) + ', ' + charStr + '' + ')'
+      } else {
+        lastAction.target = lastAction.target.substr(0, lastAction.target.length - 1) + ', \'' + letter + '\'' + ')'
+      }
+    } else {
+      testingOutput.push({action: action, target: target, options: options});
+    }
+    sessionStorage.setItem("testingOutput", JSON.stringify(testingOutput));
+  }
+
+</script>

data/app/views/magic_test/_key_codes.html

@@ -0,0 +1,50 @@
+<script>
+    function capybaraFromCharCode(charCode) {
+      codes = {
+        8  :  ':backspace',
+        9  :  ':tab',
+        13 :  ':enter',
+        16 :  ':shift',
+        17 :  ':control',
+        18 :  ':alt',
+        19 :  ':pause',
+        27 :  ':escape',
+        // 32 :  ':space',
+        33 :  ':page_up',
+        34 :  ':page_down',
+        35 :  ':end',
+        36 :  ':home',
+        37 :  ':left',
+        38 :  ':up',
+        39 :  ':right',
+        40 :  ':down',
+        45 :  ':insert',
+        46 :  ':delete',
+        91 :  ':command',
+        112:  ':f1',
+        113:  ':f2',
+        114:  ':f3',
+        115:  ':f4',
+        116:  ':f5',
+        117:  ':f6',
+        118:  ':f7',
+        119:  ':f8',
+        120:  ':f9',
+        121:  ':f10',
+        122:  ':f11',
+        123:  ':f12',
+      }
+      return codes[charCode];
+    }
+
+    function capybaraKeyUpFromCharCode(charCode) {
+      codes = {
+        16 :  ':shift',
+        17 :  ':control',
+        18 :  ':alt',
+        91 :  ':command',
+      }
+      return codes[charCode];
+    }
+
+</script>

data/app/views/magic_test/_listeners.html

@@ -0,0 +1,9 @@
+<script>
+  // document.addEventListener('keydown', function(e){keyDownFunction(e)}, true);
+  // document.addEventListener('keyup', function(e){keyUpFunction(e)}, true);
+  document.addEventListener('keypress', function(e){keypressFunction(e)});
+  document.addEventListener('mouseover', function(evt){mutationStart(evt)}, true);
+  document.addEventListener('mouseover', function(){mutationEnd()}, false);
+
+  $(document).on('click', '*', function(event){clickFunction(event)});
+</script>

data/app/views/magic_test/_mutation_observer.html

@@ -0,0 +1,36 @@
+<script>
+
+  function initializeMutationObserver(){
+    window.mutationObserver = new MutationObserver(function(mutations) {
+      console.log("Mutation observed")
+      if (!window.target) {
+        console.log("There is no window.target element. Quitting the mutation callback function");
+        return;
+      }
+      var options = "";
+      var targetClass = window.target.classList[0] ? `.${window.target.classList[0]}` : ""
+      var text = window.target.innerText ? `', text: '${window.target.innerText}` : ""
+      var action = `${finderForElement(window.target)}.hover`;
+      // var action = `find('${window.target.localName}${targetClass}${text}').hover`;
+      var target = "";
+      var testingOutput = JSON.parse(sessionStorage.getItem("testingOutput"));
+      testingOutput.push({action: action, target: target, options: options});
+      sessionStorage.setItem("testingOutput", JSON.stringify(testingOutput));
+    });
+    
+    
+    
+  }
+
+  function mutationStart(evt) {
+    window.target = evt.target;
+    const opts = {attributes: true, characterData: true, childList: true, subtree: true}
+    window.mutationObserver.observe(document.documentElement, opts);
+  }
+
+  function mutationEnd () {
+    window.mutationObserver.disconnect();
+  }
+
+
+</script>

data/app/views/magic_test/_storage.html

@@ -0,0 +1,9 @@
+<script>
+  function initializeStorage(){
+    if (sessionStorage.getItem("testingOutput") == null) {
+      sessionStorage.setItem("testingOutput", JSON.stringify([]));
+    }
+  }
+
+
+</script>

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

@@ -0,0 +1,13 @@
+<% if Rails.env.test? && ENV['MAGIC_TEST'].present? %>
+  <% unless MagicTest.jquery_already_included %>
+    <script src="https://code.jquery.com/jquery-3.5.1.min.js" integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0=" crossorigin="anonymous"></script>
+  <% end %>
+
+  <%= render 'magic_test/context_menu' %>
+  <%= render 'magic_test/key_codes' %>
+  <%= render 'magic_test/storage' %>
+  <%= render 'magic_test/finders' %>
+  <%= render 'magic_test/mutation_observer' %>
+  <%= render 'magic_test/javascript_helpers' %>
+  <%= render 'magic_test/listeners' %>
+<% end %>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "magic_test"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/magic_test/install_generator.rb

@@ -0,0 +1,40 @@
+require 'rails/generators'
+require 'magic_test/engine'
+
+module MagicTest
+  class InstallGenerator < Rails::Generators::Base
+    def self.source_paths
+      [MagicTest::Engine.root, File.expand_path('../templates', __FILE__)]
+    end
+
+    argument :jquery_already_included, :type => :string, :default => 'yes'
+
+    # Override the attr_accessor generated by 'argument' so that
+    # subscription_owner_model is always returned lowercase.
+    def jquery_already_included
+      @jquery_already_included.strip.downcase.first == 'y'
+    end
+
+    def install
+      unless defined?(MagicTest)
+        gem_group :test do
+          gem 'magic_test'
+        end
+      end
+
+      template 'config/initializers/magic_test.rb'
+
+      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)"
+
+
+    end
+  end
+end

data/lib/generators/magic_test/templates/config/initializers/magic_test.rb

@@ -0,0 +1,3 @@
+MagicTest.setup do |config|
+  config.jquery_already_included = <%= jquery_already_included ? 'true' : 'false' %>
+end if Rails.env.test?

data/lib/magic_test.rb

@@ -0,0 +1,15 @@
+require "magic_test/version"
+require "magic_test/railtie"
+require "magic_test/engine"
+require "magic_test/support"
+
+module MagicTest
+  class Error < StandardError; end
+
+  mattr_accessor :jquery_already_included
+  @@jquery_already_included = false
+
+  def self.setup
+    yield self
+  end
+end

data/lib/magic_test/engine.rb

@@ -0,0 +1,17 @@
+require 'magic_test/support'
+
+module MagicTest
+  class Engine < Rails::Engine
+    config.after_initialize do
+      if ENV['MAGIC_TEST'].present?
+        if defined? ActionDispatch::SystemTestCase
+          ActionDispatch::SystemTestCase.include MagicTest::Support
+        end
+
+        if defined? ActionDispatch::IntegrationTest
+          ActionDispatch::IntegrationTest.include MagicTest::Support
+        end
+      end
+    end
+  end
+end

data/lib/magic_test/railtie.rb

@@ -0,0 +1,7 @@
+module MagicTest
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__),'../tasks/*.rake')].each { |f| load f }
+    end
+  end
+end

data/lib/magic_test/support.rb

@@ -0,0 +1,97 @@
+module MagicTest
+  module Support
+    def assert_selected_exists
+      selected_text = page.evaluate_script("window.selectedText()")
+      return if selected_text.blank?
+      filepath, line = caller.select { |s| s.include?("/test/") }.reject { |s| s.include?("helper") }.first.split(':')
+      contents = File.open(filepath).read.lines
+      chunks = contents.each_slice(line.to_i - 1 + @test_lines_written).to_a
+      indentation = chunks[1].first.match(/^(\s*)/)[0]
+      chunks.first << indentation + "assert(page.has_content?('#{selected_text.gsub("'", "\\\\'")}'))" + "\n"
+      @test_lines_written += 1
+      contents = chunks.flatten.join
+      File.open(filepath, 'w') do |file|
+        file.puts(contents)
+      end
+    end
+
+    def track_keystrokes
+      page.evaluate_script("trackKeystrokes()")
+    end
+
+    def get_last
+      history_lines = Readline::HISTORY.to_a.last(20)
+      i = 2
+      last = history_lines.last(2).first
+      last_block = [last]
+      if last == 'end' || last.first(4) == 'end '
+        i += 1
+        last_block.unshift(history_lines.last(i).first)
+        until !last_block.first.match(/^(\s+)/)&[0] do
+          i += 1
+          last_block.unshift(history_lines.last(i).first)
+        end
+      end
+      return last_block
+    end
+
+    def flush
+      filepath, line = caller.select { |s| s.include?("/test/") }.reject { |s| s.include?("helper") }.first.split(':')
+      contents = File.open(filepath).read.lines
+      chunks = contents.each_slice(line.to_i - 1 + @test_lines_written).to_a
+      indentation = chunks[1].first.match(/^(\s*)/)[0]
+      output = page.evaluate_script("JSON.parse(sessionStorage.getItem('testingOutput'))")
+      puts
+      puts "javascript recorded on the front-end looks like this:"
+      puts output
+      puts
+      puts "(writing that to `#{filepath}`.)"
+      if output
+        output.each do |last|
+          chunks.first << indentation + "#{last['action']} #{last['target']}#{last['options']}" + "\n"
+          @test_lines_written += 1
+        end
+        contents = chunks.flatten.join
+        File.open(filepath, 'w') do |file|
+          file.puts(contents)
+        end
+        # clear the testing output now.
+        empty_cache
+      else
+        puts "`window.testingOutput` was empty in the browser. Something must be wrong on the browser side."
+      end
+      return true
+    end
+
+    def ok
+      filepath, line = caller.select { |s| s.include?("/test/") }.reject { |s| s.include?("helper") }.first.split(':')
+      puts "(writing that to `#{filepath}`.)"
+      contents = File.open(filepath).read.lines
+      chunks = contents.each_slice(line.to_i - 1 + @test_lines_written).to_a
+      indentation = chunks[1].first.match(/^(\s*)/)[0]
+      get_last.each do |last|
+        chunks.first << indentation + last + "\n"
+        @test_lines_written += 1
+      end
+      contents = chunks.flatten.join
+      File.open(filepath, 'w') do |file|
+        file.puts(contents)
+      end
+      return true
+    end
+
+    def empty_cache
+      page.evaluate_script("sessionStorage.setItem('testingOutput', JSON.stringify([]))")
+    end
+
+    def magic_test
+      empty_cache
+      @test_lines_written = 0
+      begin
+        binding.pry
+      rescue
+        retry
+      end
+    end
+  end
+end

data/lib/magic_test/version.rb

@@ -0,0 +1,3 @@
+module MagicTest
+  VERSION = "0.0.1"
+end

data/lib/tasks/magic_test.rake

@@ -0,0 +1,6 @@
+namespace :magic_test do
+  desc "Install Magic Test"
+  task :install do
+    system 'rails g magic_test:install'
+  end
+end

data/magic_test.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "magic_test/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "magic_test"
+  spec.version       = MagicTest::VERSION
+  spec.authors       = ["Andrew Culver", "Adam Pallozzi"]
+  spec.email         = ["andrew.culver@gmail.com", "adampallozzi@gmail.com"]
+
+  spec.summary       = %q{Create system tests interactively.}
+  spec.homepage      = "https://github.com/bullet-train/magic_test"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency "pry"
+  spec.add_dependency "capybara", "~> 3.0"
+  spec.add_dependency "rails", "~> 6.0"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: magic_test
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Culver
+- Adam Pallozzi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description:
+email:
+- andrew.culver@gmail.com
+- adampallozzi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/views/magic_test/_context_menu.html
+- app/views/magic_test/_finders.html
+- app/views/magic_test/_javascript_helpers.html
+- app/views/magic_test/_key_codes.html
+- app/views/magic_test/_listeners.html
+- app/views/magic_test/_mutation_observer.html
+- app/views/magic_test/_storage.html
+- app/views/magic_test/_support.html.erb
+- bin/console
+- bin/setup
+- lib/generators/magic_test/install_generator.rb
+- lib/generators/magic_test/templates/config/initializers/magic_test.rb
+- lib/magic_test.rb
+- lib/magic_test/engine.rb
+- lib/magic_test/railtie.rb
+- lib/magic_test/support.rb
+- lib/magic_test/version.rb
+- lib/tasks/magic_test.rake
+- magic_test.gemspec
+homepage: https://github.com/bullet-train/magic_test
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Create system tests interactively.
+test_files: []