effective_pages 3.6.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a4bbe810bd4f30ca02c101c48465763f4c6f246bb2e89afa70ddb79e117df8b
-  data.tar.gz: a8780dabcf25e0403836da65af42af2497c120cbd6fa9b67388d2f66c24b2e74
+  metadata.gz: 955cae35489cf5133d4e988126070fb86de48849bb75d832b2acc43fc709d1b8
+  data.tar.gz: dc820dc28af2c81dbfaa4158ce1196209ec173dab3f16255121dab37e87586eb
 SHA512:
-  metadata.gz: 612e18117979fdc36a5eaf6db3db0041ec2192006a7965d23357efd56fd18f6976cfefb95eeb4159ad16db765e9a275d06abd235abd0d062aab2bd34288123ae
-  data.tar.gz: 301c723e79df66b45159ac505badabea9eac1ea68bd56eda0c57ef57ae4f9d1f6a47418c18bd985c9a75fada67ec20df6317f17a8483d1a0ce8fe96049a7b588
+  metadata.gz: 1a5e86f7a5c65d13432dd2701b7366f5d1a0ab4a7032bc9cc81ba278fc57e5d2777e8b4f339d28a1a61a48ca996adb0473ccf6c54487c80e363600fd4fd4a4a7
+  data.tar.gz: e967b492ab869e6bd1f02f523317e30899dcffe14a1a767162af5d1d7bd8df195e306da9cabbc2cbfedb01b509b588c5e6bf16aad402d1aaa82b86fc2c82c8ee

data/app/controllers/admin/taggings_controller.rb

@@ -0,0 +1,8 @@
+module Admin
+  class TaggingsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_pages) }
+
+    include Effective::CrudController
+  end
+end

data/app/controllers/admin/tags_controller.rb

@@ -0,0 +1,13 @@
+module Admin
+  class TagsController < 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_tag).permit!
+    end
+
+  end
+end

data/app/datatables/admin/effective_taggings_datatable.rb

@@ -0,0 +1,18 @@
+class Admin::EffectiveTaggingsDatatable < Effective::Datatable
+
+  datatable do
+    col :id, visible: false
+
+    col :tag
+    col :taggable
+
+    col :created_at
+
+    actions_col
+  end
+
+  collection do
+    Effective::Tagging.deep.all
+  end
+
+end

data/app/datatables/admin/effective_tags_datatable.rb

@@ -0,0 +1,16 @@
+class Admin::EffectiveTagsDatatable < Effective::Datatable
+
+  datatable do
+    col :id, visible: false
+    col :updated_at, visible: false
+
+    col :name
+
+    actions_col
+  end
+
+  collection do
+    Effective::Tag.deep.all
+  end
+
+end

data/app/helpers/effective_tags_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+module EffectiveTagsHelper
+end

data/app/models/concerns/acts_as_tagged.rb

@@ -0,0 +1,46 @@
+module ActsAsTagged
+  extend ActiveSupport::Concern
+
+  module Base
+    def acts_as_tagged(*options)
+      @acts_as_tagged = options || []
+      include ::ActsAsTagged
+    end
+  end
+
+  included do
+    has_many :taggings, as: :taggable, class_name: 'Effective::Tagging', dependent: :delete_all
+
+    has_many :tags, through: :taggings, class_name: 'Effective::Tag'
+
+    accepts_nested_attributes_for :tags, reject_if: :all_blank, allow_destroy: true
+
+    #
+    # Create or assign tags based on the input
+    #
+    # @param [Array<String, Integer>] input An array of tag names and/or tag ids, with a possible blank string
+    #
+    # @return [void]
+    #
+    def tags=(input)
+      input = (input - ['']).group_by { |value| value.gsub(/\D/, '').to_i > 0 }
+
+      ids = (input[true] || []).map(&:to_i)
+      names = input[false] || []
+
+      # Delete any existing Tags that aren't in this array
+      tags.each { |tag| tag.mark_for_destruction unless ids.include?(tag.id) }
+
+      # Create any new Tags
+      ids.each do |tag_id|
+        taggings.find { |tagging| tagging.tag_id == tag_id } || self.tags << Effective::Tag.where(id: tag_id).first!
+      end
+
+      names.each { |name| self.tags.build(name: name) }
+    end
+  end
+
+  module ClassMethods
+    def acts_as_tagged?; true; end
+  end
+end

