adminterface 0.0.0 → 0.2.3

data/lib/adminterface/extensions/views/pages/base.rb

@@ -0,0 +1,165 @@
+module Adminterface
+  module Extensions
+    module Views
+      module Pages
+        module Base
+          def build(*args)
+            super
+            build_breakpoint_helpers
+            build_meta_tags_for_js
+          end
+
+          private
+
+          def build_meta_tags_for_js
+            div id: "meta-tags-for-js" do
+              meta name: "countries", content: ::Adminterface::Data::Countries.call(I18n.locale).to_json
+              meta name: "time_zones", content: ::Adminterface::Data::TimeZones.call(I18n.locale).to_json
+              meta name: "translations", content: I18n.t("active_admin").to_json
+              meta name: "components", content: {inputs: inputs_components}.to_json
+              meta name: "css_classes", content: {confirm_dialog: confirm_dialog_css_classes}.to_json
+            end
+          end
+
+          def build_breakpoint_helpers
+            div id: "breakpoint-helpers" do
+              span class: "breakpoint-up-helper"
+              span class: "breakpoint-down-helper"
+            end
+          end
+
+          def build_page
+            within body(class: body_classes) do
+              header(active_admin_namespace, current_menu)
+              title_bar(active_admin_namespace, title, action_items_for_action)
+
+              div id: "wrapper" do
+                build_flash_messages
+                build_unsupported_browser
+                build_page_content
+              end
+            end
+          end
+
+          def build_page_content
+            div id: "active_admin_content" do
+              build_left_sidebar_content
+              build_body_content
+              build_right_sidebar_content
+            end
+          end
+
+          def build_body_content
+            div main_html_options do
+              div class: content_wrapper_class do
+                build_main_content_wrapper
+                footer active_admin_namespace
+              end
+            end
+          end
+
+          def build_left_sidebar_content
+            return if skip_left_sidebar?
+
+            div sidebar(sidebar_sections_for_action_for_position("left"), class: "container"), id: "sidebar-left"
+          end
+
+          def build_right_sidebar_content
+            return if skip_right_sidebar?
+
+            div sidebar(sidebar_sections_for_action_for_position("right"), class: "container"), id: "sidebar-right"
+          end
+
+          def skip_left_sidebar?
+            skip_sidebar? || sidebar_sections_for_action_for_position("left").empty?
+          end
+
+          def skip_right_sidebar?
+            skip_sidebar? || sidebar_sections_for_action_for_position("right").empty?
+          end
+
+          def sidebar_sections_for_action_for_position(position)
+            sections = sidebar_sections_for_action.select { |x| x.position.eql?(position) }
+            sections += sidebar_sections_for_action.select { |x| x.position.blank? } if sidebar_position.eql?(position)
+            sections
+          end
+
+          def body_classes
+            super.add "#{html_css_classes[:body]} layout-navigation-#{header_position} #{sidebar_class}".squish
+          end
+
+          def sidebar_class
+            classes = []
+            classes.push "with-left-sidebar" unless skip_left_sidebar?
+            classes.push "with-right-sidebar" unless skip_right_sidebar?
+            classes.push "without-sidebar" if classes.empty?
+            classes.join(" ")
+          end
+
+          def build_flash_messages
+            return if flash_messages.blank?
+
+            div class: "flashes" do
+              flash_messages.each do |type, messages|
+                [*messages].each do |message|
+                  div class: "flash flash_#{type} alert #{flash_css_classes[type.to_sym]} #{flash_dismissible_class}".squish,
+                      role: "alert" do
+                    text_node(message)
+                    button(class: "btn-close", "data-bs-dismiss": "alert", "aria-label": "Close") if flash_dismissible?
+                  end
+                end
+              end
+            end
+          end
+
+          def flash_dismissible?
+            flash_components[:dismissible].eql?(true)
+          end
+
+          def flash_dismissible_class
+            return unless flash_dismissible?
+            "alert-dismissible"
+          end
+
+          def main_html_options
+            options = config[:main] || {}
+            options[:class] = "#{sidebar_class} #{options[:class]}".squish
+            options[:id] = "main"
+            options
+          end
+
+          def content_wrapper_class
+            klass =
+              case self.class.to_s
+              when "ActiveAdmin::Views::Pages::Index"
+                html_css_classes.dig(:container, :index)
+              when "ActiveAdmin::Views::Pages::Form"
+                html_css_classes.dig(:container, :form)
+              when "ActiveAdmin::Views::Pages::Show"
+                html_css_classes.dig(:container, :show)
+              when "ActiveAdmin::Views::Pages::Page"
+                html_css_classes.dig(:container, :page)
+              end
+            klass || "container"
+          end
+
+          def sidebar_position
+            sidebar_components[:position]
+          end
+
+          def header_position
+            header_components[:position]
+          end
+        end
+      end
+    end
+  end
+end
+
+# Overwrite activeadmin/lib/active_admin/views/pages/base.rb
+ActiveAdmin::Views::Pages::Base.class_eval do
+  include Adminterface::Configs::Finders
+  prepend Adminterface::Extensions::Views::Pages::Base
+  has_css_classes_for :html, :flash, :confirm_dialog
+  has_components_for :flash, :sidebar, :header, :inputs
+end

