Merge pull request #9 from blocknotes/feat/improve-layout-structure

blocknotes · web-flow · commit 9b7006a49d5d · 2023-04-10T20:55:30.000+02:00
feat: improve layout structure
diff --git a/lib/tiny_admin/actions/index.rb b/lib/tiny_admin/actions/index.rb
@@ -14,11 +14,10 @@ def call(app:, context:, options:, actions:)
         title = repository.index_title
         pages = (total_count / pagination) + 1
 
-        prepare_page(Views::Actions::Index, title: title, context: context, query_string: query_string) do |page|
+        prepare_page(Views::Actions::Index, context: context) do |page|
           page.setup_pagination(current_page: current_page, pages: pages > 1 ? pages : false)
           page.setup_records(records: records, fields: fields, prepare_record: prepare_record)
-          page.actions = actions
-          page.filters = filters
+          page.update_attributes(actions: actions, filters: filters, query_string: query_string, title: title)
         end
       end
 
@@ -37,7 +36,8 @@ def evaluate_options(options)
       end
 
       def prepare_filters(fields, filters_list)
-        filters = (filters_list || []).map { _1.is_a?(Hash) ? _1 : { field: _1 } }.index_by { _1[:field] }
+        filters = (filters_list || []).map { _1.is_a?(Hash) ? _1 : { field: _1 } }
+        filters = filters.each_with_object({}) { |filter, result| result[filter[:field]] = filter }
         values = (params['q'] || {})
         fields.each_with_object({}) do |field, result|
           result[field] = { value: values[field.name], filter: filters[field.name] } if filters.key?(field.name)
diff --git a/lib/tiny_admin/actions/show.rb b/lib/tiny_admin/actions/show.rb
@@ -11,9 +11,9 @@ def call(app:, context:, options:, actions:)
         prepare_record = ->(record_data) { repository.show_record_attrs(record_data, fields: fields_options) }
         fields = repository.fields(options: fields_options)
 
-        prepare_page(Views::Actions::Show, title: repository.show_title(record), context: context) do |page|
+        prepare_page(Views::Actions::Show, context: context) do |page|
           page.setup_record(record: record, fields: fields, prepare_record: prepare_record)
-          page.actions = actions
+          page.update_attributes(actions: actions, title: repository.show_title(record))
         end
       rescue Plugins::BaseRepository::RecordNotFound => _e
         prepare_page(options[:record_not_found_page] || Views::Pages::RecordNotFound)
diff --git a/lib/tiny_admin/authentication.rb b/lib/tiny_admin/authentication.rb
@@ -25,11 +25,11 @@ class Authentication < BasicApp
 
     def render_login(notices: nil, warnings: nil, errors: nil)
       page = prepare_page(settings.authentication[:login], options: %i[no_menu compact_layout])
-      page.setup_flash_messages(
+      page.messages = {
         notices: notices || flash['notices'],
         warnings: warnings || flash['warnings'],
         errors: errors || flash['errors']
-      )
+      }
       render(inline: page.call)
     end
   end
diff --git a/lib/tiny_admin/basic_app.rb b/lib/tiny_admin/basic_app.rb
@@ -20,11 +20,5 @@ def authentication_plugin
     plugin authentication_plugin, TinyAdmin::Settings.instance.authentication
 
     not_found { prepare_page(settings.page_not_found).call }
-
-    def attach_flash_messages(page)
-      return unless page.respond_to?(:setup_flash_messages)
-
-      page.setup_flash_messages(notices: flash['notices'], warnings: flash['warnings'], errors: flash['errors'])
-    end
   end
 end
diff --git a/lib/tiny_admin/router.rb b/lib/tiny_admin/router.rb
@@ -41,7 +41,9 @@ class Router < BasicApp
     private
 
     def render_page(page)
-      attach_flash_messages(page)
+      if page.respond_to?(:messages=)
+        page.messages = { notices: flash['notices'], warnings: flash['warnings'], errors: flash['errors'] }
+      end
       render(inline: page.call)
     end
 
diff --git a/lib/tiny_admin/settings.rb b/lib/tiny_admin/settings.rb
@@ -40,7 +40,6 @@ def load_settings
 
       @root ||= {}
       @root[:title] ||= 'TinyAdmin'
-      @root[:path] ||= root_path
       @root[:page] ||= Views::Pages::Root
 
       if @authentication[:plugin] == Plugins::SimpleAuth
diff --git a/lib/tiny_admin/utils.rb b/lib/tiny_admin/utils.rb
@@ -13,14 +13,10 @@ def params_to_s(params)
       list.join('&')
     end
 
-    def prepare_page(page_class, title: nil, context: nil, query_string: '', options: [])
+    def prepare_page(page_class, context: nil, options: nil)
       page_class.new.tap do |page|
-        page.setup_page(title: title, query_string: query_string, settings: settings)
-        page.setup_options(
-          context: context,
-          compact_layout: options.include?(:compact_layout),
-          no_menu: options.include?(:no_menu)
-        )
+        page.context = context
+        page.options = options
         yield(page) if block_given?
       end
     end
diff --git a/lib/tiny_admin/views/actions/index.rb b/lib/tiny_admin/views/actions/index.rb
@@ -5,7 +5,7 @@ module Views
     module Actions
       class Index < DefaultLayout
         attr_reader :current_page, :fields, :pages, :prepare_record, :records
-        attr_accessor :actions, :filters
+        attr_accessor :actions, :filters, :query_string
 
         def setup_pagination(current_page:, pages:)
           @current_page = current_page
@@ -14,7 +14,7 @@ def setup_pagination(current_page:, pages:)
 
         def setup_records(records:, fields:, prepare_record:)
           @records = records