data/app/models/effective/page.rb

@@ -46,6 +46,7 @@ module Effective
 
     acts_as_role_restricted
     acts_as_slugged
+    acts_as_tagged
     has_many_rich_texts
 
     log_changes if respond_to?(:log_changes)

data/app/models/effective/tag.rb

@@ -0,0 +1,27 @@
+module Effective
+  class Tag < ApplicationRecord
+    self.table_name = (EffectivePages.tags_table_name || :tags).to_s
+
+    log_changes if respond_to?(:log_changes)
+
+    has_many :taggings, class_name: 'Effective::Tagging', dependent: :delete_all
+
+    scope :deep,   -> { all }
+    scope :sorted, -> { order(:name) }
+
+    effective_resource do
+      name        :string
+
+      timestamps
+    end
+
+    validates :name, presence: true
+    validates :name, uniqueness: true
+
+    public
+
+    def to_s
+      name.presence || model_name.human
+    end
+  end
+end

data/app/models/effective/tagging.rb

@@ -0,0 +1,26 @@
+module Effective
+  class Tagging < ApplicationRecord
+    self.table_name = (EffectivePages.taggings_table_name || :taggings).to_s
+
+    belongs_to :tag, class_name: 'Effective::Tag'
+    belongs_to :taggable, polymorphic: true
+
+    scope :deep, -> { all }
+
+    effective_resource do
+      tag_id          :integer
+      taggable_id     :integer
+      taggable_type   :string
+
+      timestamps
+    end
+
+    validates :tag_id, uniqueness: { scope: [:taggable_type, :taggable_id] }
+
+    public
+
+    def to_s
+      name
+    end
+  end
+end

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

@@ -16,3 +16,6 @@
 
       = tab 'Logs' do
         = render_datatable(page.log_changes_datatable, inline: true, namespace: :admin)
+
+      = tab 'Tags' do
+        = render '/admin/pages/form_tags', page: page

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

@@ -0,0 +1,4 @@
+= effective_form_with(model: [:admin, page], engine: true) do |f|
+  = render 'effective/tags/fields', f: f
+
+  = f.submit

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

@@ -0,0 +1,3 @@
+= tabs do
+  = tab 'Tagged content' do
+    = render_datatable(EffectiveTaggingsDatatable.new, namespace: :admin)

data/app/views/admin/taggings/_form_tagging.html.haml

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

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

@@ -0,0 +1,7 @@
+= tabs do
+  = tab 'Tag' do
+    = render '/admin/tags/form_tag', tag: tag
+
+  - if tag.persisted?
+    = tab 'Logs' do
+      = render_datatable(tag.log_changes_datatable, inline: true, namespace: :admin)

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

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

data/app/views/effective/tags/_fields.html.haml

@@ -0,0 +1 @@
+= f.select :tag_ids, Effective::Tag.all, tags: true, hint: 'Select existing tags or type and hit Enter to create a new tag'

data/config/effective_pages.rb

@@ -5,6 +5,8 @@ EffectivePages.setup do |config|
   config.carousel_items_table_name = :carousel_items
   config.alerts_table_name = :alerts
   config.permalinks_table_name = :permalinks
+  config.tags_table_name = :tags
+  config.taggings_table_name = :taggings
 
   # The menu names a page can belong to
   config.menus = [:main, :footer]

data/config/locales/effective_pages.en.yml

@@ -2,3 +2,7 @@ en:
   effective_pages:
     name: 'Effective Pages'
     acronym: 'Pages'
+
+  activerecord:
+    models:
+      effective/tagging: 'Tagged content'

data/config/routes.rb

@@ -9,6 +9,8 @@ EffectivePages::Engine.routes.draw do
     resources :carousel_items,  except: [:show]
     resources :alerts,          except: [:show]
     resources :permalinks,      except: [:show]
+    resources :tags,            except: [:show]
+    resources :taggings,        only:   [:index]
   end
 
   scope module: 'effective' do

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

@@ -90,6 +90,20 @@ class CreateEffectivePages < ActiveRecord::Migration[4.2]
       t.timestamps
     end
 
