rails_anonymous_controller_testing 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ff3511ad88aa4643e6fe05a29c518683deab8f4cd8d44489a57a606afb1695d
-  data.tar.gz: 40d7fd0fd19d8170aaeeddadf8fc2738a591c9410182e5248204229b20862a64
+  metadata.gz: 806ed4f101b16a4baade5b23b7af947809fa5f7e2d070001437ae44b5b2d4dc7
+  data.tar.gz: 5461ffdf99fd003cb1e5e345e6a127cfaa0f96c4f7f655dcf7518a1934c584ba
 SHA512:
-  metadata.gz: dbc4d3ef652b96729dfe1b4767d1c3167b8f8ca724d7921b764c29d9a6aa663a64230e5e604f00e310e11cb1fb84b1e5d6a887e7219e8e9fcd67419f8e2167a0
-  data.tar.gz: 5cea00b2b62b53c67ab3deb7d6e6c3d061d510c1a46ec6e324cdcca6be06821edd25483bbc27cfbe81321de8d626ebf9c5e4322342ed78c2a5157a2734082ba6
+  metadata.gz: 148a834923806eeb61ffb38fb561f3a0f0596b94aacdc9d4910541b92fcd18b0fa9fdb383c031305dfce4123ffcdc4d3195bfb8a99ee6cd6dcda691a67724615
+  data.tar.gz: 6989348f767f3497142d64df8de6b56f159b050f6899b9ad7d9b3ea7348831dea4bfbbba0923f671c8d20f3a5309a485689513b2b8fd17096c01bc6e0be56270

data/README.md

@@ -12,6 +12,9 @@ This only works with Minitest, specifically for tests that inherit from
 
 ## Usage
 
+Here's a relatively straightforward example. There are a few caveats you might
+need to keep in mind for more complicated cases; see the Caveats section below.
+
 ```ruby
 class MyControllerTest < ActionDispatch::IntegrationTest
   # 1. Call the `controller` method. You must specify the base controller to
@@ -25,7 +28,8 @@ class MyControllerTest < ActionDispatch::IntegrationTest
     end
   end
 
-  # 2. Optionally, set views. There are some caveats, see below
+  # 2. Optionally, set views. You can set the layout for your anonymous
+  #    controller too.
   views["layouts/application.html.erb"] = <<~HTML
     <h1>My anonymous test</h1>
     <%= yield %>
@@ -63,18 +67,23 @@ end
 ```
 
 
-### Views
+### Caveats
 
-A few things to note about views:
+A few things to note
 
-* 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.
+* You can only define **one** `controller do` per test class. But you can get
+  around this limitation by defining another test class in one file.
+* Views are generated only once and cached. The cache key is determined by MD5
+  hashing the test file contents, and test file path, and the line number of the
+  `controller do`.
+* You can disable the view cache by calling `disable_anonymous_view_cache!` on
+  your test class. This doesn't get around the limitation of having just one
+  `controller do` definition in your test class.
+* The view cache is located in `tmp/anonymous_controller_views` and can be
+  cleared anytime
+* Setting a custom layout will only affect your anonymous controller. This gem
+  does not provide any way to affect the behavior of existing controllers
+  defined by your Rails application or engine
 
 
 ## Installation

data/lib/rails_anonymous_controller_testing/railtie.rb

@@ -1,5 +1,5 @@
 class RailsAnonymousControllerTesting::Railtie < ::Rails::Railtie
-  initializer "rails_anonymous_controller_testing" do
+  config.before_initialize do
     ActiveSupport.on_load(:action_dispatch_integration_test) do
       ANONYMOUS_PATH_MUTEX = Mutex.new
 
@@ -11,19 +11,14 @@ class RailsAnonymousControllerTesting::Railtie < ::Rails::Railtie
         @_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_controller_name=(value)
+        @_anonymous_controller_name = value
+      end
+
       def self._anonymous_view_cache?
         if instance_variable_defined?(:@_anonymous_view_cache)
           @_anonymous_view_cache
@@ -48,8 +43,28 @@ class RailsAnonymousControllerTesting::Railtie < ::Rails::Railtie
         @_anonymous_views = value
       end
 
-      def self.controller(base_controller, routes: nil, &block)
-        anonymous_view_path = _anonymous_view_path
+      def self.controller(base_controller, routes: nil, controller_name: "AnonymousController", &block)
+        caller_location = caller_locations(1, 10).find { |location| location.absolute_path != __FILE__ }
+
+        display_name =
+          if caller_location
+            "#{caller_location.absolute_path.split("/").last.split(".").first}_#{caller_location.lineno}"
+          else
+            "path_unknown"
+          end
+
+        unique_identifier =
+          if caller_location
+            Digest::MD5
+              .file(caller_location.absolute_path)
+              .tap { |d| d << caller_location.absolute_path }
+              .tap { |d| d << caller_location.lineno.to_s }
+          else
+            SecureRandom.hex
+          end
+
+        anonymous_view_path = _anonymous_view_base_path.join("#{display_name}_#{unique_identifier}")
+        self._anonymous_controller_name = controller_name
         anonymous_controller_name = _anonymous_controller_name
 
         # Define the controller
@@ -66,6 +81,8 @@ class RailsAnonymousControllerTesting::Railtie < ::Rails::Railtie
         const_set(anonymous_controller_name, anonymous_controller_class)
 
         setup do
+          Rails.application.reload_routes!
+
           # Set up the routes
           if !routes
             resource_name = anonymous_controller_class.controller_name.to_sym
@@ -76,7 +93,6 @@ class RailsAnonymousControllerTesting::Railtie < ::Rails::Railtie
             end
           end
 
-          # Rails.application.routes.draw(&routes)
           Rails.application.routes.send(:eval_block, routes)
 
           # Set up the views

data/lib/rails_anonymous_controller_testing/version.rb

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

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rails_anonymous_controller_testing
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.5
 platform: ruby
 authors:
 - Zach Ahn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-01 00:00:00.000000000 Z
+date: 2021-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  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