formatic 0.4.4 → 0.6.0

data/lib/formatic/templates/search.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Formatic
+  module Templates
+    # Holds the ERB template for this component.
+    module Search
+      TEMPLATE = <<~ERB
+        <%= render wrapper do |formatic_wrapper| %>
+          <% formatic_wrapper.with_input do %>
+            <div class="c-formatic-search s-formatic js-formatic-search">
+              <input type="hidden" class="js-formatic-search__url" value="<%= url %>">
+              <input type="hidden" class="js-formatic-search__record-name" value="<%= record_name %>">
+              <input type="hidden" class="js-formatic-search__attribute-name" value="<%= attribute_name %>">
+              <input type="hidden" class="js-formatic-search__exclude-ids" value="<%= exclude_ids.join(',') %>">
+
+              <%= f.hidden_field attribute_name,
+                                 id: nil,
+                                 value:,
+                                 class: 'js-formatic-search__value' %>
+
+              <div class="c-formatic-search__selected js-formatic-search__selected">
+                <% if selected_record? %>
+                  <%= render ::Formatic::Search::Selected.new(readonly: readonly).with_content(selected_record) %>
+                <% end %>
+              </div>
+
+              <% unless readonly %>
+                <div class="c-formatic-search__query">
+                  <%= helpers.tag.input type: 'search',
+                                        id: query_input_id,
+                                        placeholder: search_placeholder,
+                                        autocomplete: 'off',
+                                        class: 'js-formatic-search__query-input' %>
+                </div>
+
+                <div class="c-formatic-search__results js-formatic-search__results"></div>
+                <div class="c-formatic-search__add-record js-formatic-search__add-record" hidden><%= add_record %></div>
+              <% end %>
+            </div>
+          <% end %>
+        <% end %>
+      ERB
+
+      private_constant :TEMPLATE
+
+      def self.call
+        TEMPLATE
+      end
+    end
+  end
+end

data/lib/formatic/testing/capybara.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+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 search(query, from:)
+          ::Formatic::Testing::Search.call(page:, query:, from:)
+        end
+      end
+    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.4.4'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formatic
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.6.0
 platform: ruby
 authors:
 - halo
@@ -119,6 +119,9 @@ files:
 - README.md
 - app/assets/javascript/declarations/date.d.ts
 - app/assets/javascript/declarations/file.d.ts
+- app/assets/javascript/declarations/search.d.ts
+- app/assets/javascript/declarations/search_record.d.ts
+- app/assets/javascript/declarations/search_requests.d.ts
 - app/assets/javascript/declarations/select.d.ts
 - app/assets/javascript/declarations/setup.d.ts
 - app/assets/javascript/declarations/stepper.d.ts
@@ -129,6 +132,12 @@ files:
 - app/assets/javascript/formatic/date.js.map
 - app/assets/javascript/formatic/file.js
 - app/assets/javascript/formatic/file.js.map
+- app/assets/javascript/formatic/search.js
+- app/assets/javascript/formatic/search.js.map
+- app/assets/javascript/formatic/search_record.js
+- app/assets/javascript/formatic/search_record.js.map
+- app/assets/javascript/formatic/search_requests.js
+- app/assets/javascript/formatic/search_requests.js.map
 - app/assets/javascript/formatic/select.js
 - app/assets/javascript/formatic/select.js.map
 - app/assets/javascript/formatic/setup.js
@@ -142,6 +151,9 @@ files:
 - app/assets/javascript/formatic/toggle.js.map
 - app/assets/javascript/src/date.ts
 - app/assets/javascript/src/file.ts
+- app/assets/javascript/src/search.ts
+- app/assets/javascript/src/search_record.ts
+- app/assets/javascript/src/search_requests.ts
 - app/assets/javascript/src/select.ts
 - app/assets/javascript/src/stepper.ts
 - app/assets/javascript/src/string.ts
@@ -150,6 +162,7 @@ files:
 - app/assets/stylesheets/formatic.sass
 - app/assets/stylesheets/formatic/components/checklist.sass
 - app/assets/stylesheets/formatic/components/date.sass
+- app/assets/stylesheets/formatic/components/search.sass
 - app/assets/stylesheets/formatic/components/select.sass
 - app/assets/stylesheets/formatic/components/stepper.sass
 - app/assets/stylesheets/formatic/components/string.sass
@@ -176,6 +189,11 @@ files:
 - app/components/formatic/date.rb
 - app/components/formatic/file.rb
 - app/components/formatic/files.rb
+- app/components/formatic/search.rb
+- app/components/formatic/search/choice.rb
+- app/components/formatic/search/clear.rb
+- app/components/formatic/search/frontend.rb
+- app/components/formatic/search/selected.rb
 - app/components/formatic/select.rb
 - app/components/formatic/stepper.rb
 - app/components/formatic/string.rb
@@ -196,8 +214,11 @@ files:
 - lib/formatic/engine.rb
 - lib/formatic/safe_join.rb
 - lib/formatic/templates/date.rb
+- lib/formatic/templates/search.rb
 - 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