effective_pages 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 467fd5c58dcaf5d29652dc3c1f7cad7c0a71c1afd5553bbab3faf9836402c10c
-  data.tar.gz: 5d5c90f2417ddf8260854a6d51d3ffac7f9a1c027ff41f7c591b90877d5619af
+  metadata.gz: '06898ad2ffae38015ec40dbeeefb1a46e468a7df73e933c69c194d06415123cc'
+  data.tar.gz: 74916bd3ca8fe11dbac3b6ac6b6085cc73cc9fd381fdf96aacd46fed82a3ba72
 SHA512:
-  metadata.gz: b0849e1a758445044928464b6af3b5cd3bd88474e0954eaa542c21d844bf460ddced9582595ccddc07b7843a60db859333537a9ccb960385dd6dd4ee2636a8ec
-  data.tar.gz: 0ab96c14d49e30c1e74beb75704f2e0078d1868a2e3d48a825ecb794fa8f9bac6af48f75b1e2080433da1ce69e64266e71d0ef4f5e4dd83c1c0047fdc40ea6ca
+  metadata.gz: 27fc19935dabbad5e6710ad06a9ea883d04a983541ae5308d706c62bc5546c295a922a6143fb9778980fd80ec26817c1d68ea7025b32d6950558da8af09290de
+  data.tar.gz: 1789579e269f287c2b4db33748d3039f6bc0b152506a0c597ebcbbbd58c8064f38cb240c2de4f76740bd01b620ffcb64c2dbbbda8eee822a513de5d9ea46c322

data/app/controllers/effective/pages_controller.rb

@@ -8,6 +8,8 @@ module Effective
 
       @page = @pages.find(params[:id])
 
+      raise ActionController::RoutingError.new('Not Found') if @page.menu_root_with_children?
+
       if @page.authenticate_user? || @page.roles.present?
         authenticate_user!
       end
@@ -22,9 +24,8 @@ module Effective
       if EffectiveResources.authorized?(self, :admin, :effective_pages)
         flash.now[:warning] = [
           'Hi Admin!',
-          ('You are viewing a hidden page.' unless @page.published?),
-          'Click here to',
-          ("<a href='#{effective_pages.edit_admin_page_path(@page)}' class='alert-link'>edit page settings</a>.")
+          ('You are viewing a draft page.' unless @page.published?),
+          ("<a href='#{effective_pages.edit_admin_page_path(@page)}' class='alert-link'>Click here to edit this page</a>.")
         ].compact.join(' ')
       end
 

data/app/datatables/effective_pages_datatable.rb

@@ -1,10 +1,10 @@
 class EffectivePagesDatatable < Effective::Datatable
 
   filters do
+    scope :all
     scope :published
     scope :draft
     scope :on_menu
-    scope :all
   end
 
   datatable do
@@ -25,10 +25,12 @@ class EffectivePagesDatatable < Effective::Datatable
     col :layout, visible: false
     col :tempate, visible: false
 
-    col :menu
-    col :menu_name, visible: false
+    col :menu_name
+    col :menu_title
+    col :menu_group
+
     col :menu_url, visible: false
-    col :menu_parent, visible: false
+    col :menu_parent, search: { collection: admin_menu_parent_collection(), grouped: true }
     col :menu_position, visible: false
 
     col :authenticate_user, visible: false

data/app/datatables/effective_pages_menu_datatable.rb

@@ -13,18 +13,34 @@ class EffectivePagesMenuDatatable < Effective::Datatable
 
     col :menu_url, label: 'Redirect Url'
     col :menu_position, label: 'Position', visible: false
