effective_pages 3.1.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f090f6237de5e5aabd329729b2c1d9b2098307bfd46510d4663b95783d5a233
-  data.tar.gz: c8516b8b3e013e8b41660e03cc14a519eee7f0897a80ab0e1cdc6356fd7ec977
+  metadata.gz: 2620fbfec6b912fd31b7d9821fe5ef73eecbfb4c509063883f8c144a2aa66d30
+  data.tar.gz: d75935c05702f1328e32058f45874999a3b3b3f7f7becab1202c4d18b9dee743
 SHA512:
-  metadata.gz: fb40c0b8c3f7c86ae0374d183bd3217d737594637f469bffb8b93a91bd506a9b20101eb4439698939e835df00b33a38b6c16faf952aa728db9efbda35289c4aa
-  data.tar.gz: e9dd9e7c455f3f38be630aac0a2cea2d9fee080bb319dda6337bc8a5f4c90c62b8fd8021bb70795283c53a150c31ec22beae83a8946e6adaa7b3494150baa815
+  metadata.gz: 9dd4484e144bbbb2287dc399eb93bbae86b423c05fea8ca0bd0f7d5f716e384ebc1d935eef964166517b6358d1565f539c32894d6a2992e851a3e2d9104a6192
+  data.tar.gz: f1fa33f1bd839164cb281f23a3439f4d624458120061d7aeb7a0c2e16703d7b46d7043ae4abaf4878cea8bbf65e5a8a0710a02c00fbe0c8185f9df28e1e3e46c

data/app/controllers/admin/page_sections_controller.rb

@@ -0,0 +1,13 @@
+module Admin
+  class PageSectionsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_pages) }
+
+    include Effective::CrudController
+
+    def permitted_params
+      params.require(:effective_page_section).permit!
+    end
+
+  end
+end

data/app/datatables/effective_page_sections_datatable.rb

@@ -0,0 +1,29 @@
+class EffectivePageSectionsDatatable < Effective::Datatable
+
+  datatable do
+    order :name, :asc
+    length :all
+
+    col :id, visible: false
+    col :updated_at, visible: false
+
+    col :name
+    col :hint
+
+    col :title
+    col :rich_text_body
+
+    col :files
+
+    col :link_label, visible: false
+    col :link_url, visible: false
+    col :caption, visible: false
+
+    actions_col
+  end
+
+  collection do
+    Effective::PageSection.deep.all
+  end
+
+end

data/app/datatables/effective_pages_datatable.rb

@@ -15,8 +15,6 @@ class EffectivePagesDatatable < Effective::Datatable
     col :updated_at, visible: false
 
     col :title
-    col :menu_title
-    col :menu_name
 
     col :slug do |page|
       link_to(page.slug, effective_pages.page_path(page), target: '_blank')
@@ -27,6 +25,10 @@ class EffectivePagesDatatable < Effective::Datatable
     col :layout, visible: false
     col :tempate, visible: false
 
+    col :menu_name
+    col :menu_title
+    col :menu_group
+
     col :menu_url, visible: false
     col :menu_parent, search: { collection: admin_menu_parent_collection(), grouped: true }
     col :menu_position, visible: false

data/app/datatables/effective_pages_menu_datatable.rb

@@ -16,12 +16,12 @@ class EffectivePagesMenuDatatable < Effective::Datatable
 
     # We only support depth 2 and 3.
     col :menu_children, label: 'Children' do |page|
-      page.menu_children.map do |child|
+      page.menu_children.group_by(&:menu_group).values.flatten.map do |child|
         content_tag(:div, class: 'col-resource_item') do
-          link = link_to(child, effective_pages.edit_admin_page_path(child))
+          link = link_to(child.admin_menu_label, effective_pages.edit_admin_page_path(child))
 
-          list = child.menu_children.map do |child|
-            content_tag(:li, link_to(child, effective_pages.edit_admin_page_path(child)))
+          list = child.menu_children.group_by(&:menu_group).values.flatten.map do |child|
+            content_tag(:li, link_to(child.admin_menu_label, effective_pages.edit_admin_page_path(child)))
           end
 
           link + (content_tag(:ul, list.join.html_safe) if list.present?).to_s

