formatic 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c52f37c072f5cbebbfa6718393edae33f687911b3e426db8a97a3cd6b5a0c72
-  data.tar.gz: bea3f5680a56ba9b447e7fa925eb60aaa809a756d0c1b9d8d7b573b967752f03
+  metadata.gz: d41f61aacdbc9679d1e63ff82441ac6008ae35f53a8b5425986e3bac53baeb0d
+  data.tar.gz: 2974cac3f7d742dc001b45a2c5cdfe81f71e4e2cfd24d6052b4d563a790423c7
 SHA512:
-  metadata.gz: f86e74b0b5a1ca07c73d265672b6770ee543f1879e098498cc6a7cb64bf8d9b26972f5120b6c5fb0299242991640a47c671b94c3e002ab3addfb911cbaae3abe
-  data.tar.gz: 4dd6d6b3102c55177e11ca879f0ffab0edce31cf7595914ffa0802746c6157da138833f138fcd8dca5ed793139998d8f1393588f7bd099a030123131815004c8
+  metadata.gz: 4da00730403d13520acf91dd762fe73e9a007ba6ba4146aa96cfb40d9e18ee71e4d45eb54569fab08a87df55838ee6c6302b1881c6b4a8eaa3376b10cf91462f
+  data.tar.gz: 7d37f9de2bb33f902fb85390aa8bcdc0f1500131196cf55107eeaaa5df94cd78e22bb34bc88cadaae41ac20457eb3d74d34053989da08d457d7e2a04f99cfd51

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.6.0] 2026-10-26
+
+- Include `Formatic::Testing::Capybara::Search` in a Capybara RackTest class to call `search 'Acme Corp', from: 'Customer'`
+
+## [0.5.1] 2026-10-26
+
+- Rack tests call `Formatic::Testing::Search.call` instead of including a Capybara module
+
 ## [0.5.0] 2026-10-26
 
 - Add `Formatic::Search`, a JSON-backed search field

data/README.md

@@ -29,11 +29,24 @@ after a successful response, even when there are no matches.
                               url: admin_commanders_path(format: :json))
 ```
 
-For Rack tests, include `Formatic::Testing::Capybara::Search` in a
-`Capybara::RackTest` test class. `select_record_from_search 'Bob', from: 'Users'`
-reads the field's URL and parameter names, requests matching JSON directly, and
+For Rack tests, call `Formatic::Testing::Search.call(page:, query: 'Bob', from: 'Users')`.
+It reads the field's URL and parameter names, requests matching JSON directly, and
 fills the hidden input with a result returned by that endpoint.
 
+Capybara RackTest test classes can include the `search` helper instead:
+
+```ruby
+require 'formatic/testing/capybara'
+
+class CustomersTest < ActionDispatch::SystemTestCase
+  include Formatic::Testing::Capybara::Search
+
+  test 'select a customer' do
+    search 'Acme Corp', from: 'Customer'
+  end
+end
+```
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:

data/app/components/formatic/file.rb

@@ -49,18 +49,22 @@ module Formatic
     private
 
     def validate_attribute_name!
+      return unless validate_attribute_name?
+      return if f.object.respond_to?(attribute_name)
+
+      raise ArgumentError,
+            "attribute `#{attribute_name}` does not exist on #{f.object.class}."
+    end
+
+    def validate_attribute_name?
       # A manually passed value means `attribute_name` is just a param name,
       # not necessarily a method on the model.
-      return if manual_value != :_fetch_from_record
-      return if f.nil? || f.object.nil?
+      return false if manual_value != :_fetch_from_record
+      return false if f.nil? || f.object.nil?
 
       # Only enforce this for real ActiveModel/ActiveRecord records.
       # Custom objects (e.g. slugs) are not expected to respond to it.
-      return unless f.object.respond_to?(:model_name)
-      return if f.object.respond_to?(attribute_name)
-
-      raise ArgumentError,
-            "attribute `#{attribute_name}` does not exist on #{f.object.class}."
+      f.object.respond_to?(:model_name)
     end
 
     def attachments
@@ -77,19 +81,22 @@ module Formatic
       # Filepond doesn't work well  with invalid form submits anyway.
       return if multiple
 
-      attachments.map do |attachment|
-        {
-          source: attachment.signed_id,
-          options: {
-            type: 'local',
-            file: {
-              name: attachment.filename,
-              size: attachment.byte_size,
-              type: attachment.content_type
-            }
-          }
-        }
-      end.to_json
+      attachments.map { |attachment| entry_json(attachment) }.to_json
+    end
+
+    def entry_json(attachment)
+      {
+        source: attachment.signed_id,
+        options: { type: 'local', file: file_json(attachment) }
+      }
+    end
+
+    def file_json(attachment)
+      {
+        name: attachment.filename,
+        size: attachment.byte_size,
+        type: attachment.content_type
+      }
     end
 
     # The currently attached file, if there is exactly one.

data/lib/formatic/testing/capybara.rb

@@ -1,92 +1,18 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'calls'
+require_relative 'search'
 
 module Formatic
   module Testing
     module Capybara
+      # Include in a Capybara RackTest test class to select Formatic search results.
+      #
+      #   include Formatic::Testing::Capybara::Search
+      #
+      #   search 'Acme Corp', from: 'Customer'
       module Search
