rails_anonymous_controller_testing 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0ff3511ad88aa4643e6fe05a29c518683deab8f4cd8d44489a57a606afb1695d
+  data.tar.gz: 40d7fd0fd19d8170aaeeddadf8fc2738a591c9410182e5248204229b20862a64
+SHA512:
+  metadata.gz: dbc4d3ef652b96729dfe1b4767d1c3167b8f8ca724d7921b764c29d9a6aa663a64230e5e604f00e310e11cb1fb84b1e5d6a887e7219e8e9fcd67419f8e2167a0
+  data.tar.gz: 5cea00b2b62b53c67ab3deb7d6e6c3d061d510c1a46ec6e324cdcca6be06821edd25483bbc27cfbe81321de8d626ebf9c5e4322342ed78c2a5157a2734082ba6

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Zach Ahn
+
+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,104 @@
+# Rails Anonymous Controller Testing
+
+I sometimes want to test an abstract controller, a controller concern, a view,
+or a helper method.
+
+This might be useful for you if you're working on a Rails engine or if you're
+editing your `ApplicationController`.
+
+This only works with Minitest, specifically for tests that inherit from
+`ActionDispatch::IntegrationTest`.
+
+
+## Usage
+
+```ruby
+class MyControllerTest < ActionDispatch::IntegrationTest
+  # 1. Call the `controller` method. You must specify the base controller to
+  #    inherit from. It'll set up routes with `resources :anonymous`.
+  controller(ApplicationController) do
+    def index
+    end
+
+    def show
+      render plain: params[:id]
+    end
+  end
+
+  # 2. Optionally, set views. There are some caveats, see below
+  views["layouts/application.html.erb"] = <<~HTML
+    <h1>My anonymous test</h1>
+    <%= yield %>
+  HTML
+
+  views["index.html.erb"] = <<~HTML
+    <h2>Hi</h2>
+  HTML
+
+  # 3. Test like it's a regular controller in your application
+  def test_index
+    get "/anonymous"
+    assert_select "h1", "My anonymous test"
+    assert_select "h2", "Hi"
+  end
+
+  def test_show
+    get "/anonymous/1234"
+    assert_equal "1234", response.body
+  end
+end
+```
+
+You can also specify the routes too, but you need to namespace the controller to
+the name of the test class.
+
+```ruby
+class MyControllerTest < ActionDispatch::IntegrationTest
+  routes = -> { get "custom", to: "my_controller_test/anonymous#custom" }
+  controller(ApplicationController, routes: routes) do
+    def custom
+    end
+  end
+end
+```
+
+
+### Views
+
+A few things to note about views:
+
+* Views are generated only once and cached. This is determined by the MD5 hash
+  of the test **file** you defined the **controller**. You can disable caching
+  by calling `disable_anonymous_view_cache!` in your Rails test. The view cache
+  is located in `tmp/anonymous_controller_views`.
+* If you override the layout for your anonymous controller, you'll also override
+  the layout for your other controllers. This is because this library uses
+  `prepend_view_path`, so the views defined in the test take precedence over the
+  other view directories.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rails_anonymous_controller_testing", group: :test
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+
+## Contributing
+
+Contributions very welcome. Please give me edit access to your branch for a
+faster turnaround.
+
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/lib/rails_anonymous_controller_testing.rb

@@ -0,0 +1,5 @@
+require "digest/md5"
+require "thread"
+
+require "rails_anonymous_controller_testing/version"
+require "rails_anonymous_controller_testing/railtie"

data/lib/rails_anonymous_controller_testing/railtie.rb

