rails-intest-views 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b1d491795e9f51c9bb4aba566876020a7662989a48ce86c915d047b03ed15f76
+  data.tar.gz: bf1e538af19e4bce5a0a2f2db8b0d9ba01a609f8e353be9048a20cbac0a23112
+SHA512:
+  metadata.gz: 9845f89fdaf2a4c9792ad6e2ca98878d73a10aed228cdbd1efb695bad0d8246ea7d8647a9f4853e179ffc37bc581a9f85c6b49b9ea482d1951a4fc8d806e4861
+  data.tar.gz: 71a9610b7019d34b900435e76b8f7b21bb87b34ed32c97183254221e2ad00a1e1e0866fd894c43034966dbd1576e36ecc4bdc05c4c01fa70b2984ec08ffca720

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change log
+
+## master
+
+## 0.1.0 (2023-11-09)
+
+- Initial release. ([@palkan][])
+
+[@palkan]: https://github.com/palkan

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2023 Vladimir Dementyev
+
+MIT License
+
+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,102 @@
+[![Gem Version](https://badge.fury.io/rb/rails-intest-views.svg)](https://rubygems.org/gems/rails-intest-views)
+[![Build](https://github.com/palkan/rails-intest-views/workflows/Build/badge.svg)](https://github.com/palkan/rails-intest-views/actions)
+
+# Rails Intest Views
+
+Generate test views (templates) right from test files. Useful to test UI components (view components, partials, JS, etc.) in isolation.
+
+A quick example of using an inline template to test view components via Rails system tests:
+
+```ruby
+class ButtonComponentSystemTest < ApplicationSystemTestCase
+  def test_submit_button
+    visit_template <<~ERB
+      <form id="myForm" onsubmit="event.preventDefault(); this.innerHTML = '';">
+        <h2>Self-destructing form</h2>
+        <%= render ButtonComponent.new(type: :submit) do %>
+          Save me!
+        <% end %>
+      </form>
+    ERB
+
+    assert_text("Self-destructing form")
+
+    click_button("Save me!")
+
+    assert_no_text("Self-destructing form")
+  end
+end
+```
+
+## Installation
+
+Adding gem to your Gemfile:
+
+```ruby
+# Gemfile
+gem "rails-intest-views", group: :test
+```
+
+### Supported Ruby/Rails versions
+
+- Ruby (MRI) >= 2.7.0
+- Rails 6+
+
+## Usage
+
+To use intest templates with Capybara, you must first include the helper module:
+
+```ruby
+# Minitest
+class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+ include RailsIntestViews::CapybaraHelpers
+
+  # ...
+end
+
+# RSpec
+RSpec.configure do |config|
+  config.include RailsIntestViews::CapybaraHelpers, type: :system
+end
+```
+
+Then, you can use the `#visit_template` helper in your tests:
+
+```ruby
+visit_template <<~ERB
+  <a href="#">Clicko!</a>
+ERB
+
+# some assertions/expectations
+```
+
+You can also specify the layout to use:
+
+```ruby
+source = <<~ERB
+  <a href="#">Clicko!</a>
+ERB
+
+visit_template source, layout: "custom"
+```
+
+### Configuration
+
+The following configuration parameters are available (the default values are shown):
+
+```ruby
+# a controller class used to render templates
+config.rails_intest_views.templates_controller = "RailsIntestViews::TemplatesController"
+# default layout to use; no layout by default (but you're likely to specify it to load scripts, styles, etc.)
+config.rails_intest_views.default_layout = nil
+# the mount path for the endpoint (the "/templates/:id" is added to the final URL)
+config.rails_intest_views.mount_path = "/rails/intest"
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/palkan/rails-intest-views](https://github.com/palkan/rails-intest-views).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/rails-intest-views/capybara_helpers.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RailsIntestViews
+  module CapybaraHelpers
+    def visit_template(source, **options)
+      id = RailsIntestViews.write(source, **options)
+      visit RailsIntestViews.url_for(id)
+    end
+  end
+end

data/lib/rails-intest-views/engine.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module RailsIntestViews # :nodoc:
+  class Engine < ::Rails::Engine # :nodoc:
+    config.rails_intest_views = RailsIntestViews.config
+
+    config.after_initialize do |app|
+      options = app.config.rails_intest_views
+
+      app.routes.prepend do
+        templates_controller = options.templates_controller.sub(/Controller$/, "").underscore
+
+        get(
+          File.join(options.mount_path, ":id"),
+          to: "#{templates_controller}#show",
+          as: :rails_intest_view,
+          internal: true
+        )
+      end
+    end
+  end
+end

data/lib/rails-intest-views/request_helpers.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RailsIntestViews
+  module RequestHelpers
+    def get_template(source, **options)
+      id = RailsIntestViews.write(source, **options)
+      get RailsIntestViews.url_for(id)
+    end
+  end
+end

data/lib/rails-intest-views/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RailsIntestViews # :nodoc:
+  VERSION = "0.0.1"
+end

data/lib/rails-intest-views.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "mutex_m"
+
+module RailsIntestViews
+  class Configuration
+    attr_accessor :templates_controller, :default_layout, :mount_path
+
+    def initialize
+      @mount_path = "/rails/intest"
+      @templates_controller = "RailsIntestViews::TemplatesController"
+      @default_layout = nil
+    end
+  end
+
+  class << self
+    @@mutex = Mutex.new
+    @@store = {}
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def find(id)
+      @@mutex.synchronize do
+        @@store[id]
+      end
+    end
+
+    def write(template, **options)
+      id = nil
+      attempts = 5
+      catch(:done) do
+        loop do
+          id = SecureRandom.hex(6)
+
+          @@mutex.synchronize do
+            if @@store[id]
+              attempts -= 1
+              id = nil
+              throw :done if attempts < 0
+              next
+            else
+              @@store[id] = {template: template, **options}
+              throw :done
+            end
+          end
+        end
+      end
+
+      raise "Failed to write template" if id.nil?
+      id
+    end
+
+    def url_for(id)
+      File.join(config.mount_path, id)
+    end
+  end
+
+  autoload :RequestHelpers, "rails-intest-views/request_helpers"
+  autoload :CapybaraHelpers, "rails-intest-views/capybara_helpers"
+end
+
+require "rails-intest-views/version"
+require "rails-intest-views/engine" if defined?(Rails::Engine)

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: rails-intest-views
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vladimir Dementyev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !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: minitest-focus
+  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: minitest-reporters
+  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'
+description: Generate view templates dynamically in Rails tests
+email:
+- Vladimir Dementyev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/rails-intest-views.rb
+- lib/rails-intest-views/capybara_helpers.rb
+- lib/rails-intest-views/engine.rb
+- lib/rails-intest-views/request_helpers.rb
+- lib/rails-intest-views/version.rb
+homepage: https://github.com/palkan/rails-intest-views
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/palkan/rails-intest-views/issues
+  changelog_uri: https://github.com/palkan/rails-intest-views/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/palkan/rails-intest-views
+  homepage_uri: https://github.com/palkan/rails-intest-views
+  source_code_uri: https://github.com/palkan/rails-intest-views
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: Generate view templates dynamically in Rails tests
+test_files: []