data/lib/adminterface/extensions/views/pages/form.rb

@@ -0,0 +1,27 @@
+module Adminterface
+  module Extensions
+    module Views
+      module Pages
+        module Form
+          def main_content
+            options = default_form_options.merge form_presenter.options
+
+            if options[:partial]
+              render options[:partial]
+            elsif options[:multiple]
+              instance_exec(&form_presenter.block)
+            else
+              active_admin_form_for resource, options, &form_presenter.block
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+# Overwrite activeadmin/lib/active_admin/views/pages/form.rb
+ActiveAdmin::Views::Pages::Form.class_eval do
+  prepend Adminterface::Extensions::Views::Pages::Form
+  alias_method :form_section, :active_admin_form_for
+end

data/lib/adminterface/extensions/views/pages/index.rb

@@ -0,0 +1,136 @@
+module Adminterface
+  module Extensions
+    module Views
+      module Pages
+        module Index
+          FILTER_OPTS = %w[sidebar table_tools aside].freeze
+
+          def main_content
+            unless FILTER_OPTS.include?(filter_position)
+              raise "Invalid layouts -> filter. Available options are: #{FILTER_OPTS.join(", ")}"
+            end
+
+            build_table_tools
+            wrap_with_batch_action_form do
+              build_collection
+            end
+          end
+
+          def build_page
+            super.add_child(build_aside)
+          end
+
+          def build_table_tools
+            return unless any_table_tools?
+
+            div class: "table_tools" do
+              build_scopes
+              build_table_tools_filters
+              div class: "scope_ctrls" do
+                build_batch_actions_selector
+                build_index_list
+                build_table_tools_filter_toggler
+              end
+            end
+          end
+
+          private
+
+          def action_items_for_action
+            if filter_position.eql?("aside")
+              items = super << aside_filter_action
+              items.sort_by { |x| [x.group, x.priority] }
+            else
+              super
+            end
+          end
+
+          def aside_filter_action
+            ActiveAdmin::ActionItem.new(:filter, only: :index, group: 90) do
+              localizer = ActiveAdmin::Localizers.resource(active_admin_config)
+              link_to localizer.t(:filter_model), "#",
+                id: "filters-toggler",
+                data: {"bs-toggle": "collapse", "bs-target": "#filters"},
+                title: I18n.t(:filters, scope: "active_admin.sidebars")
+            end
+          end
+
+          def build_aside
+            return if filter_sections.blank?
+            return unless filter_position.eql?("aside")
+
+            div id: "filters", class: "collapse aside" do
+              button "", type: "button", id: "filters-close", class: "btn-close", href: "#", "data-bs-toggle": "collapse", "data-bs-target": "#filters"
+              filter_sections.collect { |x| sidebar_section(x) }
+            end
+          end
+
+          def build_table_tools_filters
+            return if filter_sections.blank?
+            return unless filter_position.eql?("table_tools")
+
+            div id: "filters", class: "collapse table-tools" do
+              filter_sections.collect { |x| sidebar_section(x) }
+            end
+          end
+
+          def build_table_tools_filter_toggler
+            return if filter_sections.blank?
+            return unless filter_position.eql?("table_tools")
+
+            div id: "filters-toggler" do
+              a span(I18n.t("active_admin.sidebars.filters")),
+                href: "#", class: "filter_toggler #{table_tools_css_classes[:btn]}",
+                'data-bs-toggle': "collapse", 'data-bs-target': "#filters"
+            end
+          end
+
+          def filter_section?(section)
+            section.name.to_sym == :filters
+          end
+
+          def filter_sections
+            sections = []
+            available_sidebar_sections.collect do |section|
+              next unless filter_section?(section)
+
+              sections.push section
+            end
+            sections
+          end
+
+          def skip_sidebar?
+            sidebar_sections_for_action.empty? || assigns[:skip_sidebar] == true
+          end
+
+          def available_sidebar_sections
+            if active_admin_config&.sidebar_sections?
+              active_admin_config.sidebar_sections_for(params[:action], self)
+            else
+              []
+            end
+          end
+
+          def sidebar_sections_for_action
+            if filter_position.eql?("sidebar")
+              available_sidebar_sections
+            else
+              available_sidebar_sections.reject { |x| x.name.to_sym == :filters }
+            end
+          end
+
+          def filter_position
+            filter_components[:position]
+          end
+        end
+      end
+    end
+  end
+end
+
+# Overwrite activeadmin/lib/active_admin/views/pages/index.rb
+ActiveAdmin::Views::Pages::Index.class_eval do
+  prepend Adminterface::Extensions::Views::Pages::Index
+  has_css_classes_for :table_tools
+  has_components_for :filter
+end