@@ -0,0 +1,109 @@
+class RailsAnonymousControllerTesting::Railtie < ::Rails::Railtie
+  initializer "rails_anonymous_controller_testing" do
+    ActiveSupport.on_load(:action_dispatch_integration_test) do
+      ANONYMOUS_PATH_MUTEX = Mutex.new
+
+      def self._anonymous_view_base_path
+        @_anonymous_view_base_path ||= Rails.root.join("tmp", "anonymous_controller_views")
+      end
+
+      def self.anonymous_view_base_path=(value)
+        @_anonymous_view_base_path = value
+      end
+
+      def self._anonymous_view_path
+        if instance_variable_defined?(:@_anonymous_view_path)
+          return @_anonymous_view_path
+        end
+
+        caller_path = caller_locations(1, 10).find { |location| location.absolute_path != __FILE__ }.absolute_path
+        @_anonymous_view_path = _anonymous_view_base_path.join(Digest::MD5.file(caller_path).hexdigest)
+      end
+
+      def self._anonymous_controller_name
+        @_anonymous_controller_name ||= "AnonymousController"
+      end
+
+      def self._anonymous_view_cache?
+        if instance_variable_defined?(:@_anonymous_view_cache)
+          @_anonymous_view_cache
+        end
+
+        @_anonymous_view_cache = true
+      end
+
+      def self.disable_anonymous_view_cache!
+        @_anonymous_view_cache = false
+      end
+
+      def self.enable_anonymous_view_cache!
+        @_anonymous_view_cache = true
+      end
+
+      def self.views
+        @_anonymous_views ||= {}
+      end
+
+      def self.views=(value)
+        @_anonymous_views = value
+      end
+
+      def self.controller(base_controller, routes: nil, &block)
+        anonymous_view_path = _anonymous_view_path
+        anonymous_controller_name = _anonymous_controller_name
+
+        # Define the controller
+        anonymous_controller_class = Class.new(base_controller) do
+          prepend_view_path(anonymous_view_path)
+
+          define_singleton_method(:name) do
+            anonymous_controller_name
+          end
+        end
+        anonymous_controller_class.class_exec(&block)
+
+        # Attach the controller to the test class
+        const_set(anonymous_controller_name, anonymous_controller_class)
+
+        setup do
+          # Set up the routes
+          if !routes
+            resource_name = anonymous_controller_class.controller_name.to_sym
+            resource_module = self.class.name.underscore
+
+            routes = proc do
+              resources(resource_name, module: resource_module)
+            end
+          end
+
+          # Rails.application.routes.draw(&routes)
+          Rails.application.routes.send(:eval_block, routes)
+
+          # Set up the views
+          ANONYMOUS_PATH_MUTEX.synchronize do
+            next if self.class.views.empty?
+            next if self.class._anonymous_view_cache? && anonymous_view_path.exist?
+            anonymous_view_path.mkpath
+
+            self.class.views.each do |basename, contents|
+              viewpath = anonymous_view_path.join(basename)
+              if viewpath.dirname == anonymous_view_path
+                viewpath = anonymous_view_path.join(anonymous_controller_class.controller_name, basename)
+              end
+
+              next if self.class._anonymous_view_cache? && viewpath.exist?
+
+              viewpath.dirname.mkpath
+              viewpath.write(contents)
+            end
+          end
+        end
+
+        teardown do
+          # Reset the routes to its original state
+          Rails.application.reload_routes!
+        end
+      end
+    end
+  end
+end

data/lib/rails_anonymous_controller_testing/version.rb

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

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: rails_anonymous_controller_testing
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Zach Ahn
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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
+    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: Rails test helpers for testing anonymous controllers (Minitest only!)
+email:
+- engineering@zachahn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/rails_anonymous_controller_testing.rb
+- lib/rails_anonymous_controller_testing/railtie.rb
+- lib/rails_anonymous_controller_testing/version.rb
+homepage: https://github.com/zachahn/rails_anonymous_controller_testing
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/zachahn/rails_anonymous_controller_testing
+  source_code_uri: https://github.com/zachahn/rails_anonymous_controller_testing
+  changelog_uri: https://github.com/zachahn/rails_anonymous_controller_testing/blob/main/CHANGELOG.md
+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.2.15
+signing_key:
+specification_version: 4
+summary: Rails test helpers for testing anonymous controllers (Minitest only!)
+test_files: []