magic_test 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e4c59a0e6c290ee746ade6639fc584381ba394c5a94b80e3ff77d7e4b82f8cf
-  data.tar.gz: 9b414506b6286e4f8d0a3edbf115464e9ac10c7177a90088a64d170907297389
+  metadata.gz: 75adfb4e31a3cddd41feccf5105643d887e6744e050a3cecd2e3944f48be7ddc
+  data.tar.gz: 5fa8c00d0ba7a14cb1b95033f297af1988abe0c698e3b1e7b32882b0d9c23ef0
 SHA512:
-  metadata.gz: 3532b52fcc881558bb6f51fd51e870d5c1d0429919adf91a31a4c3ca59eec67a3358686e2d88ec6c196fbb2fdc95ffb73e22ef32745416954bc662e57ef7932f
-  data.tar.gz: 802b48e9ec6fd7b7dcabb403355b097d84f793a780d392a6ea26eba66daa1216374b9ec792ea556fd09e8f5ce2818c3d8cd04c9db00240ac8a13c5f20d5c17b5
+  metadata.gz: 2d5cc5f25c5198909f2a2fa3a7564871f79b750589a4a61b75d59f3b1e8e32a26ba515f852b6b22f4f6f67cd86a13bb1998eb2228aaca22b7b20fc4dda0a0cf4
+  data.tar.gz: aa3b684389d75750883ec106f9f67293a00d31eba760c1ea5a6020906c3b4fdaf22cdcae921bf768f966210601fc15eb5a2935c2a4905dc4c1b17c908d23a1a2

data/.standard.yml

@@ -0,0 +1,3 @@
+ignore:                 # default: []
+  - 'lib/magic_test/support.rb':
+    - Lint/Debugger

data/Gemfile

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    magic_test (0.0.1)
+    magic_test (0.0.5)
       capybara (~> 3.0)
       pry
       pry-stack_explorer
@@ -71,6 +71,7 @@ GEM
       zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
     binding_of_caller (1.0.0)
       debug_inspector (>= 0.0.1)
     builder (3.2.4)
