active_element 0.0.18 → 0.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c6d9d2e62cd64334ba324d02116adda1fb4177b3ada32e2634c69ddc8a59d42
-  data.tar.gz: d37225180b3932060de9cbbaa4d1e5c69a70ccf277aeaaa27fdd94a99b2327f9
+  metadata.gz: 667ecfa2f26f661d4c0f760529fdc4ae944e242fdefecba10d6cc5b194b1e822
+  data.tar.gz: 28f0326bb18b3bf7fb402a5b89e82c796621825779fdaa2a754817e5028fe8e0
 SHA512:
-  metadata.gz: 6f97e214aa565b0c47bcac56a11340a043ecf5f0d138229e9827f7a35f730cc66d44e0ce73666c8f7fe87126a30beb0fe06e8a16072eadcb4cf264fe579762f5
-  data.tar.gz: d30d2534b1418c8f9ad70dcca84b7a53587d5e171d7c9b8489d51667c4714f502de905382d7ec030566da90eb02f8c2141f76a888f7a52770b4a711fbf6576b7
+  metadata.gz: 1d7a79658f6ec7d58e2aac0492fe952d7df2c6d4873f2a4ad9390735b3f5c868947bb9722c92ec4bb640bf2909c3ad064e3ecaf7fccd5c07992810d9ee3344ee
+  data.tar.gz: d48338e4f22be093bf6b3c6ef3ca2acce3150a3db3fde1b715408b4f8de3ce41f2c6a3074982b4426fc53de6f5609b5de443f8192c5b602008f37abe1cbf0621

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_element (0.0.18)
+    active_element (0.0.20)
       bootstrap (~> 5.3.0alpha3)
       kaminari (~> 1.2)
       paintbrush (~> 0.1.2)
@@ -83,7 +83,7 @@ GEM
     autoprefixer-rails (10.4.16.0)
       execjs (~> 2)
     bcrypt (3.1.18)
-    bootstrap (5.3.2)
+    bootstrap (5.3.3)
       autoprefixer-rails (>= 9.1.0)
       popper_js (>= 2.11.8, < 3)
     brakeman (5.4.1)
@@ -145,21 +145,21 @@ GEM
       net-imap
       net-pop
       net-smtp
-    marcel (1.0.2)
+    marcel (1.0.4)
     method_source (1.0.0)
     mini_mime (1.1.5)
     mini_portile2 (2.8.2)
     minitest (5.18.1)
-    net-imap (0.4.10)
+    net-imap (0.4.11)
       date
       net-protocol
     net-pop (0.1.2)
       net-protocol
     net-protocol (0.2.2)
       timeout
-    net-smtp (0.4.0.1)
+    net-smtp (0.5.0)
       net-protocol
-    nio4r (2.7.0)
+    nio4r (2.7.3)
     nokogiri (1.15.2)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)

data/README.md

@@ -1,31 +1,5 @@
 # ActiveElement
 
