effective_pages 3.12.0 → 3.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a415e3b0c2a07052c1c2be02f5444637ce620debf117d680939a0ed57dffc4c0
-  data.tar.gz: aa71beffd9b9b95c841a329c19e6813d6f860dad393e6a0dfddd1150420c7de8
+  metadata.gz: 77904dcc5dcbdb4b61099c85b7ca2e201796a74a5018251eeebe66f3fcdf1128
+  data.tar.gz: 39d9c4b11d21ebdc73b31ddbd8925791a2a3bba78e5e839f15880f8fa7af4477
 SHA512:
-  metadata.gz: a93466db870f0d256d864c49ca2cec4f21e644198c05959490b6918a45ecfc83da350a94d68f669dc94cdf00e1b7d6a85ecfd769d7904e6a4f1d2cb070e16654
-  data.tar.gz: 24407df9909682c9cf3d781625e84b9eb0037b33a5da778541b8b8fed9f5988cd8dec5c2da1300387778d00ace3b36101a7a2548eb4863dc12ce62aad749299f
+  metadata.gz: 57fccf986d7b3279e0dd3f5bacd365841fe4b45db2d828de068eb8504f2da54f07a3005ae63951ebb621aca623ade13ede050b22b62c7cbe86278a4262ffd015
+  data.tar.gz: e290da633e3cc9cf3b08081457ea7e5218cbab17364fc6906ddd4f63c16f58b8ee86232f2f27fc097038b61847a192cf531896c3a328e7c71f5b1bc7a350a584

data/app/helpers/effective_page_segments_helper.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module EffectivePageSegmentsHelper
+
+  # This is a scrollspy navbar
+  # = render_page_segments_menu(class: 'navbar navbar-light bg-light')
+  def render_page_segments_menu(page = nil, options = {})
+    (options = page; page = nil) if page.kind_of?(Hash)
+    page ||= @page
+
+    raise('Expected an Effective::Page') if page && !page.kind_of?(Effective::Page)
+    raise('Expected a Hash of options') unless options.kind_of?(Hash)
+
+    return if page.blank?
+    return if page.page_segments.blank?
+    return unless page.template_page_segments?
+
+    # Default options
+    options[:class] ||= 'navbar navbar-light bg-light'
+
+    render('effective/page_segments/menu', page: page, html_options: options)
+  end
+
+  # Renders all page segments for one page
+  def render_page_segments(page = nil, options = {})
+    (options = page; page = nil) if page.kind_of?(Hash)
+    page ||= @page
+
+    raise('Expected an Effective::Page') if page && !page.kind_of?(Effective::Page)
+    raise('Expected a Hash of options') unless options.kind_of?(Hash)
+
+    return if page.blank?
+    return if page.page_segments.blank?
+
+    render('effective/page_segments/content', page: page, html_options: options)
+  end
+
+end

data/app/models/effective/alert.rb

@@ -18,7 +18,7 @@ module Effective
     validates :body, presence: true
 
     def to_s
-      'alert'
+      model_name.human
     end
 
   end

data/app/models/effective/carousel_item.rb

@@ -56,7 +56,7 @@ module Effective
     end
 
     def to_s
-      persisted? ? [carousel, number].join(' ') : 'carousel item'
+      persisted? ? [carousel, number].join(' ') : model_name.human
     end
 
     # As per has_many_rich_texts

data/app/models/effective/page.rb

@@ -19,6 +19,9 @@ module Effective
     has_many :menu_children, -> { Effective::Page.menuable }, class_name: 'Effective::Page',
       foreign_key: :menu_parent_id, inverse_of: :menu_parent
 
+    has_many :page_segments, -> { Effective::PageSegment.sorted }, class_name: 'Effective::PageSegment', inverse_of: :page, dependent: :destroy
+    accepts_nested_attributes_for :page_segments, allow_destroy: true
+
     acts_as_role_restricted if respond_to?(:acts_as_role_restricted)
     acts_as_paginable
     acts_as_published
@@ -137,7 +140,7 @@ module Effective
     end
 
     def to_s
-      title
+      title.presence || model_name.human
     end
 
     def menu_to_s
@@ -201,6 +204,9 @@ module Effective
       menu_children_count <= 0
     end
 
+    # Checked by render_page_segments_menu() to see if this page should render the page_segments menu
+    def template_page_segments?
+      template == 'page_segments'
+    end
   end
-
 end

data/app/models/effective/page_banner.rb

@@ -36,7 +36,7 @@ module Effective
     end
 
     def to_s
