heavens_door 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e2b7e1472bb3a213d8a274264dec35b2d7ef99b3d07478a17ac0c2eea63ba4a
+  data.tar.gz: 52a1337ad38a19babbf1df3bee6f6ef0e477da2a5e57b54140d5b16387ea679a
+SHA512:
+  metadata.gz: a3f54255544342a67332e7ab5a3a1c5285c6450b24d17439cf5ab16d503576b8e6e1b8fd2c7cb7e5686a7d6f0c4eb69e0ea9599a30823267e0747a3439731518
+  data.tar.gz: e43bb5fa41d150ebe6f82c154c687ae1381980c7b5cc7f0a5152a18f95a32927020dff36999e115fda72e82a01ec7e704179fa4b29da01e849195e998ba850bc

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in heavens_door.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Akira Matsuda
+
+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,42 @@
+# Heaven's Door
+
+A tiny Rails engine that generates capybara test scenario by recording browser operation in development env.
+
+
+## Installation
+
+Add this line to your Rails application's Gemfile (in most cases, for development group only):
+
+```ruby
+gem 'heavens_door'
+```
+
+
+## Usage
+
+![Usage](heavens_door.gif)
+
+
+### Start Recording
+Visit your development with your browser, then click the ⏺ button on the top right.
+
+
+### Generate Schenarios
+Just manipulate the browser, like fill-in the forms and submit, or click the links.
+Your operations will be recorded on the browser.
+
+### Copy to Clipboard
+You can export the operation as a Capybara test scenario script by clicking the 📋 button.
+
+### Stop Recording
+To stop recording and clear the whole recorded scenario, click the ⏹ button.
+
+
+## Contributing
+
+Pull requests are welcome on GitHub at https://github.com/amatsuda/heavens_door.
+
+
+## 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/assets/javascripts/heavens_door.js

@@ -0,0 +1,80 @@
+(fn => {
+  if (document.attachEvent ? document.readyState === "complete" : document.readyState !== "loading") {
+    fn();
+  } else {
+    if (Turbolinks) {
+      document.addEventListener('turbolinks:load', fn);
+    } else {
+      document.addEventListener('DOMContentLoaded', fn);
+    }
+  }
+})(() => {
+  document.getElementById('heavens-door-start').addEventListener('click', e => {
+    document.getElementById('heavens-door-start').style.display = 'none';
+    document.getElementById('heavens-door-stop').style.display = 'inline';
+    document.getElementById('heavens-door-copy').style.display = 'inline';
+
+    if (!sessionStorage.heavensDoor) {
+      sessionStorage.heavensDoor = `  scenario 'GENERATED' do
+    visit '${window.location.pathname}'\n\n`;
+    }
+  });
+
+  document.getElementById('heavens-door-stop').addEventListener('click', e => {
+    document.getElementById('heavens-door-start').style.display = 'inline';
+    document.getElementById('heavens-door-stop').style.display = 'none';
+    document.getElementById('heavens-door-copy').style.display = 'none';
+    sessionStorage.clear('heavensDoor');
+  });
+
+  document.getElementById('heavens-door-copy').addEventListener('click', e => {
+    navigator.clipboard.writeText(sessionStorage.heavensDoor)
+      .catch(err => {
+        console.error('Could not copy text: ', err);
+        alert(sessionStorage.heavensDoor);
+      });
+  });
+
+  if (sessionStorage.heavensDoor) {
+    document.getElementById('heavens-door-start').click();
+  }
+
+  function labelIdForElement(el) {
+    if (el.id) {
+      const label = document.querySelector(`label[for=${el.id}]`);
+      return label ? label.innerHTML : el.id;
+    }
+  }
+
+  Array.from(document.getElementsByTagName('form')).forEach(form => {
+    form.addEventListener('submit', e => {
+      if (sessionStorage.heavensDoor) {
+        Array.from(form.querySelectorAll('input,textarea')).forEach(el => {
+          let target = labelIdForElement(el) || el.id;
+
+          if ((el.type == 'text') || (el.type == 'textarea') || (el.type == 'search') || (el.type == 'number') || (el.type == 'email') || (el.type == 'url') || (el.type == 'password') || (el.type == 'tel') || (el.type == 'date')) {
+            if (el.value) {
+              sessionStorage.heavensDoor += `    fill_in '${target}', with: '${el.value}'\n`;
+            }
+          } else if (el.type == 'select') {
+            sessionStorage.heavensDoor += `    select '${el[el.selectedIndex].value}', from: '${target}'\n`;
+          } else if ((el.type == 'radio') && el.checked) {
+            sessionStorage.heavensDoor += `    choose '${el.value}'\n`;
+          } else if ((el.type == 'checkbox') && el.checked) {
+            sessionStorage.heavensDoor += `    check '${el.value}'\n`;
+          }
+        })
+
+        sessionStorage.heavensDoor += `    click_button '${form.querySelector('input[type=submit]').value}'\n\n`;
+      }
+    });
+  })
+
+  Array.from(document.getElementsByTagName('a')).forEach(a => {
+    a.addEventListener('click', e => {
+      if (sessionStorage.heavensDoor) {
+        sessionStorage.heavensDoor += `    click_link '${a.text}'\n\n`;
+      }
+    });
+  })
+})

