remove model_name from table related DSL arguments, improve API

Author: senid231

CHANGELOG.md

@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Changed
+ - remove model_name from table related DSL arguments
+ - improve API
 
 ## [0.3.1] - 2020-04-15
 ### Added

lib/capybara/active_admin/actions/layout.rb

@@ -3,6 +3,7 @@
 module Capybara
   module ActiveAdmin
     module Actions
+      # Actions for common Active Admin components.
       module Layout
         def click_action_item(title, options = {})
           within(action_items_container_selector) do

lib/capybara/active_admin/finders.rb

@@ -7,9 +7,12 @@
 
 module Capybara
   module ActiveAdmin
+    # Finders are methods that find DOM element(s) or change current scope to node element.
+    #
+    # Find element(s) method names should start with *find_*.
+    #
+    # Change current scope method names should start with *within_*.
     module Finders
-      # Finders are methods that find node element(s) or change current scope to node element.
-
       include Finders::Layout
       include Finders::Table
       include Finders::AttributesTable

lib/capybara/active_admin/finders/attributes_table.rb

@@ -3,15 +3,21 @@
 module Capybara
   module ActiveAdmin
     module Finders
+      # Finder methods for ActiveAdmin attributes_table_for can be found here.
+      # @see Capybara::ActiveAdmin::Finders base finders module.
       module AttributesTable
-        # @param model_name [Class<Object>, nil] model name or class.
-        # @param record_id [String, Numeric, nil]
-        # @yield within attributes table
-        def within_attributes_table_for(model_name, record_id = nil)
-          selector = attributes_table_selector(model_name, record_id)
+        # Calls block within attributes table.
+        # @param model [Class<Object>, nil] model name or class.
+        # @param id [String, Numeric, nil] record ID.
+        # @yield within attributes table.
+        def within_attributes_table_for(model: nil, id: nil)
+          selector = attributes_table_selector(model: model, id: id)
           within(selector) { yield }
         end
 
+        # Calls block within attributes table row.
+        # @param label [String] row label.
+        # @yield within attributes table.
         def within_attribute_row(label)
           selector = attributes_row_selector(label)
           within(selector) { yield }

lib/capybara/active_admin/finders/form.rb

@@ -3,17 +3,17 @@
 module Capybara
   module ActiveAdmin
     module Finders
+      # Finders for *active_admin_form_for* and related form components.
       module Form
-        # @param name [Class<Object>, String] form record class or model name
+        # @param model_name [Class<Object>, String, nil] form record class or model name (default nil).
         # @yield within form
-        def within_form_for(name)
-          name = name.model_name.singular if name.is_a?(Class)
-          selector = form_selector(name)
+        def within_form_for(model_name = nil)
+          selector = form_selector(model_name)
           within(selector) { yield }
         end
 
         # @param association_name [String]
-        # @param index [String] index of fieldset, starts with 0.
+        # @param index [String] index of fieldset, starts with 0 (default 0).
         # @yield within fieldset>ol
         def within_form_has_many(association_name, index: 0)
           selector = has_many_fields_selector(association_name)
@@ -22,6 +22,7 @@ def within_form_has_many(association_name, index: 0)
           within(fieldset) { yield }
         end
 
+        # @yield within filters container.
         def within_filters
           selector = filter_form_selector
           within(selector) { yield }

lib/capybara/active_admin/finders/layout.rb

@@ -3,6 +3,7 @@
 module Capybara
   module ActiveAdmin
     module Finders
+      # Finders for common Active Admin components.
       module Layout
         def find_footer(options = {})
           selector = footer_selector

lib/capybara/active_admin/finders/table.rb

@@ -3,26 +3,14 @@
 module Capybara
   module ActiveAdmin
     module Finders
+      # Finders for *table_for*, it's rows and cells.
       module Table
-        def current_table_model_name
-          @__current_table_model_name
-        end
-
-        # @param model_name [Class<#model_name>, String] records class or model name to match rows.
         # @param resource_name [String, nil] resource name of index page.
         # @yield within table
-        def within_table_for(model_name, resource_name = nil)
+        def within_table_for(resource_name = nil)
           selector = table_selector(resource_name)
 
-          within(selector) do
-            old = @__current_table_model_name
-            @__current_table_model_name = model_name
-            begin
-              yield
-            ensure
-              @__current_table_model_name = old
-            end
-          end
+          within(selector) { yield }
         end
 
         # id [String, Integer, nil] record ID.
@@ -38,11 +26,11 @@ def find_table_row(id: nil, index: nil)
           raise ArgumentError, 'must provide :id or :index' if id.nil? && index.nil?
 
           if id
-            selector = table_row_selector(current_table_model_name, id)
+            selector = table_row_selector(id)
             return find(selector)
           end
 
-          selector = table_row_selector(nil, nil)
+          selector = table_row_selector(nil)
           find_all(selector, minimum: index + 1)[index]
         end
 

lib/capybara/active_admin/matchers/attributes_table.rb

@@ -5,9 +5,9 @@ module ActiveAdmin
     module Matchers
       module AttributesTable
         def have_attributes_table(options = {})
-          model_name = options.delete(:model)
-          record_id = options.delete(:id)
-          selector = attributes_table_selector(model_name, record_id)
+          model = options.delete(:model)
+          id = options.delete(:id)
+          selector = attributes_table_selector(model: model, id: id)
           have_selector(selector, options)
         end
 

lib/capybara/active_admin/matchers/layout.rb

@@ -3,6 +3,7 @@
 module Capybara
   module ActiveAdmin
     module Matchers
+      # Matchers for common Active Admin components.
       module Layout
         def have_action_item(text, options = {})
           opts = Util.options_with_text(text, options)

lib/capybara/active_admin/matchers/table.rb

@@ -29,7 +29,7 @@ def have_table(options = {})
         #
         def have_table_row(options = {})
           row_id = options.delete(:id)
-          selector = table_row_selector(current_table_model_name, row_id)
+          selector = table_row_selector(row_id)
           have_selector(selector, options)
         end