-    col :menu_children, label: 'Children'
+
+    # We only support depth 2 and 3.
+    col :menu_children, label: 'Children' do |page|
+      page.menu_children.group_by(&:menu_group).values.flatten.map do |child|
+        content_tag(:div, class: 'col-resource_item') do
+          link = link_to(child.admin_menu_label, 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
+        end
+      end.join.html_safe
+    end
 
     actions_col(new: false, destroy: false)
   end
 
   collection(apply_belongs_to: false) do
-    scope = Effective::Page.deep.for_menu(menu)
+    scope = Effective::Page.deep.menuable
+
+    if attributes[:menu].present?
+      scope = scope.root_level.for_menu(menu)
+    end
 
-    scope = if attributes[:menu_parent_id].present?
-      scope.where(menu_parent_id: attributes[:menu_parent_id])
-    else
-      scope.where(menu_parent_id: nil)
+    if attributes[:page_id].present?
+      scope = scope.where(menu_parent_id: attributes[:page_id])
     end
 
     scope

data/app/helpers/effective_menus_helper.rb

@@ -12,18 +12,24 @@ module EffectiveMenusHelper
     content_tag(:ul, options) { render('effective/pages/menu', menu: menu) }
   end
 
+  def render_page_menu(page, options = {}, &block)
+    raise('expected a page with menu true') unless page.kind_of?(Effective::Page) && page.menu?
+
+    content_tag(:ul, options) { render('effective/pages/page_menu', page: page) }
+  end
+
   def render_breadcrumbs(menu, page = @page, root: 'Home')
     return breadcrumbs_root_url(page, root: root) if request.path == '/'
     return breadcrumbs_fallback(page, root: root) unless page.kind_of?(Effective::Page)
 
-    parents = [page.menu_parent].compact
+    parents = [page.menu_parent&.menu_parent, page.menu_parent].compact
 
     content_tag(:ol, class: 'breadcrumb') do
       (
         [content_tag(:li, link_to(root, root_path, title: root), class: 'breadcrumb-item')] +
         parents.map do |page|
           url = (page.menu_url.presence || effective_pages.page_path(page))
-          content_tag(:li, link_to(page, url, title: page.title), class: 'breadcrumb-item')
+          content_tag(:li, link_to(page, (page.menu_root_with_children? ? '#' : url), title: page.title), class: 'breadcrumb-item')
         end +
         [content_tag(:li, page, class: 'breadcrumb-item active', 'aria-current': 'page')]
       ).join.html_safe
@@ -49,4 +55,30 @@ module EffectiveMenusHelper
     end
   end
 
+  def admin_menu_parent_collection(page = nil)
+    raise('expected a page') if page.present? && !page.kind_of?(Effective::Page)
+
+    pages = Effective::Page.menuable.root_level.where.not(id: page)
+
+    if EffectivePages.max_menu_depth == 2
+      # You can only select root level pages
+      pages.group_by(&:menu_name)
+    elsif EffectivePages.max_menu_depth == 3
+      # 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|
+          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
+  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? && 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,20 +73,34 @@ 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') }
 
-    scope :menuable, -> { where(menu: true).order(:menu_position) }
+    scope :menuable, -> { published.where(menu: true).order(:menu_position) }
     scope :menu_deep, -> { includes(:menu_parent, :menu_children) }
 
     scope :for_menu, -> (name) { menuable.where(menu_name: name) }
     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
@@ -114,8 +132,26 @@ module Effective
       duplicate.tap { |page| page.save! }
     end
 
+    # When true, this should not appear in sitemap.xml and should return 404 if visited
+    def menu_root_with_children?
+      menu_root? && menu_parent?
+    end
+
+    # This is for the form
     def menu_root_level
-      menu? && menu_parent.blank?
+      menu_root?
+    end
+
+    def menu_root?
+      menu? && menu_parent_id.blank?
+    end
+
+    def menu_parent?
+      menu? && menu_children.to_a.present?
+    end
+
+    def menu_child?
+      menu? && menu_parent_id.present?
     end
 
   end

data/app/views/admin/menus/index.html.haml

@@ -1,11 +1,11 @@
 %h1= @page_title
 
 %p
-  Click Reorder to drag & drop reorder the menu.
+  Click Reorder to drag & drop reorder menu items.
   Edit an item to reorder its children items.
 
 - EffectivePages.menus.each do |menu|
-  %h2 #{menu.to_s.titleize} Menu
+  %h3 #{menu.to_s.titleize} Menu
   - datatable = EffectivePagesMenuDatatable.new(menu: menu)
   = render_datatable(datatable, simple: true, inline: true)
-  %hr
+  %hr.my-5

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

@@ -1,13 +1,6 @@
-- if inline_datatable? && inline_datatable.attributes[:menu]
-  - menu = inline_datatable.attributes[:menu]
-  - datatable = EffectivePagesMenuDatatable.new(menu: menu, menu_parent_id: page.id)
-
+- if inline_datatable?
   = render '/admin/pages/form_menu', page: page
 
-  - if datatable.present?(self)
-    %h3 Children
-    = render_datatable(datatable, simple: true, inline: true)
-
 - else
   = tabs do
     = tab 'Page' do
@@ -18,10 +11,6 @@
         = tab 'Menu' do
           = render '/admin/pages/form_menu', page: page
 
-      - unless page.menu_root_level
-        = tab 'Content' do
-          = render '/admin/pages/form_content', page: page
-
       = tab 'Access' do
         = render '/admin/pages/form_access', page: page
 

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

@@ -1,10 +1,7 @@
 = effective_form_with(model: page, url: page.persisted? ? effective_pages.admin_page_path(page.id) : effective_pages.admin_pages_path) do |f|
-  = f.check_box :authenticate_user, label: 'Yes, the user must be be signed in to view this page'
+  = f.check_box :authenticate_user, label: 'Restrict the page to any signed in user'
 
   - if EffectivePages.use_effective_roles
-    = f.checks :roles, EffectiveRoles.roles_collection(f.object)
-
-  %p.text-hint
-    * leave blank for a regular public page that anyone can view
+    = f.checks :roles, EffectiveRoles.roles_collection(f.object), label: 'Restrict the page to any signed in user that has the role:'
 
   = f.submit

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

@@ -1,24 +1,35 @@
 = effective_form_with(model: page, url: page.persisted? ? effective_pages.admin_page_path(page.id) : effective_pages.admin_pages_path) do |f|
-  = f.check_box :menu, label: 'Yes, display this page on the menu'
+  = f.check_box :menu, label: 'Yes, display this page in a menu'
 
   = f.show_if :menu, true do
 
-    - if (menus = EffectivePages.menus).length > 1
-      = f.select :menu_name, menus
-    - else
-      = f.hidden_field :menu_name, value: menus.first
-
-    = f.check_box :menu_root_level, label: "This is a top level menu item. Do not show page content."
+    = f.check_box :menu_root_level, label: "This is a top level menu item. It has no content and cannot be viewed, but can have children pages"
 
     = f.show_if :menu_root_level, true do
       = f.hidden_field :menu_parent_id, value: nil
 
+      - if (menus = EffectivePages.menus).length > 1
+        = f.select :menu_name, menus, label: 'Top level menu item in this menu'
+      - else
+        = f.hidden_field :menu_name, value: menus.first
+
     = f.show_if :menu_root_level, false do
-      = f.select :menu_parent_id, Effective::Page.menuable.root_level.where.not(id: f.object), required: 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
+    %h3 Parent
+    = link_to(page.menu_parent, effective_pages.edit_admin_page_path(page.menu_parent))
+
+- if page.menu_children.present?
+  %h3 Children
+  - datatable = EffectivePagesMenuDatatable.new(page: page)
+  = render_datatable(datatable, simple: true, inline: true)

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

@@ -1,11 +1,12 @@
 = effective_form_with(model: page, url: page.persisted? ? effective_pages.admin_page_path(page.id) : effective_pages.admin_pages_path) do |f|
-  = f.text_field :title, hint: 'The title of your page.'
+
+  = f.text_field :title
 
   = f.check_box :draft,
-    label: 'Save this page as a draft. It will not be accessible on the website.'
+    label: 'Save this page as a draft. It will not appear in a menu and can only be accessed by admin users.'
 
   = f.text_field :meta_description,
-    hint: "A one or two sentence summary of this page. Appears on Google search results underneath the page title.",
+    hint: "150 character summary. Appears on Google search results underneath the page title. ",
     input_html: { maxlength: 150 }
 
   - if (layouts = EffectivePages.layouts).length > 1
@@ -24,8 +25,20 @@
 
   = render partial: '/admin/pages/additional_fields', locals: { page: page, form: f, 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

@@ -1,20 +1,24 @@
 - raise('expected a menu') unless menu.present?
 - menu = menu.to_s
 
+- # Renders menu_root? level pages and their immediate children
 - Effective::Page.for_menu_root(menu).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 = page.menu_children.select { |page| page.menu_name == menu }
+  - 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)))
-  - 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?
+    = nav_link_to(page.menu_to_s, (page.menu_url.presence || effective_pages.page_path(page)))
 