data/app/helpers/effective_menus_helper.rb

@@ -67,7 +67,15 @@ module EffectiveMenusHelper
       # You can only select root level pages and immediate children
       pages.map do |page|
         [[page.to_s, page.id, page.menu_name]] + page.menu_children.map do |child|
-          [' -- ' + child.to_s, child.id, child.menu_name]
+          label = content_tag(:div) do
+            arrow = "→"
+            group = content_tag(:span, child.menu_group, class: 'badge badge-info') if child.menu_group.present?
+            title = child.menu_to_s
+
+            [arrow, group, title].compact.join(' ').html_safe
+          end
+
+          [child.to_s, child.to_param, { 'data-html': label }, child.menu_name]
         end
       end.flatten(1).group_by(&:last)
     end

data/app/helpers/effective_page_sections_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module EffectivePageSectionsHelper
+
+  def effective_page_sections
+    @_effective_page_sections ||= Effective::PageSection.all
+  end
+
+  def render_page_section(name, &block)
+    raise('expected a name') unless name.present?
+
+    name = name.to_s
+
+    page_section = effective_page_sections.find { |ps| ps.name == name }
+    raise("unable to find page section with name #{name}") unless page_section.present?
+
+    if block_given?
+      yield(page_section); nil
+    else
+      page_section.rich_text_body.to_s.html_safe
+    end
+  end
+
+end

data/app/models/effective/page.rb

@@ -29,12 +29,13 @@ module Effective
       slug              :string
 
       # Menu stuff
-      menu              :boolean
-      menu_name         :string
+      menu              :boolean        # Should this be displayed on the menu at all?
+      menu_name         :string         # When I'm a root level item, this is the menu I render underneath
+      menu_group        :string         # Used for design. Group by menu_group to display full dropdowns.
 
-      menu_title        :string
-      menu_url          :string
-      menu_position     :integer
+      menu_title        :string         # Displayed on the menu instead of title
+      menu_url          :string         # Redirect to this url instead of the page url
+      menu_position     :integer        # Position in the menu
 
       # Access
       roles_mask        :integer
@@ -59,7 +60,10 @@ module Effective
     validates :layout, presence: true
     validates :template, presence: true
 
-    validates :menu_name, if: -> { menu_root? && EffectivePages.menus.present? }, presence: true
+    validates :menu_name, presence: true, if: -> { menu_root? && EffectivePages.menus.present? }
+
+    # Doesn't make sense for a top level item to have a menu group
+    validates :menu_group, absence: true, if: -> { menu_root? && EffectivePages.menus.present? }
 
     # validates :menu_position, if: -> { menu? },
     #   presence: true, uniqueness: { scope: [:menu_name, :menu_parent_id] }
@@ -69,6 +73,7 @@ module Effective
     scope :draft, -> { where(draft: true) }
     scope :published, -> { where(draft: false) }
     scope :sorted, -> { order(:title) }
+
     scope :on_menu, -> { where(menu: true) }
     scope :except_home, -> { where.not(title: 'Home') }
 
@@ -79,10 +84,23 @@ module Effective
     scope :for_menu_root, -> (name) { for_menu(name).menu_deep.root_level }
     scope :root_level, -> { where(menu_parent_id: nil) }
 
+    scope :menu_root_with_children, -> { menu_parents.where(menu_parent_id: nil) }
+    scope :menu_roots, -> { where(menu: true).where(menu_parent_id: nil) }
+    scope :menu_parents, -> { where(menu: true).where(id: Effective::Page.select('menu_parent_id')) }
+    scope :menu_children, -> { where(menu: true).where.not(menu_parent_id: nil) }
+
+    scope :for_sitemap, -> {
+      published.where(menu: false).or(published.where(menu: true).where.not(id: menu_root_with_children))
+    }
+
     def to_s
       title
     end
 