data/lib/adminterface/extensions/views/pages/page.rb

@@ -0,0 +1,18 @@
+module Adminterface
+  module Extensions
+    module Views
+      module Pages
+        module Page
+          def body_classes
+            super.add "page"
+          end
+        end
+      end
+    end
+  end
+end
+
+# Overwrite activeadmin/lib/active_admin/views/pages/page.rb
+ActiveAdmin::Views::Pages::Page.class_eval do
+  prepend Adminterface::Extensions::Views::Pages::Page
+end

data/lib/adminterface/extensions/views/title_bar.rb

@@ -0,0 +1,74 @@
+module Adminterface
+  module Extensions
+    module Views
+      module TitleBar
+        def tag_name
+          :nav
+        end
+
+        private
+
+        def build_titlebar_left
+          div build_breadcrumb, id: "titlebar_left"
+        end
+
+        def build_header_toggler
+          button class: "navbar-toggler", "data-aa-header-toggler": {}.to_json do
+            span class: "navbar-toggler-icon"
+          end
+        end
+
+        def build_titlebar_right
+          return if @action_items.blank?
+
+          super
+        end
+
+        def links
+          breadcrumb_config = active_admin_config&.breadcrumb
+          if breadcrumb_config.is_a?(Proc)
+            instance_exec(controller, &active_admin_config.breadcrumb)
+          elsif breadcrumb_config.present?
+            breadcrumb_links
+          end
+        end
+
+        def build_breadcrumb(_separator = "/")
+          ol id: "breadcrumb", class: "breadcrumb" do
+            links.each do |link|
+              li(text_node(link), class: "breadcrumb-item")
+            end
+            li(text_node(@title), class: "breadcrumb-item active")
+          end
+        end
+
+        def build_action_items
+          @action_items.group_by(&:group).each do |_index, items|
+            insert_tag(view_factory.action_items, items)
+          end
+        end
+      end
+    end
+  end
+end
+
+# Overwrite activeadmin/lib/active_admin/views/title_bar.rb
+ActiveAdmin::Views::TitleBar.class_eval do
+  prepend Adminterface::Extensions::Views::TitleBar
+  has_css_classes_for :title_bar
+
+  def build(namespace, title, action_items)
+    super(id: "title_bar")
+    add_class "navbar #{title_bar_css_classes[:wrapper]}".squish
+    @title = title
+    @action_items = action_items
+    @namespace = namespace
+
+    div class: title_bar_css_classes[:container] do
+      build_header_toggler
+      site_title @namespace
+      build_titlebar_left
+      build_titlebar_right
+    end
+  end
+end

data/lib/adminterface/fixtures/components.yml

@@ -0,0 +1,73 @@
+---
+action_items:
+  destroy:
+    css_class: null
+    icon_class: null
+    only:
+      - show
+  edit:
+    css_class: null
+    icon_class: null
+    only:
+      - show
+  new:
+    css_class: btn btn-primary
+    icon_class: null
+    only:
+      - index
+columns:
+  breakpoint: md
+filter:
+  position: sidebar
+flash:
+  dismissible: true
+header:
+  css_class:
+    aside: navbar-light bg-light
+    sidebar: navbar-dark bg-dark
+    top: navbar-dark bg-dark navbar-expand-lg
+  position: top
+index_as_grid:
+  breakpoint: lg
+inputs:
+  date_picker: &DATE_PICKER_CONFIGS
+    js:
+      - name: flatpickr
+        default: true
+        options:
+          altFormat: Y-m-d
+          altInput: true
+          enableTime: false
+  datepicker:
+    <<: *DATE_PICKER_CONFIGS
+  datetime_picker:
+    js:
+      - name: flatpickr
+        default: true
+        options:
+          altFormat: Y-m-d, h:i K
+          altInput: true
+          enableTime: true
+  select:
+    js:
+      - name: tom-select
+        default: false
+        options:
+          plugins:
+            - remove_button
+          persist: false
+          createOnBlur: false
+          create: false
+  text:
+    js:
+      - name: input-counter
+        default: false
+        options:
+          limit: 300
+          type: letter
+  password:
+    js:
+      - name: password-visibility
+        default: false
+sidebar:
+  position: right

data/lib/adminterface/fixtures/css_classes.yml