-      name.presence || 'page banner'
+      name.presence || model_name.human
     end
 
     # As per has_many_rich_texts

data/app/models/effective/page_section.rb

@@ -35,14 +35,12 @@ module Effective
     scope :sorted, -> { order(:name) }
 
     def to_s
-      name.presence || 'page section'
+      name.presence || model_name.human
     end
 
     # As per has_many_rich_texts
     def body
       rich_text_body
     end
-
   end
-
 end

data/app/models/effective/page_segment.rb

@@ -0,0 +1,43 @@
+# For use with the the ScrollSpy pages
+# Each PageSegment will be considered with the page_segments / scrollspy menu
+
+module Effective
+  class PageSegment < ActiveRecord::Base
+    self.table_name = (EffectivePages.page_segments_table_name || :page_segments).to_s
+
+    belongs_to :page
+
+    has_many_rich_texts
+    log_changes(to: :page) if respond_to?(:log_changes)
+
+    effective_resource do
+      title             :string
+      position          :integer
+
+      timestamps
+    end
+
+    before_validation(if: -> { page.present? }) do
+      self.position ||= (page.page_segments.map(&:position).compact.max || -1) + 1
+    end
+
+    validates :title, presence: true, uniqueness: { scope: :page_id }
+    validates :position, presence: true
+
+    scope :deep, -> { includes(:page, :rich_texts) }
+    scope :sorted, -> { order(:position) }
+
+    def to_s
+      title.presence || model_name.human
+    end
+
+    # As per has_many_rich_texts
+    def body
+      rich_text_body
+    end
+
+    def uid
+      title.parameterize
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+%p Please add one or more page segments. Each segment will be displayed on the in-page menu.
+
+= f.has_many :page_segments, f.object.page_segments do |fps|
+  = card do
+    = fps.text_field :title
+
+    - if defined?(EffectiveArticleEditor)
+      = fps.article_editor :rich_text_body, label: 'Body'
+    - else
+      = fps.rich_text_area :rich_text_body, label: 'Body'

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

@@ -1,12 +1,11 @@
 = effective_form_with(model: [:admin, page], engine: true) do |f|
-
   = f.text_field :title
 
   -# acts_as_published
   = f.hide_if(:save_as_draft, true) do
     .row
       .col-md-6
-        = f.datetime_field :published_start_at, hint: 'The page will be available starting on this date and time.'
+        = f.datetime_field :published_start_at, hint: 'The page will be available starting on this date and time. Leave blank to publish immediately.'
       .col-md-6
         = f.datetime_field :published_end_at, hint: 'The page will no longer be available after this date and time. Leave blank for no end date.', date_linked: false
 
@@ -49,7 +48,6 @@
 
         = f.select :page_banner_id, Effective::PageBanner.sorted.all, label: 'Choose a page banner'
 
-
   = render partial: '/admin/pages/additional_fields', locals: { page: page, form: f, f: f }
 
   - if f.object.persisted? && f.object.menu_root_with_children?
@@ -68,4 +66,8 @@
   - if f.object.new_record? && f.object.rich_texts.present?
     = render '/admin/pages/rich_text_areas', page: page, f: f
 
+  -# For use with the render_page_segments_menu() helper. Used to render the page_segments / scrollspy menu.
+  = f.show_if(:template, :page_segments) do
+    = render '/admin/pages/fields_page_segments', page: page, f: f
+
   = effective_submit(f)

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

@@ -1,6 +1,8 @@
 - if defined?(EffectiveArticleEditor)
   = f.article_editor :rich_text_body, label: 'Body', hint: 'The main body of your page'
-  = f.article_editor :rich_text_sidebar, label: 'Sidebar', hint: 'The sidebar content of your page'
+  - if EffectivePages.sidebars?
+    = f.article_editor :rich_text_sidebar, label: 'Sidebar', hint: 'The sidebar content of your page'
 - else
   = f.rich_text_area :rich_text_body, label: 'Body', hint: 'The main body of your page'
-  = f.rich_text_area :rich_text_sidebar, label: 'Sidebar', hint: 'The sidebar content of your page'
+  - if EffectivePages.sidebars?
+    = f.rich_text_area :rich_text_sidebar, label: 'Sidebar', hint: 'The sidebar content of your page'

data/app/views/effective/page_segments/_content.html.haml

@@ -0,0 +1,5 @@
+-# %div.effective-page-segments{'data-spy': 'scroll', 'data-target': "#effective-page-segments-menu", style: 'position: relative; height: 500px; overflow: auto;'}
+
+- page.page_segments.each do |segment|
+  %div{id: segment.uid}
+    = segment.body

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