-        = nav_link_to((page.menu_title.presence || page.title), (page.menu_url.presence || effective_pages.page_path(page)))
+  - 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_to_s, (page.menu_url.presence || effective_pages.page_path(page)))

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

@@ -0,0 +1,17 @@
+- raise('expected a page') unless page.present?
+
+- menu_children = page.menu_children
+
+- if menu_children.blank? && page.menu_parent&.menu_children.present?
+  - menu_children = page.menu_parent&.menu_children
+
+- menu_children.group_by(&:menu_group).each do |menu_group, pages|
+  - if menu_group.present?
+    %h6= menu_group
+
+  - 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

@@ -50,4 +50,10 @@ EffectivePages.setup do |config|
   # Layout Settings
   # config.layout = { admin: 'admin' }
 
+  # Menus
+  # Strict bootstrap only supports depth 2. A root level and one dropdown.
+  # Other sites can be configured such that the depth 3 menus are displayed on a sidebar.
+  # Only 2 or 3 are supported right now
+  config.max_menu_depth = 2
+
 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

data/lib/effective_pages/version.rb

@@ -1,3 +1,3 @@
 module EffectivePages
-  VERSION = '3.1.0'.freeze
+  VERSION = '3.2.0'.freeze
 end

data/lib/effective_pages.rb