-TODO: Delete this and the text below, and describe your gem
+ActiveElement is a framework for building admin applications in Rails.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/active_element`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_element.
+See the [documentation](https://docs.bob.frl/active_element) to get started.

data/app/controllers/active_element/application_controller.rb

@@ -27,8 +27,8 @@ module ActiveElement
     helper_method :active_element
     helper_method :render_active_element_hook
 
-    def render_active_element_hook(hook)
-      render_to_string partial: hook
+    def render_active_element_hook(hook, locals: {})
+      render_to_string partial: hook, locals: locals
     rescue ActionView::MissingTemplate
       nil
     end

data/app/views/active_element/components/button.html.erb

@@ -6,7 +6,7 @@
       'bs-trigger': 'hover',
       'bs-toggle': 'popover',
       'bs-content': title,
-    } : {}),
+    } : {}).merge(method&.to_s == 'get' ? {} : { 'turbo-method' => method.to_s }),
     class: "btn #{button_class} #{float_class} #{kwargs_class}",
     **kwargs
   ) do %>

data/app/views/active_element/components/form.html.erb

@@ -59,13 +59,23 @@
     <% fields.each_slice(columns) do |field_group| %>
       <div class="row form-fields mb-3">
         <% field_group.each do |field, type, options| %>
-          <div class="col-sm-3">
-            <%= render partial: 'active_element/components/form/label',
-                       locals: { component: component, id: id, type: type, form: form, field: field, options: options } %>
-          </div>
+          <% if type != :hidden_field %>
+            <div class="col-sm-3">
+              <%= render partial: 'active_element/components/form/label',
+                         locals: {
+                           component: component,
+                           id: id,
+                           type: type,
+                           form: form,
+                           field: field,
+                           options: options
+                         } %>
+            </div>
+          <% end %>
 
 
-          <div class="col">
+
+          <% if type != :hidden_field %><div class="col"><% end %>
             <%= render partial: 'active_element/components/form/field',
                        locals: {
                          id: id,
@@ -76,7 +86,7 @@
                          component: component,
                          record: record }
             %>
-          </div>
+          <% if type != :hidden_field %></div><% end %>
         <% end %>
       </div>
     <% end %>

data/app/views/active_element/components/table/_collection_row.html.erb

@@ -1,6 +1,6 @@
 <tr class="<%= (index % 2).zero? ? 'even' : 'odd' %> <%= row_class_mapper.call(item) %>">
   <% fields.each do |field, class_mapper, label, value_mapper| %>
-    <td class="align-middle <%= class_mapper.call(item) %>">
+    <td class="align-top <%= class_mapper.call(item) %>">
       <% if component.secret_field?(field) %>
         <%= controller.helpers.render partial: 'active_element/components/secret/field',
                                       locals: { secret: value_mapper.call(item), label: label } %>

data/app/views/active_element/components/table/collection.html.erb

@@ -1,5 +1,10 @@
 <% if new %>
-  <%= active_element.component.new_button(component.model&.new, float: 'end', class: 'mb-3') %>
+  <%= active_element.component.new_button(
+    component.model&.new,
+    nested_for: nested_for,
+    float: 'end',
+    class: 'mb-3'
+  ) %>
 <% end %>
 
 

data/app/views/active_element/default_views/edit.html.erb

@@ -1,9 +1,9 @@
 <%= active_element.component.page_title record.model_name.to_s.titleize %>
 
-<%= render_active_element_hook "#{controller_path}/before_edit" %>
+<%= render_active_element_hook "#{controller_path}/before_edit", locals: { record: record } %>
 
 <%= active_element.component.form model: [namespace, record].compact,
                                   destroy: active_element.state.deletable?,
                                   fields: active_element.state.editable_fields %>
 
-<%= render_active_element_hook "#{controller_path}/after_edit" %>
+<%= render_active_element_hook "#{controller_path}/after_edit", locals: { record: record } %>

data/app/views/active_element/default_views/index.html.erb

@@ -7,7 +7,17 @@
                                     fields: active_element.state.searchable_fields %>
 <% end %>
 
-<%= render_active_element_hook "#{controller_path}/before_index" %>
+<%= render_active_element_hook "#{controller_path}/before_index", locals: { collection: collection } %>
+
+<% if nested_for.present? %>
+  <%=
+    active_element.component.page_section_title(
+      nested_for.map do |nested_for_record|
+        ActiveElement::Components::Util::DefaultDisplayValue.new(object: nested_for_record).value
+      end.join(', ')
+    )
+    %>
+<% end %>
 
 <% if active_element.state.search_required && search_filters.compact_blank.blank? %>
   <% if active_element.state.creatable? %>
@@ -20,8 +30,9 @@
                                      show: active_element.state.viewable?,
                                      edit: active_element.state.editable?,
                                      destroy: active_element.state.deletable?,
+                                     nested_for: nested_for,
                                      collection: collection,
                                      fields: active_element.state.listable_fields %>
 <% end %>
 
-<%= render_active_element_hook "#{controller_path}/after_index" %>
+<%= render_active_element_hook "#{controller_path}/after_index", locals: { collection: collection } %>

data/app/views/active_element/default_views/show.html.erb

@@ -1,10 +1,10 @@
 <%= active_element.component.page_title record.model_name.to_s.titleize %>
 
-<%= render_active_element_hook "#{controller_path}/before_show" %>
+<%= render_active_element_hook "#{controller_path}/before_show", locals: { record: record } %>
 
 <%= active_element.component.table item: record,
                                    edit: active_element.state.editable?,
                                    destroy: active_element.state.deletable?,
                                    fields: active_element.state.viewable_fields %>
 
-<%= render_active_element_hook "#{controller_path}/after_show" %>
+<%= render_active_element_hook "#{controller_path}/after_show", locals: { record: record } %>

data/app/views/layouts/active_element.html.erb

@@ -19,6 +19,15 @@
       </script>
     <% end %>
 
+    <% if respond_to?(:javascript_pack_tag) && defined? Webpacker %>
+      <%= begin
+            javascript_pack_tag 'application'
+          rescue Webpacker::Manifest::MissingEntryError
+            nil
+          end
+        %>
+    <% end %>
+
     <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css" integrity="sha512-iecdLmaskl7CVkqkXNQ/ZH/XLlvWZOJyj7Yy7tcenmpD1ypASozpmT/E0iPtmFIB46ZmdtAc9eNBvH0H/ZpiBw==" crossorigin="anonymous" referrerpolicy="no-referrer" />
     <link rel="stylesheet"
           href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/default.min.css">
@@ -116,6 +125,5 @@
       <%= javascript_include_tag 'active_element/active_element', 'data-turbo-track': 'reload', 'data-turbolinks-track': 'reload' %>
       <%= javascript_include_tag 'application', 'data-turbo-track': 'reload', 'data-turbolinks-track': 'reload' %>
     <% end %>
-
   </body>
 </html>

data/config/routes.rb

@@ -2,6 +2,7 @@
 
 ActiveElement::Engine.routes.draw do
   ActiveElement.eager_load_controllers
+  ActiveElement.eager_load_models
 
   ActiveElement::ApplicationController.descendants.map do |descendant|
     post "#{descendant.controller_path}/_active_element_text_search",

data/example_app/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    active_element (0.0.14)
+    active_element (0.0.18)
       bootstrap (~> 5.3.0alpha3)
       kaminari (~> 1.2)
       paintbrush (~> 0.1.2)

data/lib/active_element/components/button.rb

@@ -6,7 +6,7 @@ module ActiveElement
     class Button
       # rubocop:disable Metrics/MethodLength
       def initialize(controller, record, flag_or_options, confirm: false, type: :primary, method: nil,
-                     float: nil, icon: nil, tooltip: false, **kwargs, &block)
+                     float: nil, icon: nil, tooltip: false, nested_for: nil, **kwargs, &block)
         @controller = controller
         @record = record.is_a?(ActiveRecord::Relation) ? record.klass.new : record
         @flag_or_options = flag_or_options
@@ -20,6 +20,7 @@ module ActiveElement
         @block_given = block_given?
         @content = block.call if block_given?
         @tooltip = tooltip
+        @nested_for = nested_for
       end
       # rubocop:enable Metrics/MethodLength
 
@@ -49,7 +50,7 @@ module ActiveElement
       private
 
       attr_reader :controller, :record, :flag_or_options, :float, :kwargs, :kwargs_class, :type, :method, :icon,
-                  :block_given, :content, :confirm, :tooltip
+                  :block_given, :content, :confirm, :tooltip, :nested_for
 
       def link_method
         return method if method.present?
@@ -116,7 +117,21 @@ module ActiveElement
       def record_path
         return nil unless record.class.is_a?(ActiveModel::Naming)
 
-        Util::RecordPath.new(record: record, controller: controller, type: type).path
+        Util::RecordPath.new(record: record, controller: controller, type: type).path(**nested_args)
+      end
+
+      def nested_args
+        case type
+        when :new
+          nested_params
+        else
+          {}
+        end
+      end
+
+      def nested_params
+        route = controller.request.routes.recognize_path(controller.request.path)
+        route.reject { |key, _value| %w[controller action].include?(key.to_s) }
       end
     end
   end

data/lib/active_element/components/collection_table.rb

@@ -15,7 +15,7 @@ module ActiveElement
       # rubocop:disable Metrics/MethodLength
       def initialize(controller, class_name:, collection:, fields:, params:, model_name: nil, style: nil,
                      show: false, new: false, edit: false, destroy: false, paginate: true, group: nil,
-                     group_title: false, row_class: nil, title: nil, **_kwargs)
+                     group_title: false, nested_for: nil, row_class: nil, title: nil, **_kwargs)
         @controller = controller
         @class_name = class_name
         @model_name = model_name
@@ -32,6 +32,7 @@ module ActiveElement
         @group_title = group_title
         @row_class = row_class
         @title = title
+        @nested_for = nested_for
         verify_paginate_and_group
       end
       # rubocop:enable Metrics/MethodLength
@@ -54,6 +55,7 @@ module ActiveElement
           destroy: destroy,
           group: group,
           group_title: group_title,
+          nested_for: nested_for,
           display_pagination: display_pagination?,
           page_sizes: [5, 10, 25, 50, 75, 100, 200],
           page_size: page_size,
@@ -78,7 +80,7 @@ module ActiveElement
 
       attr_reader :class_name, :collection, :fields, :style, :row_class,
                   :new, :show, :edit, :destroy,
-                  :paginate, :params, :group, :group_title, :title
+                  :paginate, :params, :group, :group_title, :title, :nested_for
 
       def paginated_collection
         return collection unless paginate && collection.respond_to?(:page) && !limit?

data/lib/active_element/components/form.rb

@@ -190,14 +190,30 @@ module ActiveElement
       end
 
       def base_options_for_select(field, field_options)
-        return normalized_options(field_options.fetch(:options)) if field_options.key?(:options)
+        return normalized_options(field_options.fetch(:options), field_options) if field_options.key?(:options)
         return default_options_for_select(field, field_options) if record.class.is_a?(ActiveModel::Naming)
 
         raise ArgumentError, "Must provide select options `[:#{field}, { options: [...] }]` or a record instance."
       end
 
-      def normalized_options(options)
-        options.map { |option| option.is_a?(Array) ? option : [option, option] }
+      def normalized_options(options, field_options)
+        options.map do |option|
+          next option if option.is_a?(Array)
+          next active_record_option(option, field_options) if option.is_a?(ActiveRecord::Base)
+          [option, option] if option.is_a?(String)
+        end
+      end
+
+      def active_record_option(option, field_options)
+        [active_record_display_value(option, field_options), option.send(option.class.primary_key)]
+      end
+
+      def active_record_display_value(option, field_options)
+        if field_options[:display_value].is_a?(Proc) && record.present?
+          field_options[:display_value].call(option)
+        else
+          Util::DefaultDisplayValue.new(object: option).value
+        end
       end
 
       def default_class_name

data/lib/active_element/components/util/default_display_value.rb

@@ -12,6 +12,10 @@ module ActiveElement
         end
 
         def value
+          if object.respond_to?(:default_display_attribute)
+            return object.public_send(object.default_display_attribute)
+          end
+
           DEFAULT_FIELDS.each do |field|
             return object.public_send(field) if active_record_value?(field)
             return object[field] if hash_key(field) if hash_value?(field)

data/lib/active_element/components/util/form_field_mapping.rb

@@ -59,10 +59,12 @@ module ActiveElement
         end
 
         def inline_configured_field(field)
-          field_options = FieldOptions.from_state(field, controller.active_element.state, record)
+          field_options = FieldOptions.from_state(
+            field, controller.active_element.state, record, controller
+          )
           return nil if field_options.blank?
 
-          [field, field_options.type, field_options.options]
+          [field, field_options.type, field_options.options.reverse_merge({ value: field_options.value })]
         end
 
         def field_with_provided_type_and_provided_options(field)
@@ -201,6 +203,7 @@ module ActiveElement
             json: :json_field,
             jsonb: :json_field,
             geometry: :text_area,
+            text: :text_area,
             datetime: :datetime_field,
             date: :date_field,
             time: :time_field,

data/lib/active_element/components/util/record_mapping.rb

@@ -80,13 +80,22 @@ module ActiveElement
         end
 
         def value_from_config
-          field_options = FieldOptions.from_state(field, component.controller.active_element.state, record)
+          field_options = field_options_from_state
           return nil if field_options.blank?
           return nil unless DATABASE_TYPES.include?(field_options.type.to_sym)
 
           send("#{field_options.type}_value")
         end
 
+        def field_options_from_state
+          FieldOptions.from_state(
+            field,
+            component.controller.active_element.state,
+            record,
+            component.controller
+          )
+        end
+
         # Override these methods as required in a class that includes this module:
 
         def mapped_association_from_record

data/lib/active_element/controller_interface.rb

@@ -25,8 +25,9 @@ module ActiveElement
       @authorize
     end
 
-    def listable_fields(*args, order: nil)
+    def listable_fields(*args, order: nil, scope: nil)
       state.list_order = order
+      state.list_scope = scope
       state.listable_fields.concat(args.map(&:to_sym)).uniq!
     end
 

data/lib/active_element/controller_state.rb

@@ -8,7 +8,7 @@ module ActiveElement
     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, :search_required, :model
+                  :deletable, :authorizor, :authenticator, :list_order, :list_scope, :search_required, :model
 
     def initialize(controller:)
       @controller = controller

data/lib/active_element/default_controller/controller.rb

@@ -15,7 +15,8 @@ module ActiveElement
         controller.render 'active_element/default_views/index',
                           locals: {
                             collection: ordered(collection),
-                            search_filters: default_text_search.search_filters
+                            search_filters: default_text_search.search_filters,
+                            nested_for: nested_relations
                           }
       end
 
@@ -124,9 +125,12 @@ module ActiveElement
       end
 
       def collection
-        return model.all unless default_text_search.text_search?
+        return model.public_send(list_scope).where(nested_scope) unless default_text_search.text_search?
 
-        model.left_outer_joins(default_text_search.search_relations).where(*default_text_search.text_search)
+        model.public_send(list_scope)
+             .left_outer_joins(default_text_search.search_relations)
+             .where(nested_scope)
+             .where(*default_text_search.text_search)
       end
 
       def render_range_error(error:, action:)
@@ -140,6 +144,36 @@ module ActiveElement
 
         I18n.t('active_element.unexpected_error')
       end
+
+      def list_scope
+        return :all if state.list_scope.blank?
+        return state.list_scope.call(request) if state.list_scope.is_a?(Proc)
+
+        state.list_scope
+      end
+
+      def nested_scope
+        nested_params.presence || noop
+      end
+
+      def noop
+        Arel::Nodes::True.new.eq(Arel::Nodes::True.new)
+      end
+
+      def nested_params
+        route = controller.request.routes.recognize_path(controller.request.path)
+        route.reject { |key, _value| %w[controller action].include?(key.to_s) }
+      end
+
+      def nested_relations
+        return [] if nested_params.blank?
+
+        nested_params.map do |key, value|
+          collection.model.reflections.values.find do |reflection|
+            reflection.foreign_key.to_s == key.to_s
+          end&.klass&.find(value)
+        end.compact
+      end
     end
   end
 end

data/lib/active_element/default_controller/search.rb

@@ -25,6 +25,7 @@ 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 join(key, value) if key.to_s.include?('.')
           next model.arel_table[key].matches("#{value}%") if string_like_column?(key)
 
           model.arel_table[key].eq(value)
@@ -36,7 +37,15 @@ module ActiveElement
       end
 
       def search_relations
-        search_filters.to_h.keys.map { |key| relation?(key) ? key.to_sym : nil }.compact
+        relation_joins = search_filters.to_h.keys.map { |key| relation?(key) ? key.to_sym : nil }.compact
+        (relation_joins + shorthand_joins).uniq
+      end
+
+      def shorthand_joins
+        search_filters.to_h
+                      .keys
+                      .select { |key| key.to_s.include?('.') }
+                      .map { |key| key.partition('.').first.to_sym }
       end
 
       private
@@ -66,6 +75,11 @@ module ActiveElement
         end.compact
       end
 
+      def join(key, value)
+        table, _, column = key.to_s.partition('.')
+        relation(table).klass.arel_table[column].eq(value)
+      end
+
       def noop
         Arel::Nodes::True.new.eq(Arel::Nodes::True.new)
       end

data/lib/active_element/field_options.rb

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

data/lib/active_element/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_element
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.20
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-12 00:00:00.000000000 Z
+date: 2024-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bootstrap