active_element 0.0.13 → 0.0.15

data/lib/active_element/components/util.rb

@@ -8,6 +8,7 @@ require_relative 'util/form_field_mapping'
 require_relative 'util/form_value_mapping'
 require_relative 'util/display_value_mapping'
 require_relative 'util/association_mapping'
+require_relative 'util/default_display_value'
 require_relative 'util/decorator'
 require_relative 'util/numeric_field'
 
@@ -23,12 +24,24 @@ module ActiveElement
         record&.try(:model_name)&.try(&:singular) || default_record_name(record)
       end
 
+      # TODO: Remove and use .sti_record_names everywhere instead.
       def self.sti_record_name(record)
         return default_record_name(record) unless record.class.respond_to?(:inheritance_column)
 
         record&.class&.superclass&.model_name&.singular if record&.try(record.class.inheritance_column).present?
       end
 
+      def self.sti_record_names(record) # rubocop:disable Metrics/CyclomaticComplexity
+        record.class.ancestors.select do |ancestor|
+          next false if ancestor == record.class
+          next false if ancestor.try(:inheritance_column).blank?
+          next false unless ancestor < ActiveRecord::Base
+          next false if ancestor.abstract_class?
+
+          true
+        end.map(&:model_name).map(&:singular)
+      end
+
       def self.default_record_name(record)
         (record.is_a?(Class) ? record.name : record.class.name).demodulize.underscore
       end

data/lib/active_element/controller_interface.rb

@@ -38,10 +38,16 @@ module ActiveElement
       state.editable_fields.concat(args.map(&:to_sym)).uniq!
     end
 
-    def searchable_fields(*args)
+    def searchable_fields(*args, required: false)
       state.searchable_fields.concat(args.map(&:to_sym)).uniq!
+      state.search_required = required
     end
 
+    def field_options(field, &block)
+      state.field_options[field] = block
+    end
+    alias field field_options
+
     def deletable
       state.deletable = true
     end
@@ -50,6 +56,10 @@ module ActiveElement
       RailsComponent.new(::Rails).application_name
     end
 
+    def t(identifier, **kwargs)
+      ::I18n.t("active_element.#{identifier}", **kwargs)
+    end
+
     def authenticate_with(&block)
       state.authenticator = block
     end

data/lib/active_element/controller_state.rb

@@ -5,9 +5,10 @@ module ActiveElement
   # configuration. Used throughout ActiveElement for generating dynamic content based on
   # controller configuration.
   class ControllerState
-    attr_reader :permissions, :listable_fields, :viewable_fields, :editable_fields, :searchable_fields
+    attr_reader :permissions, :listable_fields, :viewable_fields, :editable_fields, :searchable_fields,
+                :field_options
     attr_accessor :sign_in_path, :sign_in, :sign_in_method, :sign_out_path, :sign_out_method,
-                  :deletable, :authorizor, :authenticator, :list_order
+                  :deletable, :authorizor, :authenticator, :list_order, :search_required
 
     def initialize(controller:)
       @controller = controller
@@ -19,6 +20,7 @@ module ActiveElement
       @viewable_fields = []
       @editable_fields = []
       @searchable_fields = []
+      @field_options = {}
     end
 
     def deletable?

data/lib/active_element/default_controller/params.rb

@@ -33,7 +33,15 @@ module ActiveElement
         scalar, json = controller.active_element.state.editable_fields.partition do |field|
           scalar?(field)
         end
-        scalar + [json_params(json)]
+        scalar + relation_fields + [json_params(json)]
+      end
+
+      def relation_fields
+        controller.active_element.state.editable_fields.map do |field|
+          next nil unless relation?(field)
+
+          relation(field).try(:foreign_key)
+        end.compact
       end
 
       def scalar?(field)

data/lib/active_element/default_controller/search.rb

@@ -25,9 +25,11 @@ module ActiveElement
         conditions = search_filters.to_h.map do |key, value|
           next relation_matches(key, value) if relation?(key)
           next datetime_between(key, value) if datetime?(key)
+          next model.arel_table[key].matches("#{value}%") if string_like_column?(key)
 
-          model.arel_table[key].matches("#{value}%")
+          model.arel_table[key].eq(value)
         end
+
         conditions[1..].reduce(conditions.first) do |accumulated, condition|
           accumulated.and(condition)
         end
@@ -41,12 +43,27 @@ module ActiveElement
 
       attr_reader :controller, :model
 
+      def string_like_column?(key)
+        [:string, :text].include?(
+          model.columns.find { |column| column.name.to_s == key.to_s }&.type&.to_sym
+        )
+      end
+
       def searchable_fields
-        controller.active_element.state.searchable_fields.map do |field|
+        fields = controller.active_element.state.searchable_fields.map do |field|
           next field unless field.to_s.end_with?('_at')
 
           { field => %i[from to] }
         end