@@ -0,0 +1,107 @@
+---
+action_items:
+  group: btn-group
+  item: btn btn-light
+attributes_table:
+  table: table text-break
+  wrapper: table-responsive
+blank_slate: alert alert-secondary text-center
+columns: g-3
+comments:
+  body: card-body
+  header:
+    title: h5 mb-0
+    wrapper: card-header
+  item:
+    actions: text-secondary caret-dots
+    body: py-2
+    group: list-group list-group-flush
+    header:
+      author: h6 mb-0
+      meta: small text-secondary
+      wrapper: null
+    wrapper: mb-3
+  pagination:
+    meta: mb-3 border-bottom
+  submit: btn btn-primary
+  wrapper: card
+confirm_dialog:
+  cancel: btn btn-link
+  confirm: btn btn-primary
+filters:
+  actions:
+    cancel: btn btn-link
+    submit: btn btn-primary
+flash:
+  alert: alert-warning
+  error: alert-danger
+  notice: alert-success
+footer:
+  body: small text-muted
+  wrapper: mt-3 text-center
+form:
+  actions:
+    cancel: btn btn-link
+    submit: btn btn-primary
+  error: alert alert-danger
+  has_many:
+    destroy: text-danger
+    heading: h5
+    item: border rounded mb-3 p-3
+    new: null
+header:
+  container: container-fluid
+  wrapper: null
+html:
+  body: null
+  container:
+    form: container
+    index: container
+    page: container
+    show: container
+icon: bi
+index_as_grid:
+  group: row g-3
+  item: d-flex flex-column
+index_as_table:
+  actions:
+    dropdown:
+      toggle: btn btn-sm btn-light
+    buttons:
+      group: btn-group
+      item: btn btn-sm btn-light
+  table: table
+  wrapper: table-responsive
+panel:
+  body: card-body
+  header:
+    title: h5 mb-0
+    wrapper: card-header
+  wrapper: card
+sidebar_section:
+  body: card-body
+  header:
+    title: h5 mb-0
+    wrapper: card-header
+  wrapper: card
+status_tag:
+  'no': badge bg-danger
+  unset: badge bg-danger
+  'yes': badge bg-success
+table_for: table
+table_tools:
+  btn: btn btn-light
+  confirm_dialog:
+    cancel: btn btn-link
+    confirm: btn btn-primary
+  indexes:
+    tabs: nav-pills nav-sm
+  scopes:
+    counts:
+      positive: badge bg-primary
+      zero: d-none
+    tabs: nav-tabs
+tabs: nav-tabs
+title_bar:
+  container: container-fluid
+  wrapper: navbar-light bg-white border shadow-sm

data/lib/adminterface/initializers/batch_actions.rb

@@ -0,0 +1,15 @@
+module Adminterface
+  module Initializers
+    module BatchActions
+      extend ActiveSupport::Concern
+
+      included do
+        ActiveAdmin.before_load do |_app|
+          require_relative("../extensions/batch_actions/resource_extension")
+          require_relative("../extensions/batch_actions/views/batch_action_selector")
+          require_relative("../extensions/batch_actions/views/selection_cells")
+        end
+      end
+    end
+  end
+end

data/lib/adminterface/initializers/comments.rb

@@ -0,0 +1,13 @@
+module Adminterface
+  module Initializers
+    module Comments
+      extend ActiveSupport::Concern
+
+      included do
+        config.before_configuration do |_app|
+          require_relative("../extensions/orm/active_record/comments/views/active_admin_comments")
+        end
+      end
+    end
+  end
+end

data/lib/adminterface/initializers/configurations.rb

@@ -0,0 +1,38 @@
+module Adminterface
+  module Initializers
+    module Configurations
+      extend ActiveSupport::Concern
+
+      included do
+        config.before_configuration do |_app|
+          require_relative("../extensions/dynamic_settings_node")
+          require_relative("../extensions/namespace_settings")
+
+          # Include the configs finder for not registered class/module files
+          ActiveAdmin::Views::FormtasticProxy.send :include, Adminterface::Configs::Finders
+          ActiveAdmin::Component.send :include, Adminterface::Configs::Finders
+          ActiveAdmin::ViewHelpers.send :include, Adminterface::Configs::Finders
+          ActiveAdmin::Resource.send :include, Adminterface::Configs::Configurable
+          ActiveAdmin::Page.send :include, Adminterface::Configs::Configurable
+        end
+
+        # Override ActiveAdmin defaults
+        config.before_initialize do
+          ActiveAdmin.setup do |config|
+            config.current_filters = false
+            config.comments_menu = false
+            config.comments_order = "created_at DESC"
+
+            meta_tags = {
+              version: Adminterface::VERSION,
+              viewport: "width=device-width, height=device-height, initial-scale=1.0"
+            }
+
+            config.meta_tags_for_logged_out_pages = meta_tags
+            config.meta_tags = meta_tags
+          end
+        end
+      end
+    end
+  end
+end