@@ -109,6 +110,9 @@ GEM
       racc (~> 1.4)
     nokogiri (1.11.1-x86_64-darwin)
       racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
     pry (0.14.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -146,8 +150,25 @@ GEM
       method_source
       rake (>= 0.8.7)
       thor (~> 1.0)
+    rainbow (3.0.0)
     rake (13.0.3)
     regexp_parser (2.1.1)
+    rexml (3.2.4)
+    rubocop (1.10.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -155,9 +176,13 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
+    standard (0.13.0)
+      rubocop (= 1.10.0)
+      rubocop-performance (= 1.9.2)
     thor (1.1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
     websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
@@ -174,6 +199,7 @@ DEPENDENCIES
   magic_test!
   minitest (~> 5.0)
   rake (~> 13.0)
+  standard
 
 BUNDLED WITH
    2.2.0

data/README.md

@@ -30,14 +30,12 @@ Then run the following in your shell:
 bundle install
 ```
 
-Next, run the install generator. If your application already includes jQuery, you can just run:
+Next, run the install generator:
 
 ```
 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.

data/Rakefile

@@ -7,4 +7,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+task default: :test

data/app/views/magic_test/_context_menu.html

@@ -1,10 +1,17 @@
 <script>
-
-  // TODO do we have to do this differently for turbo?
-  $(document).ready(function() {
+  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') {

data/app/views/magic_test/_finders.html

@@ -1,7 +1,7 @@
 <script>
 
   function getPathTo(element) {
-    if (element.tagName == 'HTML') {
+    if (element.tagName === 'HTML') {
       return '/HTML[1]';
     }
     if (element===document.body) {
@@ -20,27 +20,30 @@
     }
   }
 
-  // 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 visibleFilter(target){
+    var computedStyle = window.getComputedStyle(target);
+    return !(computedStyle.display === 'none' || computedStyle.visibility === 'hidden' || target.hidden)
   }
 
 
   function finderForElement(element) {
     // Try to find just using the element tagName
     var tagName = element.tagName.toLowerCase();
-    if ($(tagName).length == 1) {
+    if (document.querySelectorAll(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) {
+    if (classList.length && document.querySelectorAll(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) {
+    var targets = Array.from(document.querySelectorAll(`${tagName}${classString}`))
+                       .filter(visibleFilter)
+                       .filter((el) => el.textContent.includes(text))
+    if (text && targets.length === 1) {
       return `find('${tagName}${classString}', text: '${text}')`;
     }
     // use the xpath to the element
@@ -48,4 +51,4 @@
   }
 
 
-</script>
+</script>

data/app/views/magic_test/_javascript_helpers.html

@@ -1,29 +1,30 @@
 <script text="text/javascript">
 
-  $(function() {
+  (function() {
     console.log("🪄 Magic Test activated in the browser!")
     initializeStorage();
     initializeMutationObserver();
-  });
+  })();
 
   function clickFunction(event) {
-    var tagName = event.currentTarget.tagName
+    var element = event.target
+    var tagName = element.tagName
     var action = ""
     var target = ""
     var options = ""
-    if (tagName == "BUTTON" || tagName == "A" || (tagName == "INPUT" && event.currentTarget.type == 'submit')) {
+    if (tagName == "BUTTON" || tagName == "A" || (tagName == "INPUT" && element.type == 'submit')) {
       action = "click_on"
-      var target = event.currentTarget.value || event.currentTarget.text
+      target = element.value || element.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)) {
+      if (ignoreType.includes(element.type)) {
         return;
       }
-      var path = getPathTo(event.currentTarget)
+      var path = getPathTo(element)
       action = `find(:xpath, '${path}').click`
     } else {
       return;

data/app/views/magic_test/_listeners.html

@@ -4,6 +4,5 @@
   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)});
+  document.addEventListener('click', function(event){clickFunction(event)});
 </script>

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

@@ -1,8 +1,4 @@
 <% 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' %>

data/lib/generators/magic_test/install_generator.rb

@@ -1,40 +1,28 @@
-require 'rails/generators'
-require 'magic_test/engine'
+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'
+      [MagicTest::Engine.root, File.expand_path("../templates", __FILE__)]
     end
 
     def install
       unless defined?(MagicTest)
         gem_group :test do
-          gem 'magic_test'
+          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)"
-
+      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/magic_test.rb

@@ -6,9 +6,6 @@ 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

data/lib/magic_test/engine.rb

@@ -1,11 +1,11 @@
-require 'magic_test/support'
-require 'pry'
-require 'pry-stack_explorer'
+require "magic_test/support"
+require "pry"
+require "pry-stack_explorer"
 
 module MagicTest
   class Engine < Rails::Engine
     config.after_initialize do
-      if ENV['MAGIC_TEST'].present?
+      if ENV["MAGIC_TEST"].present?
         if defined? ActionDispatch::SystemTestCase
           ActionDispatch::SystemTestCase.include MagicTest::Support
         end
@@ -14,7 +14,11 @@ module MagicTest
           ActionDispatch::IntegrationTest.include MagicTest::Support
         end
 
-
+        if defined? RSpec
+          RSpec.configure do |config|
+            config.include MagicTest::Support, type: :system
+          end
+        end
       end
     end
   end

data/lib/magic_test/railtie.rb

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

data/lib/magic_test/support.rb

@@ -5,7 +5,7 @@ module MagicTest
       return if selected_text.blank?
 
       # TODO this feels like it's going to end up burning people who have other support files in `test` or `spec` that don't include `helper` in the name.
-      filepath, line = caller.select { |s| s.include?("/test/") || s.include?("/spec/") }.reject { |s| s.include?("helper") }.first.split(':')
+      filepath, line = caller.select { |s| s.include?("/test/") || s.include?("/spec/") }.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
@@ -13,7 +13,7 @@ module MagicTest
       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.open(filepath, "w") do |file|
         file.puts(contents)
       end
     end
@@ -27,19 +27,19 @@ module MagicTest
       i = 2
       last = history_lines.last(2).first
       last_block = [last]
-      if last == 'end' || last.first(4) == 'end '
+      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
+        until !last_block.first.match(/^(\s+)/) & [0]
           i += 1
           last_block.unshift(history_lines.last(i).first)
         end
       end
-      return last_block
+      last_block
     end
 
     def flush
-      filepath, line = caller.select { |s| s.include?("/test/") }.reject { |s| s.include?("helper") }.first.split(':')
+      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]
@@ -51,11 +51,11 @@ module MagicTest
       puts "(writing that to `#{filepath}`.)"
       if output
         output.each do |last|
-          chunks.first << indentation + "#{last['action']} #{last['target']}#{last['options']}" + "\n"
+          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.open(filepath, "w") do |file|
           file.puts(contents)
         end
         # clear the testing output now.
@@ -63,11 +63,11 @@ module MagicTest
       else
         puts "`window.testingOutput` was empty in the browser. Something must be wrong on the browser side."
       end
-      return true
+      true
     end
 
     def ok
-      filepath, line = caller.select { |s| s.include?("/test/") }.reject { |s| s.include?("helper") }.first.split(':')
+      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
@@ -77,19 +77,17 @@ module MagicTest
         @test_lines_written += 1
       end
       contents = chunks.flatten.join
-      File.open(filepath, 'w') do |file|
+      File.open(filepath, "w") do |file|
         file.puts(contents)
       end
-      return true
+      true
     end
 
     def empty_cache
-      begin
-        page.evaluate_script("sessionStorage.setItem('testingOutput', JSON.stringify([]))")
-      rescue Capybara::NotSupportedByDriverError => e
-        # TODO we need to add more robust instructions for this.
-        raise "You need to configure this test (or your test suite) to run in a real browser (Chrome, Firefox, etc.) in order for Magic Test to work. It also needs to run in non-headless mode if `ENV['MAGIC_TEST'].present?`"
-      end
+      page.evaluate_script("sessionStorage.setItem('testingOutput', JSON.stringify([]))")
+    rescue Capybara::NotSupportedByDriverError => _
+      # TODO we need to add more robust instructions for this.
+      raise "You need to configure this test (or your test suite) to run in a real browser (Chrome, Firefox, etc.) in order for Magic Test to work. It also needs to run in non-headless mode if `ENV['MAGIC_TEST'].present?`"
     end
 
     def magic_test

data/lib/magic_test/version.rb

@@ -1,3 +1,3 @@
 module MagicTest
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/tasks/magic_test.rake

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

data/magic_test.gemspec

@@ -3,27 +3,28 @@ $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.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"
+  spec.summary = "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
+  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.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_development_dependency "standard"
 
   spec.add_dependency "pry"
   spec.add_dependency "pry-stack_explorer"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magic_test
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Andrew Culver
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-01 00:00:00.000000000 Z
+date: 2021-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,6 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +132,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".standard.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -136,7 +151,6 @@ files:
 - 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

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

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