glib-web 4.39.1 → 4.40.0

data/app/views/json_ui/garage/lists/edit_mode.json.jbuilder

@@ -6,61 +6,78 @@ render "#{@path_prefix}/nav_menu", json: json, page: page
 
 tab_index = params[:tab].to_i
 
-page.header childViews: ->(header) do
-  # Allow navigating to another "edit mode" page to test reuse issues.
-  header.tabBar buttons: ->(menu) do
-    ['FIRST', 'SECOND'].each_with_index do |text, index|
-      menu.button \
-        text: text,
-        disabled: tab_index == index,
-        onClick: ->(action) do
-          action.windows_reload url: json_ui_garage_url(path: 'lists/edit_mode', tab: index)
+page.header(
+  childViews: ->(header) do
+    # Allow navigating to another "edit mode" page to test reuse issues.
+    header.tabBar(
+      buttons: ->(menu) do
+        ['FIRST', 'SECOND'].each_with_index do |text, index|
+          menu.button(
+            text: text,
+            disabled: tab_index == index,
+            onClick: ->(action) do
+              action.windows_reload url: json_ui_garage_url(path: 'lists/edit_mode', tab: index)
+            end
+          )
         end
-    end
+      end
+    )
   end
-end
+)
 
-page.form \
+page.form(
   width: 'matchParent',
   url: json_ui_garage_url(path: 'forms/generic_post'),
   method: 'post',
   padding: glib_json_padding_body,
   childViews: ->(form) do
-    form.panels_list fieldPrefix: 'user[items]', fieldTitleName: 'name', width: 'matchParent', sections: [
-      ->(section) do
-        section.header padding: glib_json_padding_list, childViews: ->(header) do
-
-          header.panels_horizontal childViews: ->(horizontal) do
-            horizontal.fields_check name: 'user[check_all]', label: 'All', checkValue: true
-
-            horizontal.spacer width: 20
-            # header.fields_text width: 'matchParent', styleClass: 'outlined', name: 'user[new_name]', label: 'Item name'
-            statuses = [:pending, :active]
-            horizontal.fields_select \
-              styleClass: 'outlined',
-              name: 'user[status]',
-              width: 'matchParent',
-              label: 'Status',
-              options: statuses.map { |status| { value: status, text: status.to_s.humanize } }
-
-            horizontal.spacer width: 20
-            horizontal.fields_submit text: 'Update'
-          end
+    form.panels_list(
+      fieldPrefix: 'user[items]',
+      fieldTitleName: 'name',
+      width: 'matchParent',
+      sections: [
+    ->(section) do
+      section.header(
+        padding: glib_json_padding_list,
+        childViews: ->(header) do
+          header.panels_horizontal(
+            childViews: ->(horizontal) do
+              horizontal.fields_check name: 'user[check_all]', label: 'All', checkValue: true
+              horizontal.spacer width: 20
+              # header.fields_text width: 'matchParent', styleClass: 'outlined', name: 'user[new_name]', label: 'Item name'
+              statuses = [:pending, :active]
+              horizontal.fields_select(
+                styleClass: 'outlined',
+                name: 'user[status]',
+                width: 'matchParent',
+                label: 'Status',
+                options: statuses.map { |status| { value: status, text: status.to_s.humanize } }
+              )
+              horizontal.spacer width: 20
+              horizontal.fields_submit text: 'Update'
+            end
+          )
         end
-        section.rows builder: ->(row) do
+      )
+      section.rows(
+        builder: ->(row) do
           batch_count = 20
           batch_count.times do |index|
             id = (batch_count * tab_index) + index
             row.editable title: "Item #{id}", recordId: "PK_#{id}"
           end
         end
-      end
-    ], fieldCheckValueIf: {
-      "==": [
-        {
-          "var": 'user[check_all]'
-        },
-        true
-      ]
+      )
+    end
+    ],
+      fieldCheckValueIf: {
+    "==": [
+    {
+    "var": 'user[check_all]'
+    },
+    true
+    ]
     }
+    )
   end
+)

data/app/views/json_ui/garage/lists/templating.json.jbuilder

@@ -3,49 +3,73 @@ json.title 'Lists'
 json_ui_page json do |page|
   render "#{@path_prefix}/nav_menu", json: json, page: page
 
-  page.list firstSection: ->(section) do
-    section.header padding: { top: 12, left: 16, right: 16, bottom: 12 }, childViews: ->(header) do
-      header.h3 text: 'Section Header'
+  page.list(
+    firstSection: ->(section) do
+      section.header(
+        padding: { top: 12, left: 16, right: 16, bottom: 12 },
+        childViews: ->(header) do
+          header.h3 text: 'Section Header'
+        end
+      )
+      section.rows(
+        builder: ->(template) do
+          template.thumbnail(
+            title: 'Click me',
+            onClick: ->(action) do
+              action.windows_open url: json_ui_garage_url(path: 'home/blank')
+            end,
+            accessory: ->(accessory) do
+              accessory.header(
+                width: 'matchParent',
+                backgroundColor: '#b3bac2',
+                padding: { top: 10, bottom: 10, left: 10, right: 10 },
+                childViews: ->(bottom) do
+                  bottom.label text: 'Custom row header'
+                end
+              )
+              accessory.footer(
+                width: 'matchParent',
+                backgroundColor: '#b3bac2',
+                padding: { top: 10, bottom: 10, left: 10, right: 10 },
+                childViews: ->(bottom) do
+                  bottom.label text: 'Custom row footer'
+                end
+              )
+            end
+          )
+          template.thumbnail title: 'Item with icon and subtitle', subtitle: 'Item subtitle', icon: 'facebook'
+          template.thumbnail(
+            title: 'Item with chips',
+            chips: ->(menu) do
+              menu.button text: 'Finished', styleClass: 'info'
+              menu.button props: { text: 'Succeeded', styleClass: 'success' }
+            end
+          )
+          template.thumbnail(
+            title: 'Item with thumbnail image',
+            subtitle: 'Item subtitle',
+            imageUrl: glib_json_image_standard_url,
+          )
+          template.featured(
+            title: 'Featured with featured image',
+            subtitle: 'Item subtitle',
+            imageUrl: glib_json_image_standard_url
+          )
+          template.thumbnail(
+            title: 'Item with **formatted** text',
+            subtitle: 'Item *subtitle*',
+            textFormat: :markdown
+          )
+          # TODO
+          # template.thumbnail title: 'Item with accessories (Experimental)', subtitle: 'Item subtitle', accessoryViews: ->(thumbnail) do
+          #   thumbnail.panels_horizontal childViews: ->(horizontal) do
+          #     horizontal.chip text: 'finished'
+          #     horizontal.spacer width: 10
+          #     horizontal.chip text: 'succeeded'
+          #   end
+          # end
+        end
+      )
     end
-
-    section.rows builder: ->(template) do
-      template.thumbnail title: 'Click me', onClick: ->(action) do
-        action.windows_open url: json_ui_garage_url(path: 'home/blank')
-      end,
-      accessory: ->(accessory) do
-        accessory.header \
-          width: 'matchParent',
-          backgroundColor: '#b3bac2',
-          padding: { top: 10, bottom: 10, left: 10, right: 10 },
-          childViews: ->(bottom) do
-            bottom.label text: 'Custom row header'
-          end
-        accessory.footer \
-          width: 'matchParent',
-          backgroundColor: '#b3bac2',
-          padding: { top: 10, bottom: 10, left: 10, right: 10 },
-          childViews: ->(bottom) do
-            bottom.label text: 'Custom row footer'
-          end
-      end
-      template.thumbnail title: 'Item with icon and subtitle', subtitle: 'Item subtitle', icon: 'facebook'
-      template.thumbnail title: 'Item with chips', chips: ->(menu) do
-        menu.button text: 'Finished', styleClass: 'info'
-        menu.button props: { text: 'Succeeded', styleClass: 'success' }
-      end
-
-      template.thumbnail title: 'Item with thumbnail image', subtitle: 'Item subtitle', imageUrl: glib_json_image_standard_url
-      template.featured title: 'Featured with featured image', subtitle: 'Item subtitle', imageUrl: glib_json_image_standard_url
-
-      # TODO
-      # template.thumbnail title: 'Item with accessories (Experimental)', subtitle: 'Item subtitle', accessoryViews: ->(thumbnail) do
-      #   thumbnail.panels_horizontal childViews: ->(horizontal) do
-      #     horizontal.chip text: 'finished'
-      #     horizontal.spacer width: 10
-      #     horizontal.chip text: 'succeeded'
-      #   end
-      # end
-
-    end
-  end
+  )
 end

data/app/views/json_ui/garage/panels/timeline.json.jbuilder

@@ -3,85 +3,94 @@ json.title 'Timeline Panels'
 page = json_ui_page json
 render "#{@path_prefix}/nav_menu", json: json, page: page
 
-page.scroll padding: glib_json_padding_body, childViews: ->(scroll) do
-  timeline_items = [
-      { icon: 'place', color: '#4BB543' },
-      { icon: 'check_circle', color: 'blue' },
-      { icon: 'hourglass_empty', color: 'blue', text: 'Pending' },
-      { icon: 'radio_button_unchecked' },
-      { icon: 'radio_button_unchecked' },
+page.scroll(
+  padding: glib_json_padding_body,
+  childViews: ->(scroll) do
+    timeline_items = [
+    { icon: 'place', color: '#4BB543' },
+    { icon: 'check_circle', color: 'blue' },
+    { icon: 'hourglass_empty', color: 'blue', text: 'Pending' },
+    { icon: 'radio_button_unchecked' },
+    { icon: 'radio_button_unchecked' },
     ]
-
-  scroll.h2 text: 'Basic timeline'
-  scroll.panels_timeline \
-    events: timeline_items,
-    childViews: ->(timeline) do
-      timeline.label styleClass: 'mt-2', text: 'Order submitted'
-
-      timeline.label styleClass: 'mt-2', text: 'Finding you a driver'
-
-      timeline.panels_vertical styleClass: 'mt-2', childViews: ->(vertical) do
-        vertical.h4 text: 'Driver found, picking you up..'
-        vertical.spacer height: 16
-        render 'json_ui/garage/panels/timeline_content', tview: vertical
+    scroll.h2 text: 'Basic timeline'
+    scroll.panels_timeline(
+      events: timeline_items,
+      childViews: ->(timeline) do
+        timeline.label styleClass: 'mt-2', text: 'Order submitted'
+        timeline.label styleClass: 'mt-2', text: 'Finding you a driver'
+        timeline.panels_vertical(
+          styleClass: 'mt-2',
+          childViews: ->(vertical) do
+            vertical.h4 text: 'Driver found, picking you up..'
+            vertical.spacer height: 16
+            render 'json_ui/garage/panels/timeline_content', tview: vertical
+          end
+        )
+        timeline.label styleClass: 'mt-2', text: 'On the way'
+        timeline.label styleClass: 'mt-2', text: 'Arrived'
       end
-
-      timeline.label styleClass: 'mt-2', text: 'On the way'
-
-      timeline.label styleClass: 'mt-2', text: 'Arrived'
-    end
-
-  timeline_items = [
-      { icon: 'place', color: '#4BB543', styleClasses: ['outlined'] },
-      { icon: 'check_circle', color: 'blue', styleClasses: ['outlined'] },
-      { icon: 'check_circle', color: 'blue', styleClasses: ['outlined'] },
-      { icon: 'check_circle', color: 'blue', styleClasses: ['outlined'] },
-      { icon: 'flag', color: '#FFA500', styleClasses: ['outlined'] },
+    )
+    timeline_items = [
+    { icon: 'place', color: '#4BB543', styleClasses: ['outlined'] },
+    { icon: 'check_circle', color: 'blue', styleClasses: ['outlined'] },
+    { icon: 'check_circle', color: 'blue', styleClasses: ['outlined'] },
+    { icon: 'check_circle', color: 'blue', styleClasses: ['outlined'] },
+    { icon: 'flag', color: '#FFA500', styleClasses: ['outlined'] },
     ]
-
-  scroll.h2 text: 'Timeline with outlined dots'
-  scroll.panels_timeline \
-    events: timeline_items,
-    childViews: ->(timeline) do
-      timeline.panels_vertical childViews: ->(vertical) do
-        vertical.h4 text: 'Order submitted'
-        vertical.spacer height: 2
-        vertical.label text: '15 minutes ago'
-      end
-
-      timeline.panels_vertical childViews: ->(vertical) do
-        vertical.h4 text: 'Finding you a driver'
-        vertical.spacer height: 2
-        vertical.label text: '15 minutes ago'
-      end
-
-      timeline.panels_vertical childViews: ->(vertical) do
-        vertical.h4 text: 'Driver found'
-        vertical.spacer height: 2
-        vertical.label text: '12 minutes ago'
-      end
-
-      timeline.panels_vertical childViews: ->(vertical) do
-        vertical.h4 text: 'On the way'
-        vertical.spacer height: 2
-        vertical.label text: 'Duration: 11 minutes'
+    timeline_events = [
+    { title: 'Order submitted', time: '15 minutes ago' },
+    { title: 'Finding you a driver', time: '15 minutes ago' },
+    { title: 'Driver found', time: '12 minutes ago' },
+    { title: 'On the way', time: 'Duration: 11 minutes' },
+    { title: 'Arrived', time: '1 minute ago' }
+    ]
+    scroll.spacer height: 32
+    scroll.h2 text: 'Timeline with outlined dots'
+    scroll.panels_timeline(
+      events: timeline_items,
+      childViews: ->(timeline) do
+        timeline_events.each do |event|
+          timeline.panels_vertical(
+            childViews: ->(vertical) do
+              vertical.h4 text: event[:title]
+              vertical.spacer height: 2
+              vertical.label text: event[:time]
+            end
+          )
+        end
       end
+    )
 
-      timeline.panels_vertical childViews: ->(vertical) do
-        vertical.h4 text: 'Arrived'
-        vertical.spacer height: 2
-        vertical.label text: '1 minute ago'
+    scroll.spacer height: 32
+    scroll.h2 text: 'Timeline horizontal'
+    scroll.panels_timeline(
+      events: timeline_items,
+      direction: 'horizontal',
+      side: 'end',
+      childViews: ->(timeline) do
+        timeline_events.each do |event|
+          timeline.panels_vertical(
+            childViews: ->(vertical) do
+              vertical.h4 text: event[:title]
+              vertical.spacer height: 2
+              vertical.label text: event[:time]
+            end
+          )
+        end
       end
-    end
+    )
 
-  timeline_items = [
-      { backgroundColor: 'blue', styleClasses: ['small'] },
-      { backgroundColor: 'blue', styleClasses: ['x-small'] },
-      { backgroundColor: 'blue', color: 'white', text: '3' },
-      { backgroundColor: 'white', icon: 'radio_button_unchecked', styleClasses: ['small'] },
-      { backgroundColor: 'white', icon: 'radio_button_unchecked', styleClasses: ['small'] },
+    scroll.spacer height: 32
+    timeline_items = [
+    { backgroundColor: 'blue', styleClasses: ['small'] },
+    { backgroundColor: 'blue', styleClasses: ['x-small'] },
+    { backgroundColor: 'blue', color: 'white', text: '3' },
+    { backgroundColor: 'white', icon: 'radio_button_unchecked', styleClasses: ['small'] },
+    { backgroundColor: 'white', icon: 'radio_button_unchecked', styleClasses: ['small'] },
     ]
+    scroll.h2 text: 'Timeline without content'
+    scroll.panels_timeline truncateLine: 'both', events: timeline_items
 
-  scroll.h2 text: 'Timeline without content'
-  scroll.panels_timeline truncateLine: 'both', events: timeline_items
-end
+  end
+)

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

@@ -9,6 +9,9 @@ page.on load: ->(action) do
 end,
 reRender: ->(action) do
   action.snackbars_alert message: 'page.onRerender'
+end,
+foreground: ->(action) do
+  action.snackbars_alert message: 'page.onForeground'
 end
 
 page.body childViews: ->(body) do

data/app/views/json_ui/garage/views/markdowns.json.jbuilder

@@ -27,6 +27,8 @@ json_ui_page json do |page|
       "\n" +
       '~~Strikethrough~~' + "\n" +
       "\n" +
+      '<u>Underlined</u>' + "\n" +
+      "\n" +
       'https://www.google.com' + "\n"
 
     scroll.spacer height: 20

data/config/routes.rb

@@ -6,6 +6,10 @@ Glib::Web::Engine.routes.draw do
     delete 'json_ui_garage', to: 'home#json_ui_garage'
     post 'chat', to: 'home#chat'
 
+    get 'json_ui_api', to: 'api_docs#index'
+    get 'json_ui_api/:category', to: 'api_docs#show', as: :json_ui_api_category
+    get 'json_ui_api/:category/:component', to: 'api_docs#component', as: :json_ui_api_component
+
     resources :glib_direct_uploads, only: [:create]
     resources :blob_url_generators, only: [:create]
     resources :errors, only: [:create]

data/lib/glib/rubocop/cops/test_name_parentheses.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Glib
+      # Prevents test method names from containing parentheses which can cause issues with test runners
+      #
+      # @example
+      #   # bad
+      #   test 'user creation (with email)' do
+      #   end
+      #
+      #   # good
+      #   test 'user creation with email' do
+      #   end
+      class TestNameParentheses < Base
+        MSG = "Test name should not contain parentheses because for some reason, this will produce: 'Syntax error: \"(\" unexpected'."
+
+        def_node_matcher :test_method?, <<~PATTERN
+          (send nil? :test (str $_) ...)
+        PATTERN
+
+        def on_send(node)
+          test_method?(node) do |test_name|
+            if test_name.include?('(') || test_name.include?(')')
+              add_offense(node)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/glib/rubocop.rb

@@ -3,3 +3,4 @@ require_relative 'rubocop/cops/multiline_method_call_style'
 require_relative 'rubocop/cops/json_ui/base_nested_parameter'
 require_relative 'rubocop/cops/json_ui/nested_block_parameter'
 require_relative 'rubocop/cops/json_ui/nested_action_parameter'
+require_relative 'rubocop/cops/test_name_parentheses'

data/lib/glib/snapshot.rb

@@ -23,17 +23,25 @@ module Glib
       return true if changed?
 
       associations_for_snapshot.each do |association_name|
-        if (association = self.class.reflect_on_association(association_name))
-          case association.macro
-          when :has_many
-            public_send(association_name).each do |record|
-              return true if record.changed?
-            end
-          when :has_one, :belongs_to
-            return true if public_send(association_name).changed?
+        association = self.class.reflect_on_association(association_name)
+        association_value = public_send(association_name)
+
+        if active_storage_association?(association, association_value)
+          active_storage_records(association_value).each do |record|
+            return true if record.changed?
           end
-        else
-          raise "Invalid association: #{association_name}"
+          next
+        end
+
+        raise "Invalid association: #{association_name}" if association.nil?
+
+        case association.macro
+        when :has_many
+          association_value.each do |record|
+            return true if record.changed?
+          end
+        when :has_one, :belongs_to
+          return true if association_value&.changed?
         end
       end
 
@@ -134,7 +142,7 @@ module Glib
       end
 
       # always watch column with name *id
-      ignore_keys.filter! { |key| !key.ends_with?('id') || key != 'id' }
+      ignore_keys.reject! { |key| key == 'id' || key.ends_with?('_id') }
 
       if snapshot.present?
         item, associations = snapshot.fetch_reified_items
@@ -147,15 +155,18 @@ module Glib
         'item' => ::Hashdiff.diff(item.attributes.except(*ignore_keys), attributes.except(*ignore_keys))
       }
 
-      obj['associations'] = associations_for_snapshot.reduce({}) do |prev, curr|
-        first_record_off_same_collection = send(curr).first
+      obj['associations'] = associations_for_snapshot.reduce({}) do |prev, curr| # rubocop:disable Glib/MultilineMethodCallStyle
+        association_records = records_for_snapshot(curr)
+        first_record_off_same_collection = association_records.first
 
-        if !first_record_off_same_collection.respond_to?(:watched_keys_for_snapshot) && !first_record_off_same_collection.nil?
+        if !first_record_off_same_collection.nil? && !active_storage_record?(first_record_off_same_collection) && !first_record_off_same_collection.respond_to?(:watched_keys_for_snapshot)
           raise NotImplementedError, "please add method 'watched_keys_for_snapshot' to #{first_record_off_same_collection.class}"
         end
 
         association_ignored_keys =
-          if !first_record_off_same_collection.try(:watched_keys_for_snapshot).nil?
+          if active_storage_record?(first_record_off_same_collection)
+            default_ignored_keys
+          elsif !first_record_off_same_collection.try(:watched_keys_for_snapshot).nil?
             assoc_ignore_keys = first_record_off_same_collection.attributes.except(*first_record_off_same_collection.watched_keys_for_snapshot.map(&:to_s)).keys.map(&:to_s)
             (default_ignored_keys + assoc_ignore_keys).uniq
           else
@@ -163,13 +174,13 @@ module Glib
           end
 
         # always watch column with name *id
-        association_ignored_keys.filter! { |key| !key.ends_with?('id') || key != 'id' }
+        association_ignored_keys.reject! { |key| key == 'id' || key.ends_with?('_id') }
 
         # attrs_before = (associations[curr] || []).map { |record| record.attributes.except(*association_ignored_keys) }
         # attrs_now = send(curr).order(id: :asc).map { |record| record.attributes.except(*association_ignored_keys) }
 
         before = (associations[curr] || [])
-        now = send(curr).order(id: :asc)
+        now = association_records
 
         if before.blank?
           prev.merge(curr.to_s => ::Hashdiff.diff([], now.map { |record| record.attributes.except(*association_ignored_keys) }))
@@ -238,5 +249,52 @@ module Glib
     def max_snapshots
       10
     end
+
+    private
+      def active_storage_association?(association, association_value)
+        return true if association&.macro == :has_many_attached || association&.macro == :has_one_attached
+        return false if association_value.nil?
+
+        if defined?(ActiveStorage::Attached)
+          return true if association_value.is_a?(ActiveStorage::Attached::Many) || association_value.is_a?(ActiveStorage::Attached::One)
+        end
+
+        association_value.respond_to?(:attachments) || association_value.respond_to?(:attachment)
+      end
+
+      def active_storage_records(value)
+        if value.respond_to?(:attachments)
+          value.attachments
+        elsif value.respond_to?(:attachment)
+          Array(value.attachment).compact
+        else
+          []
+        end
+      end
+
+      def active_storage_record?(record)
+        return false if record.nil?
+
+        (defined?(ActiveStorage::Attachment) && record.is_a?(ActiveStorage::Attachment)) ||
+          record.class.name.start_with?('ActiveStorage::Attachment')
+      end
+
+      def records_for_snapshot(association_name)
+        association_value = public_send(association_name)
+
+        records = if active_storage_association?(self.class.reflect_on_association(association_name), association_value)
+          active_storage_records(association_value)
+        else
+          association_value
+        end
+
+        if records.respond_to?(:order)
+          records.order(id: :asc)
+        elsif records.respond_to?(:sort_by)
+          records.sort_by { |record| record.try(:id) || 0 }
+        else
+          Array(records)
+        end
+      end
   end
 end