@@ -0,0 +1,4 @@
+%nav#effective-page-segments-menu{local_assigns[:html_options]}
+  %ul.nav
+    - page.page_segments.each do |segment|
+      = nav_link_to(segment.to_s, "#" + segment.uid)

data/config/effective_pages.rb

@@ -70,4 +70,7 @@ EffectivePages.setup do |config|
   # config.carousels = [:home, :secondary]
   config.carousels_hint_text = 'Hint text that includes required image dimensions'
 
+  # Page Sidebars
+  # Set to true if your any of your pages use the sidebar content
+  config.sidebars = false
 end

data/db/migrate/101_create_effective_pages.rb

@@ -65,6 +65,16 @@ class CreateEffectivePages < ActiveRecord::Migration[6.0]
 
     add_index :page_sections, :name, :unique => true
 
+    create_table :page_segments do |t|
+      t.integer :page_id
+
+      t.string :title
+      t.integer :position
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
     create_table :carousel_items do |t|
       t.string :carousel
 

data/lib/effective_pages/engine.rb

@@ -18,6 +18,7 @@ module EffectivePages
           helper EffectivePagesHelper
           helper EffectiveCarouselsHelper
           helper EffectivePageSectionsHelper
+          helper EffectivePageSegmentsHelper
           helper EffectivePageBannersHelper
           helper EffectiveMenusHelper
           helper EffectiveAlertsHelper

data/lib/effective_pages/version.rb

@@ -1,3 +1,3 @@
 module EffectivePages
-  VERSION = '3.12.0'.freeze
+  VERSION = '3.13.0'.freeze
 end

data/lib/effective_pages.rb

@@ -7,7 +7,8 @@ require 'effective_pages/version'
 module EffectivePages
   def self.config_keys
     [
-      :pages_table_name, :page_sections_table_name, :page_banners_table_name, :carousel_items_table_name, :alerts_table_name, :permalinks_table_name, :tags_table_name, :taggings_table_name,
+      :pages_table_name, :page_banners_table_name, :page_sections_table_name, :page_segments_table_name, 
+      :alerts_table_name, :carousel_items_table_name, :permalinks_table_name, :tags_table_name, :taggings_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, :google_analytics_code,
@@ -15,7 +16,7 @@ module EffectivePages
       :use_effective_roles, :layout, :max_menu_depth, :banners_hint_text, :carousels_hint_text, :banners_force_randomize,
 
       # Booleans
-      :banners,
+      :banners, :sidebars,
 
       # Hashes
       :menus, :carousels
@@ -67,4 +68,7 @@ module EffectivePages
     menus.kind_of?(Array) && menus.present?
   end
 
+  def self.sidebars?
+    !!sidebars
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_pages
 version: !ruby/object:Gem::Version
-  version: 3.12.0
+  version: 3.13.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-28 00:00:00.000000000 Z
+date: 2024-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -187,6 +187,7 @@ files:
 - app/helpers/effective_menus_helper.rb
 - app/helpers/effective_page_banners_helper.rb
 - app/helpers/effective_page_sections_helper.rb
+- app/helpers/effective_page_segments_helper.rb
 - app/helpers/effective_pages_helper.rb
 - app/helpers/effective_permalinks_helper.rb
 - app/helpers/effective_tags_helper.rb
@@ -196,6 +197,7 @@ files:
 - app/models/effective/page.rb
 - app/models/effective/page_banner.rb
 - app/models/effective/page_section.rb
+- app/models/effective/page_segment.rb
 - app/models/effective/permalink.rb
 - app/models/effective/tag.rb
 - app/models/effective/tagging.rb
@@ -210,6 +212,7 @@ files:
 - 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/_fields_page_segments.html.haml
 - app/views/admin/pages/_form.html.haml
 - app/views/admin/pages/_form_access.html.haml
 - app/views/admin/pages/_form_menu.html.haml
@@ -224,6 +227,8 @@ files:
 - app/views/admin/tags/_form_tag.html.haml
 - app/views/effective/alerts/_alert.html.haml
 - app/views/effective/carousels/_carousel.html.haml
+- app/views/effective/page_segments/_content.html.haml
+- app/views/effective/page_segments/_menu.html.haml
 - app/views/effective/pages/_menu.html.haml
 - app/views/effective/pages/_page_menu.html.haml
 - app/views/effective/tags/_fields.html.haml