fix and improve table DSL

Author: senid231

CHANGELOG.md

@@ -5,14 +5,24 @@ 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]
+### Fixed
+ - `table_selector`, `within_table_for` incorrect resource name
 
-## [0.2.0] - 2020-04-14
-### Breaking change
- - rename #have_table_col to #have_table_cell
- - change options of #have_table_cell
- - change options of #have_table_row
+### Changed
+ - `table_selector` receives 2 arguments
+ - `within_table_for` receives 2 arguments
+ - `current_table_name` renamed to `current_table_model_name`
+ - `table_row_selector` can receive modal class as model name
+ 
+# Added
+ - `have_table` matcher
+ - add tests for table with namespaced resource class and multi-word resource name
 
-### Change
+## [0.2.0] - 2020-04-14
+### Changed
+ - rename `have_table_col` to `have_table_cell`
+ - change options of `have_table_cell`
+ - change options of `have_table_row`
  - refactor modules hierarchy: split DSL into selectors, finders, matchers and actions
 
 ### Added

lib/capybara/active_admin/finders/table.rb

@@ -4,21 +4,23 @@ module Capybara
   module ActiveAdmin
     module Finders
       module Table
-        def current_table_name
-          @__current_table_name
+        def current_table_model_name
+          @__current_table_model_name
         end
 
-        def within_table_for(name)
-          name = name.model_name.plural if name.is_a?(Class)
-          selector = table_selector(name)
+        # @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)
+          selector = table_selector(resource_name)
 
           within(selector) do
-            old = @__current_table_name
-            @__current_table_name = name
+            old = @__current_table_model_name
+            @__current_table_model_name = model_name
             begin
               yield
             ensure
-              @__current_table_name = old
+              @__current_table_model_name = old
             end
           end
         end
@@ -33,12 +35,12 @@ def find_table_row(id: nil, index: nil)
           raise ArgumentError, 'must provide :id or :index' if id.nil? && index.nil?
 
           if id
-            model = @__current_table_name
-            selector = table_row_selector(model, id)
+            selector = table_row_selector(current_table_model_name, id)
             return find(selector)
           end
 
-          find_all(table_row_selector(nil, nil), minimum: index + 1)[index]
+          selector = table_row_selector(nil, nil)
+          find_all(selector, minimum: index + 1)[index]
         end
 
         def within_table_cell(name)

lib/capybara/active_admin/matchers/table.rb

@@ -4,6 +4,19 @@ module Capybara
   module ActiveAdmin
     module Matchers
       module Table
+        # @param options [Hash]
+        #   :resource_name [String, nil] active admin page resource name
+        #   for other options @see Capybara::RSpecMatchers#have_selector
+        # @example
+        #   expect(page).to have_table
+        #   expect(page).to have_table(resource_name: 'users')
+        #
+        def have_table(options = {})
+          resource_name = options.delete(:resource_name)
+          selector = table_selector(resource_name)
+          have_selector(selector, options)
+        end
+
         # @param options [Hash]
         #   :text [String, nil] cell content
         #   :id [String, Number, nil] record ID
@@ -15,7 +28,7 @@ module Table
         #
         def have_table_row(options = {})
           row_id = options.delete(:id)
-          selector = table_row_selector(current_table_name, row_id)
+          selector = table_row_selector(current_table_model_name, row_id)
           have_selector(selector, options)
         end
 

lib/capybara/active_admin/selectors/table.rb

@@ -4,26 +4,29 @@ module Capybara
   module ActiveAdmin
     module Selectors
       module Table
-        def table_selector(model)
-          return 'table.index_table' if model.nil?
+        def table_selector(resource_name)
+          return 'table.index_table' if resource_name.nil?
 
-          "table.index_table#index_table_#{model.to_s.pluralize}"
+          resource_name = resource_name.to_s.gsub(' ', '_').pluralize.downcase
+          "table#index_table_#{resource_name}"
         end
 
-        def table_row_selector(model, record_id)
+        def table_row_selector(model_name, record_id)
           return 'tbody > tr' if record_id.nil?
 
-          "tbody > tr##{model.to_s.singularize}_#{record_id}"
+          model_name = model_name.model_name.singular if model_name.is_a?(Class)
+          model_name = model_name.to_s.gsub(' ', '_').singularize.downcase
+          "tbody > tr##{model_name}_#{record_id}"
         end
 
         def table_header_selector
           'thead > tr > th.col'
         end
 
         def table_cell_selector(column)
-          column = column.to_s.gsub(' ', '_').downcase unless column.nil?
           return 'td.col' if column.nil?
 
+          column = column.to_s.gsub(' ', '_').downcase
           "td.col.col-#{column}"
         end
       end

spec/dummy/test_application.rb