data/app/assets/stylesheets/heavens_door.css

@@ -0,0 +1 @@
+#heavens-door { position: absolute; top: 0; right: 0; font-size: 13px; cursor: pointer; } #heavens-door-stop,#heavens-door-copy { display: none; }

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "heavens_door"
+
+# 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/heavens_door.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "heavens_door/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "heavens_door"
+  spec.version       = HeavensDoor::VERSION
+  spec.authors       = ["Akira Matsuda"]
+  spec.email         = ["ronnie@dio.jp"]
+
+  spec.summary       = 'The Capybara scenario writer'
+  spec.description   = 'A Rails engine that generates Capybara scenario in the browser'
+  spec.homepage      = 'https://github.com/amatsuda/heavens_door'
+  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", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/heavens_door.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "heavens_door/version"
+require_relative 'heavens_door/engine'

data/lib/heavens_door/engine.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'middleware'
+
+module HeavensDoor
+  class Engine < ::Rails::Engine #:nodoc:
+    initializer 'HeavensDoor' do |app|
+      app.middleware.use HeavensDoor::Middleware
+
+      app.config.assets.precompile += %w(heavens_door.js heavens_door.css)
+    end
+  end
+end

data/lib/heavens_door/middleware.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module HeavensDoor
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      status, headers, body = @app.call env
+
+      if headers && headers['Content-Type']&.include?('text/html') && (env['REQUEST_PATH'] !~ %r[^/*heavens_door/]) &&
+          (!env['action_dispatch.content_security_policy']&.script_src('unsafe-inline') && !env['action_dispatch.content_security_policy']&.style_src('unsafe-inline'))  # the Rails default top page has this
+        case body
+        when ActionDispatch::Response, ActionDispatch::Response::RackBody
+          body = body.body
+        when Array
+          body = body[0]
+        end
+
+        body.sub!(/<\/head[^>]*>/) { %Q[<link rel="stylesheet" href="/assets/heavens_door.css" /><script src="/assets/heavens_door.js"></script>\n#{$~}] }
+        body.sub!(/<body[^>]*>/) { %Q[#{$~}\n<div id="heavens-door"><span id="heavens-door-start">⏺</span><span id="heavens-door-stop">⏹</span><span id="heavens-door-copy">📋</span></div>] }
+
+        [status, headers, [body]]
+      else
+        [status, headers, body]
+      end
+    end
+  end
+end

data/lib/heavens_door/version.rb

@@ -0,0 +1,3 @@
+module HeavensDoor
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: heavens_door
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Akira Matsuda
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-01 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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+description: A Rails engine that generates Capybara scenario in the browser
+email:
+- ronnie@dio.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/heavens_door.js
+- app/assets/stylesheets/heavens_door.css
+- bin/console
+- bin/setup
+- heavens_door.gemspec
+- heavens_door.gif
+- lib/heavens_door.rb
+- lib/heavens_door/engine.rb
+- lib/heavens_door/middleware.rb
+- lib/heavens_door/version.rb
+homepage: https://github.com/amatsuda/heavens_door
+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.0.1
+signing_key: 
+specification_version: 4
+summary: The Capybara scenario writer
+test_files: []