effective_pages 3.14.5 → 3.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4c5c010eb0062bb4d36b19ab478e5e64c53bc187e40a05f86474653efe16cbb
-  data.tar.gz: 5efeb5d54ae12c0bb645543a2be34384d501bae3dbba777fe085906f3fd9a034
+  metadata.gz: e0b5fff4b2c3aa603eaa0662c480e200c64c31fa0b71754b6fce98ee946b26b2
+  data.tar.gz: 907df11e88aa7bd545146dcd60ba3f3b4bd5874d52d883b196ff5cb70cec0b09
 SHA512:
-  metadata.gz: 635d94a58f8b5940e9176215c43fcff111a27c355a599859e1e4aea47a5127fea8ce6ea5fdc7d2e32563a4a36cce44b8f4a023fc5bca6edb3e2a8044e6e4dd79
-  data.tar.gz: 3fd3d0e922af563574c46034c7ba111e4935b0cde3b840b9f26af85ccb77e5c9f1f19deb7160a9837852f87b65fe3263e72c1775c4cea2d1d9a309a0cf76fa73
+  metadata.gz: 4806598309444219cff8af959ff90ff1ab1817a59caa7acd727f6f345f54f6578eabe4bf914baa3729073b528e1da7b4ad3f149ce1d22b59abee1484577716bb
+  data.tar.gz: 16757879d021e4442c189740c3e586246169ebbf547cc51562db18fd795b86a44ccc9f924a6274ca53609e767fe4dba885ad3e6c7df4cf33cef648ec1fe13450

data/app/controllers/admin/banner_ads_controller.rb

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

data/app/controllers/effective/banner_ads_controller.rb

@@ -0,0 +1,13 @@
+module Effective
+  class BannerAdsController < ApplicationController
+    include Effective::CrudController
+
+    def show
+      @banner_ad = Effective::BannerAd.find_by!(slug: params[:slug])
+
+      authorize! :show, @banner_ad
+
+      redirect_to @banner_ad.url, allow_other_host: true
+    end
+  end
+end

data/app/datatables/admin/effective_banner_ads_datatable.rb

@@ -0,0 +1,50 @@
+module Admin
+  class EffectiveBannerAdsDatatable < Effective::Datatable
+    filters do
+      scope :all
+      scope :published
+      scope :draft
+    end
+
+    datatable do
+      order :updated_at
+
+      col :updated_at, visible: false
+      col :created_at, visible: false
+      col :id, visible: false
+
+      col :published?, as: :boolean
+      col :published_start_at, label: "Published start", visible: false
+      col :published_end_at, label: "Published end", visible: false
+
+      col :location, search: EffectivePages.banner_ads
+      col :name
+
+      col :file, label: 'Image' do |banner_ad|
+        if banner_ad.file.attached?
+          image_tag(url_for(banner_ad.file), style: 'max-width: 200px;')
+        end
+      end
+
+      col :caption, visible: false
+
+      col(:path) do |banner_ad|
+        if banner_ad.redirect_path.present?
+          url = (root_url.chomp('/') + banner_ad.redirect_path)
+          link_to(url, url, target: '_blank')
+        end
+      end
+
+      col :url, visible: false
+      col :slug, visible: false
+
+      col :tracks_count, label: 'Clicks'
+
+      actions_col
+    end
+
+    collection do
+      Effective::BannerAd.deep.all
+    end
+  end
+end

data/app/datatables/effective_pages_menu_datatable.rb

@@ -8,7 +8,7 @@ class EffectivePagesMenuDatatable < Effective::Datatable
     end
 
     col :title do |page|
-      link_to(page, effective_pages.edit_admin_page_path(page))
+      link_to(page.menu_to_s, effective_pages.edit_admin_page_path(page))
     end
 
     col :menu_url, label: 'Redirect Url'

