glib-web 5.0.7 → 5.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6885a1b150291881895f5b3cdfda3c2424961e5fd953e7faebd2d421242d930c
-  data.tar.gz: 2c9b74ee8ac40b6b887d3b14a06915b98b0562a207d578d63b955a12b7e235f9
+  metadata.gz: ad9135a710cddc6a961596146b40ff9a33f91357de190b94843ed054d8bb6188
+  data.tar.gz: 0e01d6df7e9a7a3db6b4cbb380970e6e68a75797559e4341e6fab1212626f187
 SHA512:
-  metadata.gz: 67e1d34169a5cea5970378da912372ff6b0c5b1e0b7793c9e05fc50347cd1e118f55d0b9b63a328a60fdff810c913ba94575198eee0cd147d161feb8272c6c27
-  data.tar.gz: dadf602d4b72f9c2c2ef4434182c94eb6690f05e1ec934226de01d8c24cef88719f29cba394d12c5e13df93e82144f46ae8425443b4318807780bcde5381d761
+  metadata.gz: b33f64738a36e98fb1dccd6422a9dc0c0acdb5ad91f1d6c0276dd672314130809d2dc668129b888599ac4696a0c57b3c1bbfa82998937f705cdcec125ae96c37
+  data.tar.gz: 3949cb0ee96b5955f716eea9d423e2ae7564d8b41ee9f2cbd482535bd332716a539c0ef5492be88de4cc4ca6ec27e4f4597eb8b51ee4290c181aefbf5345ec59

data/app/helpers/glib/json_ui/action_builder.rb

@@ -182,6 +182,12 @@ module Glib
           hash :row
           action :onAppend
         end
+
+        class Remove < Action
+          string :targetId
+          string :rowId
+          action :onRemove
+        end
       end
 
       module Cookies

data/app/models/concerns/glib/soft_deletable.rb

@@ -10,6 +10,11 @@ module Glib
   module SoftDeletable
     extend ActiveSupport::Concern
 
+    # Dedicated deprecator so warnings can be silenced/behave independently of Rails'.
+    def self.deprecator
+      @deprecator ||= ActiveSupport::Deprecation.new('6.0', 'glib-web')
+    end
+
     module ClassMethods
       def auto_hide_soft_deleted_records
         column_name = :deleted_at
@@ -28,6 +33,44 @@ module Glib
       def __mark_for_destruction_behaviour
         @__glib_mark_for_destruction_behaviour ||= :disallowed
       end
+
+      # Declarative way to register associations that should be soft-deleted together with this record.
+      # Preferred over overriding `soft_deletable_associations` because it lets us validate at load time
+      # (in dev/test) that each association exists and its model is itself soft-deletable.
+      #
+      # NOTE: Declare the associations (e.g. `has_many`) *before* calling this so the reflection exists.
+      def soft_deletes_with(*association_names)
+        @__glib_soft_deletable_associations = association_names.map(&:to_sym)
+
+        if Rails.env.development? || Rails.env.test?
+          @__glib_soft_deletable_associations.each { |name| __validate_soft_deletable_association!(name) }
+        end
+      end
+
+      def __soft_deletable_associations
+        @__glib_soft_deletable_associations ||= []
+      end
+
+      def __validate_soft_deletable_association!(name)
+        reflection = reflect_on_association(name)
+        unless reflection
+          raise(
+            ActiveRecord::ConfigurationError,
+            "#{self.name} declares `soft_deletes_with #{name.inspect}` but has no association `#{name}`. " \
+            'Make sure the association is declared before `soft_deletes_with`.'
+          )
+        end
+
+        return if reflection.polymorphic? # Can't resolve a single target class for polymorphic associations.
+
+        return if reflection.klass.include?(Glib::SoftDeletable)
+
+        raise(
+          ActiveRecord::ConfigurationError,
+          "#{self.name} declares `soft_deletes_with #{name.inspect}`, " \
+          "but #{reflection.klass.name} does not include Glib::SoftDeletable"
+        )
+      end
     end
 
     included do
@@ -85,6 +128,8 @@ module Glib
       # records are updated/validated one at a time.
       # Besides, it's probably not a good idea to prevent soft-deletion of objects that are already not valid.
       def _soft_destroy