+    def menu_to_s
+      (menu_title.presence || title)
+    end
+
     # As per has_many_rich_texts
     def body
       rich_text_body

data/app/models/effective/page_section.rb

@@ -0,0 +1,49 @@
+module Effective
+  class PageSection < ActiveRecord::Base
+    attr_accessor :current_user
+
+    # Not used
+    belongs_to :owner, polymorphic: true, optional: true
+
+    has_many_rich_texts
+    has_many_attached :files
+
+    log_changes if respond_to?(:log_changes)
+
+    self.table_name = EffectivePages.page_sections_table_name.to_s
+
+    effective_resource do
+      name              :string       # Unique name of this page section
+
+      title             :string
+      caption           :string
+
+      link_label        :string
+      link_url          :string
+
+      hint              :text
+
+      timestamps
+    end
+
+    validates :name, presence: true, uniqueness: true
+    validates :title, presence: true, length: { maximum: 255 }
+
+    validates :link_url, presence: true, if: -> { link_label.present? }
+    validates :link_url, absence: true, if: -> { link_label.blank? }
+
+    scope :deep, -> { with_attached_files.includes(:rich_texts) }
+    scope :sorted, -> { order(:name) }
+
+    def to_s
+      name.presence || 'page section'
+    end
+
+    # As per has_many_rich_texts
+    def body
+      rich_text_body
+    end
+
+  end
+
+end

data/app/views/admin/page_sections/_form.html.haml

@@ -0,0 +1,7 @@
+= tabs do
+  = tab 'Page Section' do
+    = render '/admin/page_sections/form_page_section', page_section: page_section
+
+  - if page_section.persisted?
+    = tab 'Logs' do
+      = render_datatable(page_section.log_changes_datatable, inline: true, namespace: :admin)

data/app/views/admin/page_sections/_form_page_section.html.haml

@@ -0,0 +1,25 @@
+= effective_form_with(model: [:admin, page_section], engine: true) do |f|
+  - if f.object.new_record?
+    = f.text_field :name, hint: 'The name of this region must be unique'
+  - else
+    = f.static_field :name
+
+  - if f.object.hint.present?
+    .mb-4= f.object.hint.html_safe
+
+  = f.text_field :title
+
+  - if defined?(EffectiveArticleEditor)
+    = f.article_editor :rich_text_body, label: 'Body', hint: 'The main content'
+  - else
+    = f.rich_text_area :rich_text_body, label: 'Body', hint: 'The main content'
+
+  .row
+    .col= f.text_field :link_label
+    .col= f.url_field :link_url
+
+  = f.file_field :files, label: 'Attachment'
+
+  = f.text_field :caption
+
+  = effective_submit(f)

data/app/views/admin/pages/_form_menu.html.haml

@@ -14,14 +14,15 @@
         = f.hidden_field :menu_name, value: menus.first
 
     = f.show_if :menu_root_level, false do
-      = f.select :menu_parent_id, admin_menu_parent_collection(f.object), required: true, grouped: true
+      = f.select :menu_parent_id, admin_menu_parent_collection(f.object), required: true, grouped: true, hint: 'Displayed on the menu underneath this parent'
+      = f.text_field :menu_group, hint: 'Displayed on the menu in this group or column'
 
     = f.text_field :menu_title, hint: "Display this title on menus instead of full page title"
 
     = f.text_field :menu_url, label: "Redirect to path or url instead of displaying page",
       hint: "Must start with http(s):// or /"
 
-  = f.submit
+  = effective_submit(f)
 
 - if page.menu_parent.present?
   .mb-4

data/app/views/admin/pages/_form_page.html.haml

@@ -25,21 +25,20 @@
 
   = render partial: '/admin/pages/additional_fields', locals: { page: page, form: f, f: f }
 