data/app/helpers/effective_banner_ads_helper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module EffectiveBannerAdsHelper
+
+  def effective_banner_ads
+    @_effective_banner_ads ||= Effective::BannerAd.published.deep.all
+  end
+
+  def render_banner_ad(location, opts = {}, &block)
+    location = EffectivePages.banner_ads.find { |obj| obj == location }
+    raise("unknown banner ad location: #{location.presence || 'nil'}. Please add it to EffectivePages.banner_ads config option") if location.blank?
+
+    banner_ads = effective_banner_ads.select { |ba| ba.location == location }
+    banner_ad = banner_ads.sample
+
+    if block_given?
+      yield(banner_ad); nil
+    else
+      render('effective/banner_ads/banner_ad', banner_ad: banner_ad, banner_ad_opts: opts)
+    end
+  end
+
+end

data/app/models/effective/banner_ad.rb

@@ -0,0 +1,55 @@
+# Banner ads have an image attachment, title, location, and optional external URL
+# Ads are assigned to a named location.
+# If more than one published ad is assigned to a location, randomly select an ad when rendering the page. If there is only one ad for the location and date/time, always show the one ad.
+module Effective
+  class BannerAd < ActiveRecord::Base
+    self.table_name = (EffectivePages.banner_ads_table_name || :banner_ads).to_s
+
+    acts_as_published
+    acts_as_slugged
+
+    acts_as_trackable if respond_to?(:acts_as_trackable)
+    log_changes if respond_to?(:log_changes)
+
+    has_one_attached :file
+
+    effective_resource do
+      name              :string
+      location          :string
+
+      published_start_at       :datetime
+      published_end_at         :datetime
+
+      caption      :string
+      url          :string
+      
+      # acts_as_slugged
+      slug         :string
+
+      # acts_as_trackable
+      tracks_count :integer
+
+      timestamps
+    end
+
+    validates :name, presence: true
+    validates :location, presence: true
+    validates :file, presence: true
+    validates :url, url: true
+
+    scope :deep, -> { with_attached_file }
+    scope :sorted, -> { order(:name) }
+
+    def to_s
+      name.presence || model_name.human
+    end
+
+    def redirect_path
+      "/ad/#{slug}" if url.present?
+    end
+
+    def track!(action: 'click', user: nil, details: nil)
+      tracks.create!(action: action, user: user, details: details)
+    end
+  end
+end

data/app/models/effective/carousel_item.rb

@@ -47,12 +47,12 @@ module Effective
 
     validate(if: -> { carousel.present? && EffectivePages.carousels? }) do
       unless (carousels = EffectivePages.carousels).find { |c| c.to_s == carousel.to_s }.present?
-        self.errors.add(:carousel, "must be one of #{carousels.to_sentence}")
+        errors.add(:carousel, "must be one of #{carousels.to_sentence}")
       end
     end
 
     validate(if: -> { file.attached? }) do
-      self.errors.add(:file, 'must be an image') unless file.image?
+      errors.add(:file, 'must be an image') unless file.image?
     end
 
     def to_s

data/app/models/effective/page.rb

@@ -115,7 +115,7 @@ module Effective
 
     validate(if: -> { menu_url.present? }) do
       unless menu_url.start_with?('http://') || menu_url.start_with?('https://') || menu_url.start_with?('/')
-        self.errors.add(:menu_url, "must start with http(s):// or /")
+        errors.add(:menu_url, "must start with http(s):// or /")
       end
     end
 
@@ -132,8 +132,8 @@ module Effective
 
     validate(if: -> { banner? && EffectivePages.banners? }) do
       unless (page_banner.present? ^ banner_random? ^ EffectivePages.banners_force_randomize) # xor
-        self.errors.add(:page_banner_id, "please select a page banner or random")
-        self.errors.add(:banner_random, "please select a page banner or random")
+        errors.add(:page_banner_id, "please select a page banner or random")
+        errors.add(:banner_random, "please select a page banner or random")
       end
     end
 

data/app/models/effective/page_banner.rb

@@ -32,7 +32,7 @@ module Effective
     validates :file, presence: true, content_type: :image, size: { less_than: 1.megabyte }
 
     validate(if: -> { file.attached? }) do