-          @fields = fields.index_by(&:name)
+          @fields = fields.each_with_object({}) { |field, result| result[field.name] = field }
           @prepare_record = prepare_record
         end
 
diff --git a/lib/tiny_admin/views/basic_layout.rb b/lib/tiny_admin/views/basic_layout.rb
@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module TinyAdmin
+  module Views
+    class BasicLayout < Phlex::HTML
+      include Utils
+
+      def components
+        settings.components
+      end
+
+      def update_attributes(attributes)
+        attributes.each do |key, value|
+          send("#{key}=", value)
+        end
+      end
+    end
+  end
+end
diff --git a/lib/tiny_admin/views/components/flash.rb b/lib/tiny_admin/views/components/flash.rb
@@ -6,10 +6,12 @@ module Components
       class Flash < Phlex::HTML
         attr_reader :errors, :notices, :warnings
 
-        def initialize(notices: [], warnings: [], errors: [])
-          @notices = notices
-          @warnings = warnings
-          @errors = errors
+        def initialize(messages:)
+          return unless messages
+
+          @notices = messages[:notices]
+          @warnings = messages[:warnings]
+          @errors = messages[:errors]
         end
 
         def template
diff --git a/lib/tiny_admin/views/components/navbar.rb b/lib/tiny_admin/views/components/navbar.rb
@@ -4,18 +4,19 @@ module TinyAdmin
   module Views
     module Components
       class Navbar < Phlex::HTML
-        attr_reader :current_slug, :items, :root
+        attr_reader :current_slug, :items, :root_path, :root_title
 
-        def initialize(root:, items: [], current_slug: nil)
-          @root = root
+        def initialize(root_path:, root_title:, items: [], current_slug: nil)
+          @root_path = root_path
+          @root_title = root_title
           @items = items || []
           @current_slug = current_slug
         end
 
         def template
           nav(class: 'navbar navbar-expand-lg') {
             div(class: 'container') {
-              a(class: 'navbar-brand', href: root[:path]) { root[:title] }
+              a(class: 'navbar-brand', href: root_path) { root_title }
               button(class: 'navbar-toggler', type: 'button', 'data-bs-toggle' => 'collapse', 'data-bs-target' => '#navbarNav', 'aria-controls' => 'navbarNav', 'aria-expanded' => 'false', 'aria-label' => 'Toggle navigation') {
                 span(class: 'navbar-toggler-icon')
               }
diff --git a/lib/tiny_admin/views/default_layout.rb b/lib/tiny_admin/views/default_layout.rb
@@ -2,49 +2,25 @@
 
 module TinyAdmin
   module Views
-    class DefaultLayout < Phlex::HTML
-      include Utils
-
-      attr_reader :compact_layout,
-                  :context,
-                  :errors,
-                  :no_menu,
-                  :notices,
-                  :query_string,
-                  :settings,
-                  :title,
-                  :warnings
-
-      def setup_page(title:, query_string:, settings:)
-        @title = title
-        @query_string = query_string
-        @settings = settings
-      end
-
-      def setup_options(context:, compact_layout:, no_menu:)
-        @context = context
-        @compact_layout = compact_layout
-        @no_menu = no_menu
-      end
-
-      def setup_flash_messages(notices: [], warnings: [], errors: [])
-        @notices = notices
-        @warnings = warnings
-        @errors = errors
-      end
+    class DefaultLayout < BasicLayout
+      attr_accessor :context, :messages, :options, :title
 
       def template(&block)
-        items = no_menu ? [] : settings.navbar
-
         doctype
         html {
           render components[:head].new(title, style_links: style_links, extra_styles: settings.extra_styles)
 
           body(class: body_class) {
-            render components[:navbar].new(current_slug: context&.slug, root: settings.root, items: items)
+            navbar_attrs = {
+              current_slug: context&.slug,
+              root_path: settings.root_path,
+              root_title: settings.root[:title],
+              items: navbar_items
+            }
+            render components[:navbar].new(**navbar_attrs)
 
             main_content {
-              render components[:flash].new(notices: notices, warnings: warnings, errors: errors)
+              render components[:flash].new(messages: messages || {})
               yield_content(&block)
             }
 
@@ -55,29 +31,17 @@ def template(&block)
 
       private
 
-      def components
-        settings.components
-      end
-
-      def style_links
-        settings.style_links || [
-          # Bootstrap CDN
-          {
-            href: 'https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/css/bootstrap.min.css',
-            rel: 'stylesheet',
-            integrity: 'sha384-rbsA2VBKQhggwzxH7pPCaAqO46MgnOM80zW1RWuH61DGLwZJEdK2Kadq2F9CUG65',
-            crossorigin: 'anonymous'
-          }
-        ]
-      end
-
       def body_class
         "module-#{self.class.to_s.split('::').last.downcase}"
       end
 
+      def navbar_items
+        options&.include?(:no_menu) ? [] : settings.navbar
+      end
+
       def main_content
         div(class: 'container main-content py-4') do
-          if compact_layout
+          if options&.include?(:compact_layout)
             div(class: 'row justify-content-center') {
               div(class: 'col-6') {
                 yield
@@ -89,10 +53,20 @@ def main_content
         end
       end
 
-      def render_scripts
-        return unless settings.scripts
+      def style_links
+        settings.style_links || [
+          # Bootstrap CDN
+          {
+            href: 'https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/css/bootstrap.min.css',
+            rel: 'stylesheet',
+            integrity: 'sha384-rbsA2VBKQhggwzxH7pPCaAqO46MgnOM80zW1RWuH61DGLwZJEdK2Kadq2F9CUG65',
+            crossorigin: 'anonymous'
+          }
+        ]
+      end
 
-        settings.scripts.each do |script_attrs|
+      def render_scripts
+        (settings.scripts || []).each do |script_attrs|
           script(**script_attrs)
         end
       end