+    create_table <%= @tags_table_name %>, if_not_exists: true do |t|
+      t.string :name
+
+      t.timestamps
+    end
+
+    create_table <%= @taggings_table_name %>, if_not_exists: true do |t|
+      t.integer :tag_id
+      t.integer :taggable_id
+      t.string :taggable_type
+
+      t.timestamps
+    end
+
   end
 
   def self.down
@@ -99,6 +113,8 @@ class CreateEffectivePages < ActiveRecord::Migration[4.2]
     drop_table <%= @carousel_items_table_name %>
     drop_table <%= @alerts_table_name %>
     drop_table <%= @permalinks_table_name %>
+    drop_table <%= @tags_table_name %>
+    drop_table <%= @taggings_table_name %>
   end
 
 end

data/lib/effective_pages/engine.rb

@@ -2,6 +2,15 @@ module EffectivePages
   class Engine < ::Rails::Engine
     engine_name 'effective_pages'
 
+    # Include acts_as_tagged concern and allow any ActiveRecord object to call it
+    initializer 'effective_pages.active_record' do |app|
+      app.config.to_prepare do
+        ActiveSupport.on_load :active_record do
+          ActiveRecord::Base.extend(ActsAsTagged::Base)
+        end
+      end
+    end
+
     # Include Helpers to base application
     initializer 'effective_pages.action_controller' do |app|
       app.config.to_prepare do
@@ -13,6 +22,7 @@ module EffectivePages
           helper EffectiveMenusHelper
           helper EffectiveAlertsHelper
           helper EffectivePermalinksHelper
+          helper EffectiveTagsHelper
         end
       end
     end

data/lib/effective_pages/version.rb

@@ -1,3 +1,3 @@
 module EffectivePages
-  VERSION = '3.6.0'.freeze
+  VERSION = '3.7.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, :page_sections_table_name, :page_banners_table_name, :carousel_items_table_name, :alerts_table_name, :permalinks_table_name,
+      :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_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,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_pages
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.7.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-06 00:00:00.000000000 Z
+date: 2023-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -85,8 +85,12 @@ files:
 - app/controllers/admin/page_sections_controller.rb
 - app/controllers/admin/pages_controller.rb
 - app/controllers/admin/permalinks_controller.rb
+- app/controllers/admin/taggings_controller.rb
+- app/controllers/admin/tags_controller.rb
 - app/controllers/effective/pages_controller.rb
 - app/controllers/effective/permalinks_controller.rb
+- app/datatables/admin/effective_taggings_datatable.rb
+- app/datatables/admin/effective_tags_datatable.rb
 - app/datatables/effective_alerts_datatable.rb
 - app/datatables/effective_carousel_items_datatable.rb
 - app/datatables/effective_page_banners_datatable.rb
@@ -101,12 +105,16 @@ files:
 - app/helpers/effective_page_sections_helper.rb
 - app/helpers/effective_pages_helper.rb
 - app/helpers/effective_permalinks_helper.rb
+- app/helpers/effective_tags_helper.rb
+- app/models/concerns/acts_as_tagged.rb
 - app/models/effective/alert.rb
 - app/models/effective/carousel_item.rb
 - app/models/effective/page.rb
 - app/models/effective/page_banner.rb
 - app/models/effective/page_section.rb
 - app/models/effective/permalink.rb
+- app/models/effective/tag.rb
+- app/models/effective/tagging.rb
 - app/views/admin/alerts/_form.html.haml
 - app/views/admin/alerts/_form_alert.html.haml
 - app/views/admin/carousel_items/_form.html.haml
@@ -122,13 +130,19 @@ files:
 - app/views/admin/pages/_form_access.html.haml
 - app/views/admin/pages/_form_menu.html.haml
 - app/views/admin/pages/_form_page.html.haml
+- app/views/admin/pages/_form_tags.html.haml
 - app/views/admin/pages/_rich_text_areas.html.haml
 - app/views/admin/permalinks/_form.html.haml
 - app/views/admin/permalinks/_form_permalink.html.haml
+- app/views/admin/taggings/_form.html.haml
+- app/views/admin/taggings/_form_tagging.html.haml
+- 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/carousels/_carousel.html.haml
 - app/views/effective/pages/_menu.html.haml
 - app/views/effective/pages/_page_menu.html.haml
+- app/views/effective/tags/_fields.html.haml
 - app/views/layouts/_google_analytics.html.erb
 - config/effective_pages.rb
 - config/locales/effective_pages.en.yml