-      self.errors.add(:file, 'must be an image') unless file.image?
+      errors.add(:file, 'must be an image') unless file.image?
     end
 
     def to_s

data/app/models/effective/permalink.rb

@@ -25,12 +25,15 @@ module Effective
 
     effective_resource do
       title        :string
-      slug         :string
-
       url          :string
-
       summary      :text
 
+      # acts_as_slugged
+      slug         :string
+
+      # acts_as_trackable
+      tracks_count :integer
+
       timestamps
     end
 
@@ -62,7 +65,7 @@ module Effective
 
     def attachment_and_url_cannot_both_be_present
       if url.present? && (attachment.attached? && !attachment.marked_for_destruction?)
-        self.errors.add(:base, 'Attachment and URL cannot both be present')
+        errors.add(:base, 'Attachment and URL cannot both be present')
       end
     end
   end

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

@@ -1,5 +1,5 @@
 = tabs do
-  = tab 'Alert' do
+  = tab(alert) do
     = render '/admin/alerts/form_alert', alert: alert
 
   - if alert.persisted?

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

@@ -0,0 +1,12 @@
+= tabs do
+  = tab(banner_ad) do
+    = render '/admin/banner_ads/form_banner_ad', banner_ad: banner_ad
+
+  - if banner_ad.persisted?
+    - if banner_ad.class.respond_to?(:acts_as_trackable?)
+      = tab 'Tracks' do
+        - datatable = Admin::EffectiveTracksDatatable.new(owner: banner_ad)
+        = render_datatable(datatable, inline: true, namespace: :admin)
+
+    = tab 'Logs' do
+      = render_datatable(banner_ad.log_changes_datatable, inline: true, namespace: :admin)

data/app/views/admin/banner_ads/_form_banner_ad.html.haml

@@ -0,0 +1,14 @@
+= effective_form_with(model: [:admin, banner_ad], engine: true) do |f|
+  = f.text_field :name
+  = acts_as_slugged_fields(f, url: (effective_pages.banner_ad_url(f.object) rescue nil))
+
+  = f.select :location, EffectivePages.banner_ads, label: 'Location', hint: 'Each location will display one random banner ad. Please contact us to add more locations.'
+  = acts_as_published_fields(f)
+
+  = f.file_field :file, label: 'Image attachment', hint: EffectivePages.banner_ads_hint_text
+  = f.text_field :caption, hint: 'Optional. Displayed alongside the image'
+
+  .row
+    .col-md-6= f.url_field :url, label: 'Redirect url', hint: 'Optional. When present clicking the banner ad will redirect to this url and track clicks.'
+
+  = effective_submit(f)

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

@@ -1,5 +1,5 @@
 = tabs do
-  = tab 'Carousel Item' do
+  = tab(carousel_item) do
     = render '/admin/carousel_items/form_carousel_item', carousel_item: carousel_item
 
   - if carousel_item.persisted?

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

@@ -1,5 +1,5 @@
 = tabs do
-  = tab 'Page Banner' do
+  = tab(page_banner) do
     = render '/admin/page_banners/form_page_banner', page_banner: page_banner
 
   - if page_banner.persisted?

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

@@ -1,5 +1,5 @@
 = tabs do
-  = tab 'Page Section' do
+  = tab(page_section) do
     = render '/admin/page_sections/form_page_section', page_section: page_section
 
   - if page_section.persisted?

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

@@ -3,7 +3,7 @@
 
 - else
   = tabs do
-    = tab 'Page' do
+    = tab(page) do
       = render '/admin/pages/form_page', page: page
 
     - if page.persisted?

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

@@ -27,7 +27,10 @@
     = f.text_field :menu_url, label: "Redirect to path or url instead of displaying page",
       hint: "Must start with http(s):// or /"
 
-  = effective_submit(f)
+  - if inline_datatable?
+    = f.submit 'Save'
+  - else
+    = effective_submit(f)
 
 - if page.menu_parent.present?
   .mb-4

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

@@ -1,5 +1,5 @@
 = tabs do
