importmap_mocha-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 11365cfee72382ffbf5e419f2c8a197adb2fe8d327d4c6b2350448fd09be05e6
+  data.tar.gz: c557c7151e4957c2993542bd3cd62816564f65c896676bd0e0494569c50879ec
+SHA512:
+  metadata.gz: 73912e0a9e2c03310ac7526a842ac99c669fe59b5517bc0c5ede105a96063e106f74f1c1f11b1a646c409b9704d1e036e35b79474582b0f37eeabfcea43ed555
+  data.tar.gz: 7c5c02c7edd5fc9b5772c47635d503119b9ada153e9e6170bc40850e2807fd5859f152899604921d572bcf9dac49ffbec6c5d0a25e04b2cbb4285f15582ab7e4

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2023 Takashi Kato <tohosaku@users.osdn.me>
+
+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,99 @@
+# importmap_mocha-rails
+
+This plugin makes it easy to test ES modules with [importmap-rails](https://github.com/rails/importmap-rails) when using Rails 7 or later. It integrates the [Mocha](https://mochajs.org/) JavaScript testing library (using [Chai](https://www.chaijs.com/) as the assertion library) and runs tests for ES modules delivered with importmap in the browser.
+
+# Installation
+
+Assuming you have already installed importmap-rails with Rails 7, add the following to your Gemfile and run `bundle install`.
+
+```ruby
+group :test, :development do
+  gem 'importmap_mocha-rails'
+end
+```
+
+# Usage
+
+Write your JavaScript tests in `test/javascripts` or `spec/javascripts`. One-to-one tests are named foo.test.js for a module named foo.js. Access `http://localhost:3000/rails/info/mocha` in the Rails testing or development environment to view the test results.
+
+By default, importmap-rails manages ES modules under `app/javascript`, `app/assets/javascripts`, and `vendor/javascripts`.
+
+# Example
+
+controllers/clear_controller.js
+
+```javascript
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+
+  static targets = ["clear"];
+
+  clear(e) {
+    this.clearTargets.forEach(o => { o.value = ''});
+  }
+}
+```
+
+controllers/clear_controller.test.js
+
+```javascript
+import { Application } from "@hotwired/stimulus"
+import ClearController from 'controllers/clear_controller'
+
+const html = `<div data-controller="clear">
+  <input id="target" type="text" value="foo" data-clear-target="clear">
+  <button data-action="clear#clear">test</button>
+  </div>`
+
+const config = { attributes: true, childList: true, subtree: true };
+
+// test!! test!!
+describe('clear_controller', () => {
+
+  let container;
+
+  beforeEach(() => {
+    container = document.getElementById('container')
+    container.insertAdjacentHTML('afterbegin', html)
+  });
+
+  afterEach(() => {
+    const clone = container.cloneNode(false);
+    container.parentNode.replaceChild(clone, container);
+  });
+
+  const watch = (fn) => {
+    const observer = new MutationObserver(fn);
+    observer.observe(container, config);
+  }
+
+  describe('click', () => {
+    it('The value of input element is cleard', () => {
+      const app = Application.start();
+      app.register('clear', ClearController);
+
+      const target = container.querySelector('#target');
+
+      watch(() => target.value.to.equal(''));
+
+      const button = container.querySelector('button');
+      button.click()
+    });
+  });
+});
+
+```
+
+# Configuration
+
+* config.importmap_mocha_style: The style of the test code, `"bdd"` or `"tdd"`. Default is `"bdd"`.
+* config.importmap_mocha_path: The location where the test code is stored. Default is `test/javascripts` and `spec/javascripts`.
+
+# Author
+
+Takashi Kato tohosaku@users.osdn.me
+
+# License
+
+MIT

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler/setup'
+
+require 'bundler/gem_tasks'

data/app/controllers/importmap_mocha/test_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ImportmapMocha
+  class TestController < ActionController::Base
+    layout false
+
+    def index; end
+  end
+end

data/app/helpers/importmap_mocha/test_helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ImportmapMocha
+  module TestHelper
+    PATTERN = ['**/*.test.js', '**/*.spec.js'].freeze
+
+    def testcase
+      files.map { |m| javascript_import_module_tag(m.to_s.sub('.js', '')) }.join("\n").html_safe
+    end
+
+    def files
+      root_path.flat_map { |path| path.glob(PATTERN).map { |m| m.relative_path_from(path) } }
+    end
+
+    def root_path
+      Rails.application.config.importmap_mocha_path
+    end
+  end
+end

data/app/views/importmap_mocha/test/index.html.erb

@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<meta charset="utf-8" />
+<title>Results of test execution </title>
+<%= javascript_include_tag 'mocha', 'chai' %>
+<%= stylesheet_link_tag 'mocha' %>
+<%= javascript_importmap_tags 'importmap_mocha' %>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+  <script>
+    mocha.setup('<%= Rails.application.config.importmap_mocha_style %>');
+  </script>
+</head>
+<body>
+  <%= testcase %>
+  <div id="main">
+    <div id="content">
+      <div id="container">
+      </div>
+      <div id="mocha">
+      </div>
+    </div>
+  </div>
+<script type="module">
+  mocha.run();
+</script>
+</body>
+</html>

data/config/importmap.rb

@@ -0,0 +1,4 @@
+pin 'importmap_mocha'
+Rails.application.config.importmap_mocha_path.each do |path|
+  pin_all_from path
+end

data/lib/importmap_mocha/engine.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module ImportmapMocha
+  class Engine < ::Rails::Engine
+    config.before_initialize do
+      Rails.application.config.importmap_mocha_path = []
+      %w[test spec].each do |d|
+        path = Rails.root.join(d, 'javascripts')
+        Rails.application.config.importmap_mocha_path << path if path.exist?
+      end
+    end
+
+    initializer 'importmap_mocha.assets' do
+      if Rails.application.config.respond_to?(:assets)
+        Rails.application.config.assets.paths << Engine.root.join('app/assets/javascripts')
+        Rails.application.config.assets.paths << Engine.root.join('app/assets/stylesheets')
+        Rails.application.config.assets.paths << Engine.root.join('vendor/javascripts')
+        Rails.application.config.assets.paths << Engine.root.join('vendor/stylesheets')
+        Rails.application.config.assets.paths += Rails.application.config.importmap_mocha_path
+      end
+    end
+
+    PRECOMPILE_ASSETS = %w[importmap_mocha.js chai.js mocha.js mocha.css].freeze
+
+    initializer 'turbo.assets' do
+      Rails.application.config.assets.precompile += PRECOMPILE_ASSETS if Rails.application.config.respond_to?(:assets)
+    end
+
+    initializer 'importmap_mocha.importmap', before: 'importmap' do |app|
+      app.config.importmap.paths << Engine.root.join('config/importmap.rb') if Rails.application.respond_to?(:importmap)
+    end
+
+    initializer 'importmap_mocha.routes' do
+      Rails.application.routes.prepend do
+        scope module: 'importmap_mocha' do
+          get '/rails/info/mocha' => 'test#index'
+        end
+      end
+    end
+
+    initializer 'importmap_mocha.config' do
+      unless Rails.application.config.respond_to?(:importmap_mocha_style)
+        Rails.application.config.importmap_mocha_style = 'bdd'
+      end
+    end
+  end
+end

data/lib/importmap_mocha/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ImportmapMocha
+  VERSION = '0.1.0'
+end

data/lib/importmap_mocha-rails.rb

@@ -0,0 +1,5 @@
+require 'importmap_mocha/version'
+require 'importmap_mocha/engine'
+
+module ImportmapMocha
+end

data/lib/tasks/importmap_mocha/rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :importmap_mocha_rails do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: importmap_mocha-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takashi Kato
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: Add JavaScript testing tools in importmap environment.
+email:
+- tohosaku@users.osdn.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/importmap_mocha.js
+- app/controllers/importmap_mocha/test_controller.rb
+- app/helpers/importmap_mocha/test_helper.rb
+- app/views/importmap_mocha/test/index.html.erb
+- config/importmap.rb
+- lib/importmap_mocha-rails.rb
+- lib/importmap_mocha/engine.rb
+- lib/importmap_mocha/version.rb
+- lib/tasks/importmap_mocha/rails_tasks.rake
+homepage: https://github.com/tohosaku/importmap_mocha-rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tohosaku/importmap_mocha-rails
+  source_code_uri: https://github.com/tohosaku/importmap_mocha-rails
+  changelog_uri: https://github.com/tohosaku/importmap_mocha-rails
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.5
+signing_key: 
+specification_version: 4
+summary: mochajs rails integration
+test_files: []