@@ -24,6 +24,12 @@
     t.string :full_name
     t.timestamps
   end
+
+  create_table :employees, force: true do |t|
+    t.string :full_name
+    t.decimal :salary
+    t.timestamps
+  end
 end
 
 require 'action_controller/railtie'
@@ -85,6 +91,13 @@ class User < ActiveRecord::Base
   validates :full_name, presence: true
 end
 
+module Billing
+  class Employee < ActiveRecord::Base
+    validates :full_name, presence: true
+    validates :salary, numericality: { greater_than_or_equal_to: 0.01 }
+  end
+end
+
 ActiveAdmin.setup do |config|
   # Disabling authentication in specs so that we don't have to worry about
   # it allover the place
@@ -105,6 +118,10 @@ class User < ActiveRecord::Base
   permit_params :full_name
 end
 
+ActiveAdmin.register Billing::Employee, as: 'Business Employee' do
+  permit_params :full_name, :salary
+end
+
 Rails.application.routes.draw do
   ActiveAdmin.routes(self)
 end

spec/system/business_employees_index_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+RSpec.describe 'Business Employees index', js: true do
+  subject do
+    visit admin_business_employees_path
+  end
+
+  it 'checks elements on empty users page' do
+    subject
+
+    expect(page).to have_text('There are no Business Employees yet.')
+    expect(page).to have_action_item('New Business Employee')
+    expect(page).to_not have_action_item('Edit Business Employee')
+  end
+
+  it 'clicks on New resource_name: ' do
+    subject
+
+    click_action_item('New Business Employee')
+    expect(page).to have_current_path(new_admin_business_employee_path)
+  end
+
+  it 'finds data in table' do
+    john = Billing::Employee.create!(full_name: 'John Doe', salary: 100)
+    jane = Billing::Employee.create!(full_name: 'Jane Air', salary: 101)
+    subject
+
+    expect(page).to have_table
+    expect(page).to have_table(resource_name: 'Business Employees')
+    within_table_for(Billing::Employee) do
+      expect(page).to have_table_row(count: 2)
+      expect(page).to have_table_cell(count: 12) # 2x id, full_name, salary, created_at, updated_at, actions
+
+      expect(page).to have_table_cell(text: 'John Doe')
+      expect(page).to have_table_cell(text: 'John Doe', column: 'Full Name')
+      expect(page).to_not have_table_cell(text: 'John Doe', column: 'Id')
+
+      within_table_row(id: john.id) do
+        expect(page).to have_table_cell(count: 6) # id, full_name, salary, created_at, updated_at, actions
+        expect(page).to have_table_cell(text: 'John Doe')
+        expect(page).to have_table_cell(text: 'John Doe', column: 'Full Name')
+        expect(page).to have_table_cell(text: '100', column: 'Salary')
+        expect(page).to_not have_table_cell(text: 'John Doe', column: 'Id')
+      end
+
+      within_table_row(id: jane.id) do
+        expect(page).to have_table_cell(count: 6) # id, full_name, salary created_at, updated_at, actions
+        expect(page).to have_table_cell(text: jane.id, column: 'Id')
+        expect(page).to have_table_cell(text: 'Jane Air', column: 'Full Name')
+        expect(page).to have_table_cell(text: '101', column: 'Salary')
+        expect(page).to_not have_table_cell(text: 'John Doe')
+        expect(page).to_not have_table_cell(text: 'John Doe', column: 'Full Name')
+      end
+    end
+    # take_screenshot
+  end
+end

spec/system/users_index_spec.rb

@@ -11,6 +11,8 @@
     expect(page).to have_text('There are no Users yet.')
     expect(page).to have_action_item('New User')
     expect(page).to_not have_action_item('Edit User')
+    expect(page).to_not have_table
+    expect(page).to_not have_table(resource_name: 'Users')
   end
 
   it 'clicks on New User' do
@@ -25,7 +27,9 @@
     jane = User.create!(full_name: 'Jane Air')
     subject
 
-    within_table_for('users') do
+    expect(page).to have_table
+    expect(page).to have_table(resource_name: 'Users')
+    within_table_for(User) do
       expect(page).to have_table_row(count: 2)
       expect(page).to have_table_cell(count: 10) # 2x id, full_name, created_at, updated_at, actions
 
@@ -52,9 +56,9 @@
   end
 
   # TODO: filters expect to have
-  # todo filters fill and click
-  # todo breadcrumbs expect to have
-  # todo breadcrumbs click
-  # todo menu items expect to have
-  # todo menu items click
+  # TODO: filters fill and click
+  # TODO: breadcrumbs expect to have
+  # TODO: breadcrumbs click
+  # TODO: menu items expect to have
+  # TODO: menu items click
 end