improve batch actions

Author: senid231

CHANGELOG.md

@@ -5,6 +5,13 @@ 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
+ - `batch_action_selector`, `click_batch_action` finds element by link text
+
+### Added
+ - `select_table_row`, `open_batch_action_menu` actions
+ - `have_batch_action` matcher
+ - tests for batch actions
 
 ## [0.3.2] - 2020-04-16
 ### Changed

lib/capybara/active_admin/actions.rb

@@ -8,8 +8,8 @@
 module Capybara
   module ActiveAdmin
     module Actions
-      # Actions are interactions with page that change something.
-      # Click, scroll, fill, clear, switch - all these are interactions.
+      # Actions are interactions with page that change something (click button, fill field, etc).
+      # Good method names starts with *click_*, *scroll_*, *fill_*, *clear_*, *switch_*, *open_*.
 
       include Actions::Layout
       include Actions::Table

lib/capybara/active_admin/actions/layout.rb

@@ -16,14 +16,21 @@ def switch_tab(tab_name, options = {})
           find(tab_header_link_selector, opts).click
         end
 
-        def click_batch_action(title)
-          find(batch_actions_button_selector).click
+        def click_batch_action(title, exact: true)
+          open_batch_action_menu
           within(dropdown_list_selector) do
-            selector = batch_action_selector(title)
-            find(selector).click
+            selector = batch_action_selector
+            opts = Util.options_with_text(title, exact: exact)
+            find(selector, opts).click
           end
         end
 
+        def open_batch_action_menu
+          return if find_all(dropdown_list_selector).present?
+
+          find(batch_actions_button_selector).click
+        end
+
         def confirm_modal_dialog
           within_modal_dialog { click_button 'OK' }
         end

lib/capybara/active_admin/actions/table.rb

@@ -4,6 +4,18 @@ module Capybara
   module ActiveAdmin
     module Actions
       module Table
+        def select_table_row(id: nil, index: nil)
+          raise ArgumentError, "can't use both :id and :index" if id && index
+          raise ArgumentError, 'must provide :id or :index' if id.nil? && index.nil?
+
+          if id
+            find("input#batch_action_item_#{id}").click
+            return
+          end
+
+          selector = %(input[id^="batch_action_item_"])
+          find_all(selector, minimum: index + 1)[index].click
+        end
       end
     end
   end

lib/capybara/active_admin/matchers/layout.rb

@@ -38,6 +38,12 @@ def have_sidebar(title, options = {})
           opts = Util.options_with_text(title, options)
           have_selector(title_selector, opts)
         end
+
+        def have_batch_action(title, exact: true)
+          selector = "#{dropdown_list_selector} #{batch_action_selector}"
+          opts = Util.options_with_text(title, exact: exact)
+          have_selector(selector, opts)
+        end
       end
     end
   end

lib/capybara/active_admin/selectors/layout.rb

@@ -73,8 +73,8 @@ def dropdown_list_selector
         end
 
         # @return [String] selector.
-        def batch_action_selector(title)
-          "li a[data-action='#{title}']"
+        def batch_action_selector
+          'li a[data-action]'
         end
 
         # @return [String] selector.

spec/dummy/test_application.rb

@@ -122,9 +122,12 @@ def common?
   # it allover the place
   config.authentication_method = false
   config.current_user_method = false
+  config.batch_actions = true
 end
 
 Rails.application.initialize!
+# to execute prepare hooks
+ActiveSupport::Reloader.prepare!
 
 ActiveAdmin.register_page 'Dashboard' do
   menu priority: 1, label: proc { I18n.t('active_admin.dashboard') }
@@ -141,9 +144,16 @@ def common?
   permit_params :full_name, :salary, duties_attributes: [:id, :name, :duty_type]
   includes :duties
 
+  batch_action :update_salary, form: -> { { salary: :text } } do |ids, inputs|
+    batch_action_collection.where(id: ids).each { |r| r.update!(salary: inputs['salary']) }
+    flash[:notice] = 'Salary was updated successfully'
+    redirect_back(fallback_location: admin_root_path)
+  end
+
   index do
     actions
     id_column
+    selectable_column
     column :full_name
     column(:salary) { |r| number_to_currency(r.salary) }
     column(:common_duties) { |r| r.duties.select(&:common?).map(&:name).join(', ') }

spec/system/business_employees_index_spec.rb

@@ -31,15 +31,15 @@
     expect(page).to have_table(resource_name: 'Business Employees')
     within_table_for do
       expect(page).to have_table_row(count: 2)
-      # 2x id, full_name, salary, common_duties, extra_duties, created_at, updated_at, actions
-      expect(page).to have_table_cell(count: 16)
+      # 2x9 (id, selectable, full_name, salary, common_duties, extra_duties, created_at, updated_at, actions)
+      expect(page).to have_table_cell(count: 18)
 
       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: 8)
+        expect(page).to have_table_cell(count: 9)
         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.00', column: 'Salary')
@@ -49,7 +49,7 @@
       end
 
       within_table_row(id: jane.id) do
-        expect(page).to have_table_cell(count: 8)
+        expect(page).to have_table_cell(count: 9)
         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(exact_text: '$101.00', column: 'Salary')
@@ -59,6 +59,33 @@
         expect(page).to_not have_table_cell(text: 'John Doe', column: 'Full Name')
       end
     end
-    # take_screenshot
+  end
+
+  it 'updates salary via batch action' do
+    john = Billing::Employee.create!(full_name: 'John Doe', salary: 100)
+    jane = Billing::Employee.create!(full_name: 'Jane Air', salary: 101)
+    5.times { |i| Billing::Employee.create!(full_name: "Jack #{i}", salary: 10) }
+
+    subject
+
+    within_table_for do
+      select_table_row(id: john.id)
+      select_table_row(id: jane.id)
+    end
+
+    open_batch_action_menu
+    expect(page).to have_batch_action('Update Salary Selected', exact: true)
+    expect(page).to have_batch_action('Delete Selected', exact: true)
+
+    click_batch_action('Update Salary Selected', exact: true)
+    within_modal_dialog do
+      fill_in 'salary', with: '200.35'
+    end
+    confirm_modal_dialog
+
+    expect(page).to have_flash_message('Salary was updated successfully', exact: true)
+
+    expect(john.reload.salary).to eq 200.35
+    expect(jane.reload.salary).to eq 200.35
   end
 end

spec/system/users_index_spec.rb

@@ -31,28 +31,29 @@
     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
+      # 2x6 (selectable, id, full_name, created_at, updated_at, actions)
+      expect(page).to have_table_cell(count: 12)
 
       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: 5) # id, full_name, created_at, updated_at, actions
+        # selectable, id, full_name, created_at, updated_at, actions
+        expect(page).to have_table_cell(count: 6)
         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')
       end
 
       within_table_row(id: jane.id) do
-        expect(page).to have_table_cell(count: 5) # id, full_name, created_at, updated_at, actions
+        expect(page).to have_table_cell(count: 6)
         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_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
 
   # TODO: filters expect to have