@@ -12,7 +12,7 @@ module EffectivePages
       :site_og_image, :site_og_image_width, :site_og_image_height,
       :site_title, :site_title_suffix, :fallback_meta_description,
       :silence_missing_page_title_warnings, :silence_missing_meta_description_warnings, :silence_missing_canonical_url_warnings,
-      :use_effective_roles, :menus, :layout
+      :use_effective_roles, :menus, :layout, :max_menu_depth
     ]
   end
 
@@ -43,4 +43,10 @@ module EffectivePages
     end.compact.sort
   end
 
+  def self.max_menu_depth
+    depth = config[:max_menu_depth] || 2
+    raise('only depths 2 and 3 are supported') unless [2, 3].include?(depth)
+    depth
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_pages
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-24 00:00:00.000000000 Z
+date: 2022-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -87,11 +87,11 @@ files:
 - app/views/admin/pages/_additional_fields.html.haml
 - app/views/admin/pages/_form.html.haml
 - app/views/admin/pages/_form_access.html.haml
-- app/views/admin/pages/_form_content.html.haml
 - app/views/admin/pages/_form_menu.html.haml
 - app/views/admin/pages/_form_page.html.haml
 - app/views/admin/pages/_rich_text_areas.html.haml
 - app/views/effective/pages/_menu.html.haml
+- app/views/effective/pages/_page_menu.html.haml
 - config/effective_pages.rb
 - config/routes.rb
 - db/migrate/01_create_effective_pages.rb.erb

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

@@ -1,3 +0,0 @@
-= effective_form_with(model: page, url: page.persisted? ? effective_pages.admin_page_path(page.id) : effective_pages.admin_pages_path) do |f|
-  = render '/admin/pages/rich_text_areas', page: page, f: f
-  = effective_submit(f)