-        def select_record_from_search(query, from:)
-          SearchSelector.call(page: page, query:, from:)
-        end
-
-        class SearchSelector
-          include Calls
-
-          class SelectionError < ::StandardError; end
-
-          option :page
-          option :query
-          option :from
-
-          def call
-            ensure_rack_test_driver!
-            query_field = page.find_field(from)
-            component = search_component(query_field)
-            record = matching_record(search_records(component), query)
-
-            raise SelectionError, "No result matching #{query.inspect} from #{from.inspect}" unless record
-
-            apply_selection(component, query_field, record)
-            record
-          end
-
-          private
-
-          def ensure_rack_test_driver!
-            require 'capybara/rack_test/driver'
-            return if page.driver.is_a?(::Capybara::RackTest::Driver)
-
-            raise ArgumentError, 'select_record_from_search requires Capybara RackTest'
-          end
-
-          def search_component(query_field)
-            query_field.find(:xpath, 'ancestor::div[contains(@class, "js-formatic-search")][1]')
-          end
-
-          def search_records(component)
-            response = search_request(configured_value(component, 'resource'), search_params(component))
-
-            raise SelectionError, "Search for #{from.inspect} returned HTTP #{response.status}" unless response.ok?
-
-            JSON.parse(response.body).fetch('records')
-          end
-
-          def search_params(component)
-            {
-              query: query,
-              record_name: configured_value(component, 'record-name'),
-              attribute_name: configured_value(component, 'attribute-name'),
-              exclude_ids: configured_value(component, 'exclude-ids')
-            }
-          end
-
-          def configured_value(component, class_suffix)
-            component.find(".js-formatic-search__#{class_suffix}", visible: :all).value
-          end
-
-          def search_request(url, params)
-            browser = page.driver.browser
-            browser.current_session.restore_state do
-              browser.get(url, params, 'HTTP_ACCEPT' => 'application/json')
-            end
-          end
-
-          def matching_record(records, query)
-            records.find do |record|
-              text = record.fetch('choice').gsub(/<[^>]*>/, ' ')
-              text.downcase.include?(query.downcase)
-            end
-          end
-
-          def apply_selection(component, query_field, record)
-            component.find('.js-formatic-search__value', visible: :all).set(record.fetch('id').to_s)
-            selected = component.find('.js-formatic-search__selected', visible: :all)
-            selected.native.inner_html = record.fetch('selected')
-            component.find('.js-formatic-search__results', visible: :all).native.inner_html = ''
-            query_field.set('')
-          end
+        def search(query, from:)
+          ::Formatic::Testing::Search.call(page:, query:, from:)
         end
       end
     end

data/lib/formatic/testing/search.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'calls'
+
+module Formatic
+  module Testing
+    # Selects a Formatic search result in a Rack test.
+    class Search
+      include Calls
+
+      class SelectionError < ::StandardError; end
+
+      option :page
+      option :query
+      option :from
+
+      def call
+        ensure_rack_test_driver!
+        query_field = page.find_field(from)
+        component = search_component(query_field)
+        record = matching_record(search_records(component), query)
+
+        raise SelectionError, "No result matching #{query.inspect} from #{from.inspect}" unless record
+
+        apply_selection(component, query_field, record)
+        record
+      end
+
+      private
+
+      def ensure_rack_test_driver!
+        require 'capybara/rack_test/driver'
+        return if page.driver.is_a?(::Capybara::RackTest::Driver)
+
+        raise ArgumentError, 'Formatic::Testing::Search requires Capybara RackTest'
+      end
+
+      def search_component(query_field)
+        query_field.find(:xpath, 'ancestor::div[contains(@class, "js-formatic-search")][1]')
+      end
+
+      def search_records(component)
+        response = search_request(configured_value(component, 'url'), search_params(component))
+
+        raise SelectionError, "Search for #{from.inspect} returned HTTP #{response.status}" unless response.ok?
+
+        JSON.parse(response.body).fetch('records')
+      end
+
+      def search_params(component)
+        {
+          query: query,
+          record_name: configured_value(component, 'record-name'),
+          attribute_name: configured_value(component, 'attribute-name'),
+          exclude_ids: configured_value(component, 'exclude-ids')
+        }
+      end
+
+      def configured_value(component, class_suffix)
+        component.find(".js-formatic-search__#{class_suffix}", visible: :all).value
+      end
+
+      def search_request(url, params)
+        browser = page.driver.browser
+        browser.current_session.restore_state do
+          browser.get(url, params, 'HTTP_ACCEPT' => 'application/json')
+        end
+      end
+
+      def matching_record(records, query)
+        records.find do |record|
+          text = record.fetch('choice').gsub(/<[^>]*>/, ' ')
+          text.downcase.include?(query.downcase)
+        end
+      end
+
+      def apply_selection(component, query_field, record)
+        component.find('.js-formatic-search__value', visible: :all).set(record.fetch('id').to_s)
+        selected = component.find('.js-formatic-search__selected', visible: :all)
+        selected.native.inner_html = record.fetch('selected')
+        component.find('.js-formatic-search__results', visible: :all).native.inner_html = ''
+        query_field.set('')
+      end
+    end
+  end
+end

data/lib/formatic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Formatic
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formatic
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - halo
@@ -218,6 +218,7 @@ files:
 - lib/formatic/templates/select.rb
 - lib/formatic/templates/wrapper.rb
 - lib/formatic/testing/capybara.rb
+- lib/formatic/testing/search.rb
 - lib/formatic/version.rb
 - lib/formatic/vscode_snippets.rb
 - lib/formatic/wrappers/alternative_attribute_name.rb