-  = tab 'Permalink' do
+  = tab(permalink) do
     = render '/admin/permalinks/form_permalink', permalink: permalink
 
   - if permalink.persisted?

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

@@ -1,5 +1,5 @@
 = tabs do
-  = tab 'Tag' do
+  = tab(tag) do
     = render '/admin/tags/form_tag', tag: tag
 
   - if tag.persisted?

data/app/views/admin/tags/_form_tag.html.haml

@@ -1,4 +1,4 @@
 = effective_form_with(model: [:admin, tag], engine: true) do |f|
-  = f.text_field :name, hint: 'Tag name'
+  = f.text_field :name
 
   = f.submit 'Save'

data/app/views/effective/banner_ads/_banner_ad.html.haml

@@ -0,0 +1,6 @@
+.effective-banner-ad{banner_ad_opts}
+  - if banner_ad.redirect_path.present?
+    = link_to(banner_ad.redirect_path) do
+      = image_tag(banner_ad.file, alt: banner_ad.caption)
+  - else
+    = image_tag(banner_ad.file, alt: banner_ad.caption)

data/config/effective_pages.rb

@@ -57,6 +57,11 @@ EffectivePages.setup do |config|
   # Only 2 or 3 are supported right now
   config.max_menu_depth = 2
 
+  # Banner Ads
+  config.banner_ads = false
+  # config.banner_ads = [:home, :secondary]
+  config.banner_ads_hint_text = 'Hint text that includes required image dimensions'
+
   # Page Banners
   # Allow a page banner to be selected on the Admin::Pages#edit screen
   # Banners can be CRUD by the admin

data/config/locales/effective_pages.en.yml

@@ -6,5 +6,6 @@ en:
   activerecord:
     models:
       effective/tagging: 'Taggings'
+      effective/banner_ad: 'Banner Ad'
       effective/page_banner: 'Page Banner'
       effective/page_section: 'Page Section'

data/config/routes.rb

@@ -5,9 +5,11 @@ EffectivePages::Engine.routes.draw do
     resources :pages,           except: [:show]
     resources :page_sections,   only:   [:index, :edit, :update]
     resources :page_banners,    except: [:show]
+
     resources :menus,           only:   [:index]
-    resources :carousel_items,  except: [:show]
     resources :alerts,          except: [:show]
+    resources :banner_ads,      except: [:show]
+    resources :carousel_items,  except: [:show]
     resources :permalinks,      except: [:show]
     resources :tags,            except: [:show]
     resources :taggings,        only:   [:index]
@@ -15,6 +17,7 @@ EffectivePages::Engine.routes.draw do
 
   scope module: 'effective' do
     get '/link/:slug', to: 'permalinks#show', as: :permalink_redirect