+        return if deleted? # Already soft-deleted. Stop here to avoid redundant work and infinite recursion on circular associations.
+
         before_soft_destroy
         update_columns(deleted_at: DateTime.current) # rubocop:disable Rails/SkipsModelValidations
         after_soft_destroy
@@ -92,6 +137,8 @@ module Glib
       end
 
       def _undo_soft_destroy
+        return unless deleted? # Already restored. Stop here to avoid redundant work and infinite recursion on circular associations.
+
         undo_soft_destroy_associated_records
         update_columns(deleted_at: nil) # rubocop:disable Rails/SkipsModelValidations
       end
@@ -130,25 +177,48 @@ module Glib
         end
 
         def soft_destroy_associated_records
-          soft_deletable_associations.each do |relationship|
-            process_soft_deletable_relationship(relationship) { |record| record._soft_destroy }
+          __resolved_soft_deletable_associations.each do |relationship|
+            process_soft_deletable_relationship(relationship) do |record|
+              assert_soft_deletable!(relationship, record)
+              record._soft_destroy
+            end
           end
         end
 
         def undo_soft_destroy_associated_records
-          soft_deletable_associations.each do |relationship|
-            process_soft_deletable_relationship(relationship) { |record| record._undo_soft_destroy }
+          __resolved_soft_deletable_associations.each do |relationship|
+            process_soft_deletable_relationship(relationship) do |record|
+              assert_soft_deletable!(relationship, record)
+              record._undo_soft_destroy
+            end
           end
         end
 
-        # This should return an array of all associated records of an object that
-        # should be soft deleted with it. This provides a non-intrusive way that can
-        # co-exist with hard deletion (e.g. using `dependent: :destroy`), which means
-        # that the model can use both for different purposes.
-        # For example, a model may use soft-deletion for archiving and hard-deletion
-        # for editing (e.g. using `accepts_nested_attributes_for``)
-        def soft_deletable_associations
-          []
+        # Resolves the associations to soft-delete. Honours a (deprecated) override of
+        # `soft_deletable_associations` if present, warning the caller; otherwise returns
+        # the associations declared via `soft_deletes_with`.
+        def __resolved_soft_deletable_associations
+          if method(:soft_deletable_associations).owner != Glib::SoftDeletable
+            Glib::SoftDeletable.deprecator.warn(
+              "Overriding `#{self.class.name}#soft_deletable_associations` is deprecated and will be " \
+              'removed; declare associations with the `soft_deletes_with` class macro instead.'
+            )
+          end
+
+          soft_deletable_associations
+        end
+
+        # Fail fast (and clearly) when an association is registered in `soft_deletable_associations`
+        # but its model doesn't include `Glib::SoftDeletable`. Otherwise this would surface as an
+        # obscure `NoMethodError` for `_soft_destroy`/`_undo_soft_destroy`.
+        def assert_soft_deletable!(relationship, record)
+          return if record.respond_to?(:_soft_destroy)
+
+          raise(
+            ActiveRecord::ConfigurationError,
+            "#{self.class.name} registers `#{relationship}` in `soft_deletable_associations`, " \
+            "but #{record.class.name} does not include Glib::SoftDeletable"
+          )
         end
 
         def before_soft_destroy
@@ -159,5 +229,20 @@ module Glib
           # To be overridden
         end
     end
+
+    # Returns the names of associations that should be soft deleted together with this record.
+    #
+    # Declare them with the `soft_deletes_with` class macro (validated at load time). This provides
+    # a non-intrusive way that can co-exist with hard deletion (e.g. using `dependent: :destroy`),
+    # which means that the model can use both for different purposes. For example, a model may use
+    # soft-deletion for archiving and hard-deletion for editing (e.g. `accepts_nested_attributes_for`).
+    #
+    # @deprecated Overriding this instance method is deprecated; use `soft_deletes_with` instead.
+    #   Kept as a module method (rather than defined in `included do`) so that overrides in the
+    #   host class are detectable, letting us emit a deprecation warning.
+    private
+      def soft_deletable_associations
+        self.class.__soft_deletable_associations
+      end
   end
 end