-  - if f.object.persisted?
-    - if page.menu_root? && page.menu_parent?
-      .alert.alert-info.my-3.pl-0
-        %ul.mb-0
-          %li This page is a top level menu item with at least one child page
-          %li It will render on the menu as a dropdown link
-          %li Users will not be able to click access page via the menu
-          %li Visiting the page URL directly will return a 404 error
-          %li If you want this page to be accessible while also being a top level menu item, it needs to have no child pages
-
-    - else
-      = render '/admin/pages/rich_text_areas', page: page, f: f
+  - if f.object.persisted? && f.object.menu_root_with_children?
+    .alert.alert-info.my-3.pl-0
+      %ul.mb-0
+        %li This page is a top level menu item with at least one child page
+        %li It will render on the menu as a dropdown link
+        %li Users will not be able to click access page via the menu
+        %li Visiting the page URL directly will return a 404 error
+        %li If you want this page to be accessible while also being a top level menu item, it needs to have no child pages
+
+  - if f.object.persisted? && !f.object.menu_root_with_children?
+    = render '/admin/pages/rich_text_areas', page: page, f: f
 
   -# This is for duplicate
   - if f.object.new_record? && f.object.rich_texts.present?
-    = render partial: '/admin/pages/rich_text_areas', locals: { page: page, form: f, f: f }
+    = render '/admin/pages/rich_text_areas', page: page, f: f
 
   = effective_submit(f)

data/app/views/effective/pages/_menu.html.haml

@@ -10,13 +10,15 @@
   - menu_children = page.menu_children
 
   - if menu_children.blank?
-    = nav_link_to((page.menu_title.presence || page.title), (page.menu_url.presence || effective_pages.page_path(page)))
+    = nav_link_to(page.menu_to_s, (page.menu_url.presence || effective_pages.page_path(page)))
 
-  - else
-    = nav_dropdown(page.to_s) do
-      - menu_children.each do |page|
-        - next unless EffectiveResources.authorized?(self, :show, page)
-        - next if (page.authenticate_user || page.roles.present?) && current_user.blank?
-        - next if page.roles.present? && (current_user.roles & page.roles).blank?
+  - if menu_children.present?
+    = nav_dropdown(page.menu_to_s, groups: true) do
+      - menu_children.group_by(&:menu_group).each do |menu_group, pages|
+        = nav_dropdown_group(menu_group) do
+          - pages.each do |page|
+            - next unless EffectiveResources.authorized?(self, :show, page)
+            - next if (page.authenticate_user || page.roles.present?) && current_user.blank?
+            - next if page.roles.present? && (current_user.roles & page.roles).blank?
 
-        = nav_link_to((page.menu_title.presence || page.title), (page.menu_url.presence || effective_pages.page_path(page)))
+            = nav_link_to(page.menu_to_s, (page.menu_url.presence || effective_pages.page_path(page)))

data/app/views/effective/pages/_page_menu.html.haml

@@ -5,9 +5,13 @@
 - if menu_children.blank? && page.menu_parent&.menu_children.present?
   - menu_children = page.menu_parent&.menu_children
 
-- menu_children.each do |page|
-  - next unless EffectiveResources.authorized?(self, :show, page)
-  - next if (page.authenticate_user || page.roles.present?) && current_user.blank?
-  - next if page.roles.present? && (current_user.roles & page.roles).blank?
+- menu_children.group_by(&:menu_group).each do |menu_group, pages|
+  - if menu_group.present?
+    %h6= menu_group
 
-  = nav_link_to((page.menu_title.presence || page.title), (page.menu_url.presence || effective_pages.page_path(page)))
+  - pages.each do |page|
+    - next unless EffectiveResources.authorized?(self, :show, page)
+    - next if (page.authenticate_user || page.roles.present?) && current_user.blank?
+    - next if page.roles.present? && (current_user.roles & page.roles).blank?
+
+    = nav_link_to(page.menu_to_s, (page.menu_url.presence || effective_pages.page_path(page)))

data/config/effective_pages.rb

@@ -1,5 +1,6 @@
 EffectivePages.setup do |config|
   config.pages_table_name = :pages
+  config.page_sections_table_name = :page_sections
 
   # The menu names a page can belong to
   config.menus = [:main, :footer]