+        (fields + relation_fields).uniq
+      end
+
+      def relation_fields
+        controller.active_element.state.searchable_fields.map do |field|
+          next nil unless relation?(field)
+
+          relation(field).try(:foreign_key)
+        end.compact
       end
 
       def noop
@@ -76,21 +93,10 @@ module ActiveElement
       end
 
       def relation_matches(key, value)
-        fields = searchable_relation_fields(key)
-        relation_model = relation(key).klass
-        fields.select! do |field|
-          relation_model.columns.find { |column| column.name.to_s == field.to_s }&.type == :string
-        end
-
-        return noop if fields.empty?
+        foreign_key = relation(key).try(:foreign_key)
+        return noop unless foreign_key.present?
 
-        relation_conditions(fields, value, relation_model)
-      end
-
-      def relation_conditions(fields, value, relation_model)
-        fields[1..].reduce(relation_model.arel_table[fields.first].matches("#{value}%")) do |condition, field|
-          condition.or(relation_model.arel_table[field].matches("#{value}%"))
-        end
+        model.arel_table[foreign_key].eq(value)
       end
 
       def searchable_relation_fields(key)

data/lib/active_element/field_options.rb

@@ -0,0 +1,20 @@
+module ActiveElement
+  class FieldOptions
+    attr_accessor :type, :options
+    attr_reader :field
+
+    def self.from_state(field, state, record)
+      block = state.field_options[field]
+      return nil if block.blank?
+
+      field_options = new(field)
+      block.call(field_options, record)
+      field_options
+    end
+
+    def initialize(field)
+      @field = field
+      @options = {}
+    end
+  end
+end

data/lib/active_element/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveElement
-  VERSION = '0.0.13'
+  VERSION = '0.0.15'
 end

data/lib/active_element.rb

@@ -14,6 +14,7 @@ require_relative 'active_element/permissions_report'
 require_relative 'active_element/controller_interface'
 require_relative 'active_element/controller_state'
 require_relative 'active_element/controller_action'
+require_relative 'active_element/field_options'
 require_relative 'active_element/default_controller'
 require_relative 'active_element/pre_render_processors'
 require_relative 'active_element/rails_component'

data/rspec-documentation/pages/016-Default Controller.md

@@ -105,7 +105,7 @@ The results will be rendered in a horizontal table with one row for each item, i
 # app/controllers/restaurants_controller.rb
 
 class RestaurantsController < ApplicationController
-  active_element.searchable_fields :name, :restaurateur, :created_at
+  active_element.viewable_fields :name, :restaurateur, :created_at
 end
 ```
 
@@ -119,6 +119,15 @@ Note that each field type can be overridden and configured by defining `config/f
 
 By default, `json` and `jsonb` fields use the [JSON Field](form-fields/json.html) type, allowing you to edit complex _JSON_ data structures via user-friendly _HTML_ forms. A [schema file](form-fields/json/schema.html) **must** be defined for these fields. See the `json_field` documentation for more details.
 
+
+```ruby
+# app/controllers/restaurants_controller.rb
+
+class RestaurantsController < ApplicationController
+  active_element.editable_fields :name, :restaurateur
+end
+```
+
 ## Deletable
 
 The `active_element.deletable` declaration does not receive any arguments but specifies that a record can be deleted by a user.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_element
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.15
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-22 00:00:00.000000000 Z
+date: 2023-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bootstrap
@@ -131,6 +131,7 @@ files:
 - app/assets/stylesheets/active_element/application.scss
 - app/controllers/active_element/application_controller.rb
 - app/controllers/concerns/active_element/default_controller_actions.rb
+- app/views/active_element/_title.html.erb
 - app/views/active_element/_user.html.erb
 - app/views/active_element/components/_horizontal_tabs.html.erb
 - app/views/active_element/components/_vertical_tabs.html.erb
@@ -140,6 +141,7 @@ files:
 - app/views/active_element/components/form.html.erb
 - app/views/active_element/components/form/_check_box.html.erb
 - app/views/active_element/components/form/_check_boxes.html.erb
+- app/views/active_element/components/form/_date_range_field.html.erb
 - app/views/active_element/components/form/_datetime_range_field.html.erb
 - app/views/active_element/components/form/_field.html.erb
 - app/views/active_element/components/form/_generic_field.html.erb
@@ -307,6 +309,7 @@ files:
 - lib/active_element/components/util.rb
 - lib/active_element/components/util/association_mapping.rb
 - lib/active_element/components/util/decorator.rb
+- lib/active_element/components/util/default_display_value.rb
 - lib/active_element/components/util/display_value_mapping.rb
 - lib/active_element/components/util/field_mapping.rb
 - lib/active_element/components/util/form_field_mapping.rb
@@ -325,6 +328,7 @@ files:
 - lib/active_element/default_controller/params.rb
 - lib/active_element/default_controller/search.rb
 - lib/active_element/engine.rb
+- lib/active_element/field_options.rb
 - lib/active_element/json_field_schema.rb
 - lib/active_element/permissions_check.rb
 - lib/active_element/permissions_report.rb