data/app/views/json_ui/garage/test_page/_header.json.jbuilder

@@ -11,7 +11,6 @@ nav_groups = {
     'http',
     'lifecycle',
     'logics_set',
-    'lists_append',
     'panels',
     'popovers',
     'sheets',

data/app/views/json_ui/garage/test_page/fields.json.jbuilder

@@ -142,6 +142,29 @@ page.body(
         res.hr width: 'matchParent'
         res.spacer height: 16
 
+        res.h2 text: 'Tooltip affordance'
+        res.spacer height: 8
+        res.label text: 'A checkbox whose label carries a tooltip gets a dotted-underline "hover for info" affordance.'
+        res.spacer height: 8
+        res.fields_check(
+          id: 'field_terms',
+          name: 'user[terms]',
+          label: 'Accept terms and conditions',
+          checkValue: true,
+          tooltip: { text: 'You must accept the terms before continuing.' }
+        )
+        res.spacer height: 8
+        res.fields_check(
+          id: 'field_news',
+          name: 'user[news]',
+          label: 'Subscribe to newsletter (no tooltip)',
+          checkValue: true
+        )
+
+        res.spacer height: 16
+        res.hr width: 'matchParent'
+        res.spacer height: 16
+
         res.h2 text: 'Edge/advanced'
         res.spacer height: 8
         res.button(

data/app/views/json_ui/garage/test_page/fields_date_time.json.jbuilder

@@ -204,6 +204,10 @@ page.body(
                     action.components_set targetId: 'datetime_plain', data: { template: { type: 'plain' } }
                   end
                 )
+                flow.spacer width: 8
+                flow.fields_submit(
+                  text: 'Submit'
+                )
               end
             )
           end

data/app/views/json_ui/garage/test_page/fields_select.json.jbuilder

@@ -34,6 +34,13 @@ page.body(
               option.merge(imageUrl: "https://picsum.photos/seed/select-#{index + 1}/32/24")
             end
 
+            subtitle_options = [
+              { text: 'Apple', value: 'apple', subtitle: 'A sweet red fruit' },
+              { text: 'Banana', value: 'banana', subtitle: 'A long yellow fruit' },
+              { text: 'Carrot', value: 'carrot', subtitle: 'An orange root vegetable' },
+              { text: 'Daikon', value: 'daikon', subtitle: 'A white root vegetable' }
+            ]
+
             form.h2 text: 'Basic example'
             form.spacer height: 8
             form.fields_select(
@@ -53,6 +60,24 @@ page.body(
             form.hr width: 'matchParent'
             form.spacer height: 12
 
+            form.h2 text: 'Searchable with subtitle'
+            form.spacer height: 8
+            form.label text: 'Type to filter options by text or subtitle (filterBySubtitle).'
+            form.spacer height: 8
+            form.fields_select(
+              id: 'select_searchable_subtitle',
+              name: 'user[select_searchable_subtitle]',
+              label: 'Searchable select with subtitle',
+              width: 'matchParent',
+              searchable: true,
+              clearable: true,
+              options: subtitle_options
+            )
+
+            form.spacer height: 12
+            form.hr width: 'matchParent'
+            form.spacer height: 12
+
             form.h2 text: 'Variants/props'
             form.spacer height: 8
             form.label text: 'Swap options between icon and image styles.'

data/app/views/json_ui/garage/test_page/list.json.jbuilder

@@ -105,6 +105,193 @@ page.body(
             render 'json_ui/garage/lists/autoload_section', page: page, page_index: 0
           end
         )
+
+        res.spacer height: 12
+        res.hr width: 'matchParent'
+        res.h2 text: 'Append rows (lists/append)'
+        res.spacer height: 8
+        res.label text: 'Use lists/append when a list should grow without a full refresh.'
+        res.spacer height: 8
+        res.label id: 'lists_append_status', text: 'Status: idle'
+        res.spacer height: 8
+        res.panels_list id: 'list_append_demo', firstSection: ->(section) do
+          section.rows builder: ->(template) do
+            template.thumbnail title: 'Starter row', subtitle: 'Existing item'
+          end
+        end
+        res.spacer height: 8
+        res.panels_flow(
+          innerPadding: { bottom: 0 },
+          childViews: ->(flow) do
+            flow.button(
+              text: 'lists/append (thumbnail)',
+              onClick: ->(action) do
+                action.lists_append(
+                  targetId: 'list_append_demo',
+                  row: {
+                    template: 'thumbnail',
+                    title: "New row #{DateTime.current.to_i}",
+                    subtitle: 'Appended via action'
+                  },
+                  onAppend: ->(subaction) do
+                    subaction.logics_set targetId: 'lists_append_status', data: { text: 'Status: appended' }
+                  end
+                )
+              end
+            )
+            flow.spacer width: 4
+            flow.button(
+              text: 'Append + snackbar',
+              onClick: ->(action) do
+                action.lists_append(
+                  targetId: 'list_append_demo',
+                  row: {
+                    template: 'thumbnail',
+                    title: 'Snackbar row',
+                    subtitle: 'onAppend triggers feedback'
+                  },
+                  onAppend: ->(subaction) do
+                    subaction.snackbars_alert message: 'Row appended'
+                  end
+                )
+              end
+            )
+            flow.spacer width: 4
+            flow.button(
+              text: 'Append two rows',
+              onClick: ->(action) do
+                action.runMultiple(
+                  childActions: ->(multi) do
+                    multi.lists_append(
+                      targetId: 'list_append_demo',
+                      row: { template: 'thumbnail', title: 'Batch row A', subtitle: 'RunMultiple append' }
+                    )
+                    multi.lists_append(
+                      targetId: 'list_append_demo',
+                      row: { template: 'thumbnail', title: 'Batch row B', subtitle: 'RunMultiple append' }
+                    )
+                  end
+                )
+              end
+            )
+          end
+        )
+
+        res.spacer height: 12
+        res.hr width: 'matchParent'
+        res.h2 text: 'Remove a row by id (lists/remove)'
+        res.spacer height: 8
+        res.label text: 'lists/remove deletes a row by id in-place, preserving scroll position and loaded pages.'
+        res.spacer height: 8
+        res.label id: 'lists_remove_status', text: 'Status: idle'
+        res.spacer height: 8
+        res.panels_list id: 'list_remove_demo', firstSection: ->(section) do
+          section.rows builder: ->(template) do
+            template.thumbnail id: 'remove_row_alpha', title: 'Removable Alpha', subtitle: 'id: remove_row_alpha'
+            template.thumbnail id: 'remove_row_bravo', title: 'Removable Bravo', subtitle: 'id: remove_row_bravo'
+            template.thumbnail id: 'remove_row_charlie', title: 'Removable Charlie', subtitle: 'id: remove_row_charlie'
+          end
+        end
+        res.spacer height: 8
+        res.panels_flow(
+          innerPadding: { bottom: 0 },
+          childViews: ->(flow) do
+            flow.button(
+              text: 'Remove Alpha',
+              onClick: ->(action) do
+                action.lists_remove(
+                  targetId: 'list_remove_demo',
+                  rowId: 'remove_row_alpha',
+                  onRemove: ->(subaction) do
+                    subaction.logics_set targetId: 'lists_remove_status', data: { text: 'Status: removed Alpha' }
+                  end
+                )
+              end
+            )
+            flow.spacer width: 4
+            flow.button(
+              text: 'Remove Bravo',
+              onClick: ->(action) do
+                action.lists_remove(
+                  targetId: 'list_remove_demo',
+                  rowId: 'remove_row_bravo',
+                  onRemove: ->(subaction) do
+                    subaction.logics_set targetId: 'lists_remove_status', data: { text: 'Status: removed Bravo' }
+                  end
+                )
+              end
+            )
+            flow.spacer width: 4
+            flow.button(
+              text: 'Remove missing (no-op)',
+              onClick: ->(action) do
+                action.lists_remove(
+                  targetId: 'list_remove_demo',
+                  rowId: 'does_not_exist',
+                  onRemove: ->(subaction) do
+                    subaction.logics_set targetId: 'lists_remove_status', data: { text: 'Status: onRemove ran (no row matched)' }
+                  end
+                )
+              end
+            )
+          end
+        )
+
+        res.spacer height: 12
+        res.hr width: 'matchParent'
+        res.h2 text: 'Target a row by id (logics/set)'
+        res.spacer height: 8
+        res.label text: "A row template's id now registers in GLib.component, so logics/set (and components/replace) can target the whole row instead of juggling ids on inner elements."
+        res.spacer height: 8
+        res.panels_list id: 'list_target_demo', firstSection: ->(section) do
+          section.rows builder: ->(template) do
+            template.thumbnail id: 'target_row_alpha', title: 'Target Alpha', subtitle: 'id: target_row_alpha', imageUrl: glib_json_image_standard_url
+            template.thumbnail id: 'target_row_bravo', title: 'Target Bravo', subtitle: 'id: target_row_bravo', imageUrl: glib_json_image_standard_url
+          end
+        end
+        res.spacer height: 8
+        res.panels_flow(
+          innerPadding: { bottom: 0 },
+          childViews: ->(flow) do
+            flow.button(
+              text: 'Update Alpha (logics/set)',
+              onClick: ->(action) do
+                action.logics_set targetId: 'target_row_alpha', data: { title: 'Target Alpha (updated)', subtitle: 'Updated via logics/set on the row id' }
+              end
+            )
+            flow.spacer width: 4
+            flow.button(
+              text: 'Update Bravo (logics/set)',
+              onClick: ->(action) do
+                action.logics_set targetId: 'target_row_bravo', data: { title: 'Target Bravo (updated)', subtitle: 'Updated via logics/set on the row id' }
+              end
+            )
+          end
+        )
+
+        res.spacer height: 12
+        res.hr width: 'matchParent'
+        res.h2 text: 'Custom row template (row.custom)'
+        res.spacer height: 8
+        res.label text: 'row.custom renders a chosen template from a data payload, mirroring panels/custom.'
+        res.spacer height: 8
+        res.panels_list id: 'list_custom_demo', firstSection: ->(section) do
+          section.rows builder: ->(template) do
+            template.custom(
+              template: 'thumbnail',
+              data: { title: 'Custom (thumbnail)', subtitle: 'Rendered via row.custom', imageUrl: glib_json_image_standard_url }
+            )
+            template.custom(
+              template: 'featured',
+              data: { title: 'Custom (featured)', subtitle: 'Rendered via row.custom', imageUrl: glib_json_image_standard_url }
+            )
+            template.custom(
+              template: 'nonExistentTemplate',
+              data: { title: 'Missing template', subtitle: 'Falls back to template-unsupported' }
+            )
+          end
+        end
+
         res.spacer height: 12
         res.hr width: 'matchParent'
         res.h2 text: 'Edge and Advanced'

metadata

@@ -1,11 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: glib-web
 version: !ruby/object:Gem::Version
-  version: 5.0.7
+  version: 5.0.8
 platform: ruby
 authors:
 - ''
-autorequire:
 bindir: bin
 cert_chain: []
 date: 2019-10-04 00:00:00.000000000 Z
@@ -150,7 +149,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email: ''
 executables: []
 extensions: []
@@ -428,7 +426,6 @@ files:
 - app/views/json_ui/garage/test_page/lifecycle.json.jbuilder
 - app/views/json_ui/garage/test_page/list.json.jbuilder
 - app/views/json_ui/garage/test_page/list_editable.json.jbuilder
-- app/views/json_ui/garage/test_page/lists_append.json.jbuilder
 - app/views/json_ui/garage/test_page/logics_set.json.jbuilder
 - app/views/json_ui/garage/test_page/multimedia_video.json.jbuilder
 - app/views/json_ui/garage/test_page/pagination.json.jbuilder
@@ -530,10 +527,8 @@ files:
 - lib/glib/value.rb
 - lib/glib/version.rb
 - lib/tasks/db.rake
-homepage:
 licenses: []
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -548,8 +543,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
 summary: ''
 test_files: []

data/app/views/json_ui/garage/test_page/lists_append.json.jbuilder

@@ -1,152 +0,0 @@
-json.title 'Test Page (Lists Append)'
-
-page = json_ui_page json
-
-render 'json_ui/garage/test_page/header', json: json, page: page
-
-page.body(
-  childViews: ->(body) do
-    body.panels_responsive(
-      padding: glib_json_padding_body,
-      childViews: ->(res) do
-        res.h2 text: 'Lists Append'
-        res.label text: 'Append rows to list panels from actions for live updates.'
-        res.spacer height: 12
-        res.hr width: 'matchParent'
-        res.spacer height: 12
-
-        res.h2 text: 'Overview'
-        res.label text: 'Use lists/append when a list should grow without a full refresh.'
-        res.spacer height: 12
-        res.hr width: 'matchParent'
-        res.spacer height: 12
-
-        res.h2 text: 'Basic example'
-        res.spacer height: 8
-        res.label id: 'lists_append_status', text: 'Status: idle'
-        res.spacer height: 8
-        res.panels_list id: 'list_append_demo', firstSection: ->(section) do
-          section.rows builder: ->(template) do
-            template.thumbnail title: 'Starter row', subtitle: 'Existing item'
-          end
-        end
-        res.spacer height: 8
-        res.button(
-          text: 'lists/append (thumbnail)',
-          onClick: ->(action) do
-            action.lists_append(
-              targetId: 'list_append_demo',
-              row: {
-                template: 'thumbnail',
-                title: "New row #{DateTime.current.to_i}",
-                subtitle: 'Appended via action'
-              },
-              onAppend: ->(subaction) do
-                subaction.logics_set targetId: 'lists_append_status', data: { text: 'Status: appended' }
-              end
-            )
-          end
-        )
-
-        res.spacer height: 16
-        res.hr width: 'matchParent'
-        res.spacer height: 16
-
-        res.h2 text: 'Variants/props'
-        res.spacer height: 8
-        res.panels_flow(
-          innerPadding: { bottom: 0 },
-          width: 'matchParent',
-          childViews: ->(flow) do
-            flow.button(
-              text: 'Append standard row',
-              onClick: ->(action) do
-                action.lists_append(
-                  targetId: 'list_append_demo',
-                  row: {
-                    template: 'standard',
-                    title: 'Standard row',
-                    subtitle: 'Uses the standard template'
-                  }
-                )
-              end
-            )
-            flow.spacer width: 8
-            flow.button(
-              text: 'Append + snackbar',
-              onClick: ->(action) do
-                action.lists_append(
-                  targetId: 'list_append_demo',
-                  row: {
-                    template: 'thumbnail',
-                    title: 'Snackbar row',
-                    subtitle: 'onAppend triggers feedback'
-                  },
-                  onAppend: ->(subaction) do
-                    subaction.snackbars_alert message: 'Row appended'
-                  end
-                )
-              end
-            )
-          end
-        )
-
-        res.spacer height: 16
-        res.hr width: 'matchParent'
-        res.spacer height: 16
-
-        res.h2 text: 'Actions/events'
-        res.spacer height: 8
-        res.button(
-          text: 'Append two rows',
-          onClick: ->(action) do
-            action.runMultiple(
-              childActions: ->(multi) do
-                multi.lists_append(
-                  targetId: 'list_append_demo',
-                  row: {
-                    template: 'thumbnail',
-                    title: 'Batch row A',
-                    subtitle: 'RunMultiple append'
-                  }
-                )
-                multi.lists_append(
-                  targetId: 'list_append_demo',
-                  row: {
-                    template: 'thumbnail',
-                    title: 'Batch row B',
-                    subtitle: 'RunMultiple append'
-                  }
-                )
-              end
-            )
-          end
-        )
-
-        res.spacer height: 16
-        res.hr width: 'matchParent'
-        res.spacer height: 16
-
-        res.h2 text: 'Edge/advanced'
-        res.spacer height: 8
-        res.label text: 'Append into an empty list'
-        res.spacer height: 8
-        res.panels_list id: 'list_append_empty', sections: []
-        res.spacer height: 8
-        res.button(
-          text: 'lists/append (empty list)',
-          onClick: ->(action) do
-            action.lists_append(
-              targetId: 'list_append_empty',
-              row: {
-                template: 'standard',
-                title: 'First row',
-                subtitle: 'Created from empty list'
-              }
-            )
-          end
-        )
-      end
-    )
-  end
-)