data/config/routes.rb

@@ -3,6 +3,7 @@
 EffectivePages::Engine.routes.draw do
   namespace :admin do
     resources :pages, except: [:show]
+    resources :page_sections, only: [:index, :edit, :update]
     resources :menus, only: [:index]
   end
 

data/db/migrate/01_create_effective_pages.rb.erb

@@ -15,8 +15,12 @@ class CreateEffectivePages < ActiveRecord::Migration[4.2]
       t.integer :roles_mask, default: 0
 
       t.integer :menu_parent_id
+
       t.boolean :menu, default: false
+
       t.string :menu_name
+      t.string :menu_group
+
       t.string :menu_title
       t.string :menu_url
       t.integer :menu_position
@@ -26,10 +30,31 @@ class CreateEffectivePages < ActiveRecord::Migration[4.2]
     end
 
     add_index <%= @pages_table_name %>, :slug, :unique => true
+
+    create_table <%= @page_sections_table_name %> do |t|
+      t.string :owner_type
+      t.integer :owner_id
+
+      t.string :name
+
+      t.string :title
+      t.string :caption
+
+      t.string :link_label
+      t.string :link_url
+
+      t.text :hint
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+    add_index <%= @page_sections_table_name %>, :name, :unique => true
   end
 
   def self.down
     drop_table <%= @pages_table_name %>
+    drop_table <%= @page_sections_table_name %>
   end
 
 end

data/lib/effective_pages/engine.rb

@@ -7,6 +7,7 @@ module EffectivePages
       app.config.to_prepare do
         ActiveSupport.on_load :action_controller_base do
           helper EffectivePagesHelper
+          helper EffectivePageSectionsHelper
           helper EffectiveMenusHelper
         end
       end

data/lib/effective_pages/version.rb

@@ -1,3 +1,3 @@
 module EffectivePages
-  VERSION = '3.1.1'.freeze
+  VERSION = '3.3.0'.freeze
 end

data/lib/effective_pages.rb

@@ -7,7 +7,7 @@ require 'effective_pages/version'
 module EffectivePages
   def self.config_keys
     [
-      :pages_table_name,
+      :pages_table_name, :page_sections_table_name,
       :pages_path, :excluded_pages, :layouts_path, :excluded_layouts,
       :site_og_image, :site_og_image_width, :site_og_image_height,
       :site_title, :site_title_suffix, :fallback_meta_description,

data/lib/generators/effective_pages/install_generator.rb

@@ -21,6 +21,7 @@ module EffectivePages
 
       def create_migration_file
         @pages_table_name = ':' + EffectivePages.pages_table_name.to_s
+        @page_sections_table_name = ':' + EffectivePages.page_sections_table_name.to_s
         migration_template ('../' * 3) + 'db/migrate/01_create_effective_pages.rb.erb', 'db/migrate/create_effective_pages.rb'
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_pages
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.3.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-06 00:00:00.000000000 Z
+date: 2022-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -76,14 +76,20 @@ files:
 - MIT-LICENSE
 - README.md
 - app/controllers/admin/menus_controller.rb
+- app/controllers/admin/page_sections_controller.rb
 - app/controllers/admin/pages_controller.rb
 - app/controllers/effective/pages_controller.rb
+- app/datatables/effective_page_sections_datatable.rb
 - app/datatables/effective_pages_datatable.rb
 - app/datatables/effective_pages_menu_datatable.rb
 - app/helpers/effective_menus_helper.rb
+- app/helpers/effective_page_sections_helper.rb
 - app/helpers/effective_pages_helper.rb
 - app/models/effective/page.rb
+- app/models/effective/page_section.rb
 - app/views/admin/menus/index.html.haml
+- app/views/admin/page_sections/_form.html.haml
+- app/views/admin/page_sections/_form_page_section.html.haml
 - app/views/admin/pages/_additional_fields.html.haml
 - app/views/admin/pages/_form.html.haml
 - app/views/admin/pages/_form_access.html.haml