+    get '/ad/:slug', to: 'banner_ads#show', as: :banner_ad
 
     match '*id', to: 'pages#show', via: :get, as: :page, constraints: lambda { |req|
       Effective::Page.find_by_slug_or_id(req.path_parameters[:id] || '/').present?

data/db/migrate/101_create_effective_pages.rb

@@ -128,6 +128,26 @@ class CreateEffectivePages < ActiveRecord::Migration[6.0]
 
     add_index :taggings, [:taggable_type, :taggable_id], if_not_exists: true
     add_index :taggings, :tag_id, if_not_exists: true
+
+    create_table :banner_ads, if_not_exists: true do |t|
+      t.string :name
+      t.string :location
+
+      t.datetime :published_start_at
+      t.datetime :published_end_at
+
+      t.string :caption
+      t.string :url
+
+      t.string :slug
+      t.integer :tracks_count, default: 0
+
+      t.timestamps
+    end
+
+    add_index :banner_ads, :name, :unique => true
+    add_index :banner_ads, :location, if_not_exists: true
+    add_index :banner_ads, [:published_start_at, :published_end_at], if_not_exists: true
   end
 
 end

data/lib/effective_pages/version.rb

@@ -1,3 +1,3 @@
 module EffectivePages
-  VERSION = '3.14.5'.freeze
+  VERSION = '3.15.0'.freeze
 end

data/lib/effective_pages.rb

@@ -7,19 +7,19 @@ require 'effective_pages/version'
 module EffectivePages
   def self.config_keys
     [
-      :pages_table_name, :page_banners_table_name, :page_sections_table_name, :page_segments_table_name, 
+      :pages_table_name, :page_banners_table_name, :page_sections_table_name, :page_segments_table_name, :banner_ads_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,
       :silence_missing_page_title_warnings, :silence_missing_meta_description_warnings, :silence_missing_canonical_url_warnings,
-      :use_effective_roles, :layout, :max_menu_depth, :banners_hint_text, :carousels_hint_text, :banners_force_randomize,
+      :use_effective_roles, :layout, :max_menu_depth, :banner_ads_hint_text, :banners_hint_text, :carousels_hint_text, :banners_force_randomize,
 
       # Booleans
       :banners, :sidebars,
 
       # Hashes
-      :menus, :carousels
+      :menus, :carousels, :banner_ads
     ]
   end
 
@@ -60,6 +60,10 @@ module EffectivePages
     !!banners
   end
 
+  def self.banner_ads?
+    banner_ads.kind_of?(Array) && banner_ads.present?
+  end
+
   def self.carousels?
     carousels.kind_of?(Array) && carousels.present?
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_pages
 version: !ruby/object:Gem::Version
-  version: 3.14.5
+  version: 3.15.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-13 00:00:00.000000000 Z
+date: 2025-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -163,6 +163,7 @@ files:
 - app/assets/javascripts/effective_pages.js
 - app/assets/javascripts/effective_pages/google_analytics.js
 - app/controllers/admin/alerts_controller.rb
+- app/controllers/admin/banner_ads_controller.rb
 - app/controllers/admin/carousel_items_controller.rb
 - app/controllers/admin/menus_controller.rb
 - app/controllers/admin/page_banners_controller.rb
@@ -171,8 +172,10 @@ files:
 - app/controllers/admin/permalinks_controller.rb
 - app/controllers/admin/taggings_controller.rb
 - app/controllers/admin/tags_controller.rb
+- app/controllers/effective/banner_ads_controller.rb
 - app/controllers/effective/pages_controller.rb
 - app/controllers/effective/permalinks_controller.rb
+- app/datatables/admin/effective_banner_ads_datatable.rb
 - app/datatables/admin/effective_taggings_datatable.rb
 - app/datatables/admin/effective_tags_datatable.rb
 - app/datatables/effective_alerts_datatable.rb
@@ -183,6 +186,7 @@ files:
 - app/datatables/effective_pages_menu_datatable.rb
 - app/datatables/effective_permalinks_datatable.rb
 - app/helpers/effective_alerts_helper.rb
+- app/helpers/effective_banner_ads_helper.rb
 - app/helpers/effective_carousels_helper.rb
 - app/helpers/effective_menus_helper.rb
 - app/helpers/effective_page_banners_helper.rb
@@ -193,6 +197,7 @@ files:
 - app/helpers/effective_tags_helper.rb
 - app/models/concerns/acts_as_tagged.rb
 - app/models/effective/alert.rb
+- app/models/effective/banner_ad.rb
 - app/models/effective/carousel_item.rb
 - app/models/effective/page.rb
 - app/models/effective/page_banner.rb
@@ -203,6 +208,8 @@ files:
 - app/models/effective/tagging.rb
 - app/views/admin/alerts/_form.html.haml
 - app/views/admin/alerts/_form_alert.html.haml
+- app/views/admin/banner_ads/_form.html.haml
+- app/views/admin/banner_ads/_form_banner_ad.html.haml
 - app/views/admin/carousel_items/_form.html.haml
 - app/views/admin/carousel_items/_form_carousel_item.html.haml
 - app/views/admin/carousel_items/index.html.haml
@@ -226,6 +233,7 @@ files:
 - app/views/admin/tags/_form.html.haml
 - app/views/admin/tags/_form_tag.html.haml
 - app/views/effective/alerts/_alert.html.haml
+- app/views/effective/banner_ads/_banner_ad.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