effective_posts 1.1.9 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3e1d79781f750dc9d0fc4c4e22a4842507f3e5e33779c6c0e22316fd3f5e750
-  data.tar.gz: 9365a6e511ef93c18abfc6b21ce09b158b74af42987954c035d9dfa812451aff
+  metadata.gz: d7fa99747e0baf6c175224b5d3ce645964ac5592137857a6cb28ae6d17687146
+  data.tar.gz: 277fa3f03c1411d810f0dc09663f4deb6bb2be2c1a890cbf7cc88bc9d6b0bd9e
 SHA512:
-  metadata.gz: 49086d49debe0b5d918389e7b88e273bfc7c68abd73a05aaffa59ea4bd1e05c4c25ecddfba97643426efc3ad6597a3f88fb7dbb19629cfa3db0205c4cd42a4d3
-  data.tar.gz: 94ad39c97d653ca020b9d39f98b27d199cfb1c8c95f131b6d2440b913dc14c6783bb38bc416c19cfa18ea59cedc798c34bb14dde2bb48c21e0306f79f97c5c7d
+  metadata.gz: efce23b1c3b45e66acbe5d5b055e114a7baa09add399a29a4a76074c2be854b46565deb2dfc3e9bd3f9559b6e6ec8c51a0fcb66f184c278f8edd8fed10578d18
+  data.tar.gz: 2422db33dc37d6d3f39b3b206c7ea77cf0238a3c9194b44c7b4335058e870e1082449027bab23b71e46177c36e62d697a704359e3fecf7891c7921eef2a000fa

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2018 Code and Effect Inc.
+Copyright 2021 Code and Effect Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -2,17 +2,17 @@
 
 A blog implementation with WYSIWYG content editing, post scheduling, pagination and optional top level routes for each post category.
 
-## effective_posts 1.0
+## effective_posts 2.0
 
-This is the 1.0 series of effective_posts.
+This is the 2.0 series of effective_posts.
 
-This requires Twitter Bootstrap 4 and Rails 5.1+
+This requires Twitter Bootstrap 4 and Rails 6+
 
 Please check out [Effective Posts 0.x](https://github.com/code-and-effect/effective_posts/tree/bootstrap3) for more information using this gem with Bootstrap 3.
 
 ## Getting Started
 
-Please first install the [effective_regions](https://github.com/code-and-effect/effective_regions) and [effective_datatables](https://github.com/code-and-effect/effective_datatables) gems.
+Please first install the [effective_datatables](https://github.com/code-and-effect/effective_datatables) gem.
 
 Please download and install [Twitter Bootstrap4](http://getbootstrap.com)
 
@@ -64,8 +64,6 @@ You can schedule a post to appear at a later date by setting the published_at va
 
 As well, if you're using the [effective_roles](https://github.com/code-and-effect/effective_roles) gem, you will be able to configure permissions so that only permitted users may view this post.
 
-Once you click `Save and Edit Content` you will be brought into the effective_regions editor where you may enter the content for your post.  Click `Insert Snippet` -> `Read more divider` from the toolbar to place a divider into your post.  Only the content above the Read more divider, the excerpt content, will be displayed on any posts#index screens.  The full content will be displayed on the posts#show screen.
-
 
 ## Category Routes
 
@@ -78,9 +76,6 @@ If disabled, all posts will be available at `/posts`, with posts for a specific
 
 Use `link_to_post_category(:blog)` to display a link to the Blog page.  The helper considers `config.use_category_routes` and puts in the correct url.
 
-Use `post_excerpt(post)` to display the excerpt for a post.  Or `post_excerpt(post, :length => 200)` to truncate it and add a Read more link where appropriate.
-
-
 ## Pagination
 
 The [effective_bootstrap](https://github.com/code-and-effect/effective_bootstrap) gem is used for pagination on all posts#index type screens.

data/app/controllers/admin/posts_controller.rb

@@ -1,136 +1,21 @@
 module Admin
   class PostsController < ApplicationController
-    before_action(:authenticate_user!) # Devise
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_posts) }
 
-    layout (EffectivePosts.layout.kind_of?(Hash) ? EffectivePosts.layout[:admin] : EffectivePosts.layout)
+    include Effective::CrudController
 
-    def index
-      @page_title = 'Posts'
-      @datatable = EffectivePostsDatatable.new(self)
-
-      authorize_effective_posts!
-    end
-
-    def new
-      @post = Effective::Post.new(published_at: Time.zone.now)
-      @page_title = 'New Post'
-
-      authorize_effective_posts!
-    end
-
-    def create
-      @post = Effective::Post.new(post_params)
-      @post.user = current_user if defined?(current_user)
-
-      @page_title = 'New Post'
-
-      authorize_effective_posts!
-
-      if @post.save
-        if params[:commit] == 'Save and Edit Content'
-          redirect_to effective_regions.edit_path(effective_posts.post_path(@post), :exit => effective_posts.edit_admin_post_path(@post))
-        elsif params[:commit] == 'Save and Add New'
-          flash[:success] = 'Successfully created post'
-          redirect_to effective_posts.new_admin_post_path
-        elsif params[:commit] == 'Save and View'
-          redirect_to effective_posts.post_path(@post)
-        else
-          flash[:success] = 'Successfully created post'
-          redirect_to effective_posts.edit_admin_post_path(@post)
-        end
-      else
-        flash.now[:danger] = 'Unable to create post'
-        render :action => :new
-      end
-    end
-
-    def edit
-      @post = Effective::Post.find(params[:id])
-      @page_title = 'Edit Post'
-
-      authorize_effective_posts!
-    end
-
-    def update
-      @post = Effective::Post.find(params[:id])
-      @page_title = 'Edit Post'
-
-      authorize_effective_posts!
-
-      if @post.update_attributes(post_params)
-        if params[:commit] == 'Save and Edit Content'
-          redirect_to effective_regions.edit_path(effective_posts.post_path(@post), :exit => effective_posts.edit_admin_post_path(@post))
-        elsif params[:commit] == 'Save and Add New'
-          flash[:success] = 'Successfully updated post'
-          redirect_to effective_posts.new_admin_post_path
-        elsif params[:commit] == 'Save and View'
-          redirect_to effective_posts.post_path(@post)
-        elsif params[:commit] == 'Duplicate'
-          begin
-            post = @post.duplicate!
-            flash[:success] = 'Successfully saved and duplicated post.'
-            flash[:info] = "You are now editing the duplicated post. This new post has been created as a Draft."
-          rescue => e
-            flash.delete(:success)
-            flash[:danger] = "Unable to duplicate post: #{e.message}"
-          end
-
-          redirect_to effective_posts.edit_admin_post_path(post || @post)
-        else
-          flash[:success] = 'Successfully updated post'
-          redirect_to effective_posts.edit_admin_post_path(@post)
-        end
-      else
-        flash.now[:danger] = 'Unable to update post'
-        render :action => :edit
-      end
-    end
-
-    def destroy
-      @post = Effective::Post.find(params[:id])
-
-      authorize_effective_posts!
-
-      if @post.destroy
-        flash[:success] = 'Successfully deleted post'
-      else
-        flash[:danger] = 'Unable to delete post'
-      end
-
-      redirect_to effective_posts.admin_posts_path
-    end
-
-    def approve
-      @post = Effective::Post.find(params[:id])
-      @page_title = 'Approve Post'
-
-      authorize_effective_posts!
-
-      if @post.update_attributes(draft: false)
-        flash[:success] = 'Successfully approved post.  It is now displayed on the website.'
-      else
-        flash[:danger] = "Unable to approve post: #{@post.errors.full_messages.join(', ')}"
-      end
-
-      redirect_to(:back) rescue redirect_to(effective_posts.admin_posts_path)
-    end
-
-    def excerpts
-      @posts = Effective::Post.includes(:regions)
-      @page_title = 'Post Excerpts'
-
-      authorize_effective_posts!
+    if (config = EffectivePosts.layout)
+      layout(config.kind_of?(Hash) ? config[:admin] : config)
     end
 
-    private
-
-    def authorize_effective_posts!
-      EffectivePosts.authorize!(self, :admin, :effective_posts)
-      EffectivePosts.authorize!(self, action_name.to_sym, @post || Effective::Post)
-    end
+    submit :save, 'Save'
+    submit :save, 'Save and Add New', redirect: :new
+    submit :save, 'Save and View', redirect: -> { effective_posts.post_path(resource) }
+    submit :save, 'Duplicate', redirect: -> { effective_posts.new_admin_post_path(duplicate_id: resource.id) }
 
     def post_params
-      params.require(:effective_post).permit(EffectivePosts.permitted_params)
+      params.require(:effective_post).permit!
     end
 
   end

data/app/controllers/effective/posts_controller.rb

@@ -1,15 +1,21 @@
 module Effective
   class PostsController < ApplicationController
-    layout (EffectivePosts.layout.kind_of?(Hash) ? EffectivePosts.layout[:posts] : EffectivePosts.layout)
+    if defined?(Devise)
+      before_action :authenticate_user!, only: [:new, :create, :edit, :update],
+        if: -> { EffectivePosts.submissions_require_current_user }
+    end
+
+    include Effective::CrudController
 
-    before_action :authenticate_user!, only: [:new, :create, :edit, :update],
-      if: -> { EffectivePosts.submissions_require_current_user }
+    if (config = EffectivePosts.layout)
+      layout(config.kind_of?(Hash) ? (config[:application] || config[:posts]) : config)
+    end
 
     def index
       @posts ||= Effective::Post.posts(
         user: current_user,
         category: params[:category],
-        unpublished: EffectivePosts.authorized?(self, :admin, :effective_posts)
+        unpublished: EffectiveResources.authorized?(self, :admin, :effective_posts)
       )
 
       @posts = @posts.paginate(page: params[:page])
@@ -23,28 +29,27 @@ module Effective
         @posts = @posts.where(search) if search.present?
       end
 
-      EffectivePosts.authorize!(self, :index, Effective::Post)
+      EffectiveResources.authorize!(self, :index, Effective::Post)
 
       @page_title ||= [(params[:category] || 'Blog').to_s.titleize, (" - Page #{params[:page]}" if params[:page])].compact.join
       @canonical_url ||= helpers.effective_post_category_url(params[:category], page: params[:page])
     end
 
     def show
-      @posts ||= Effective::Post.posts(user: current_user, category: params[:category], unpublished: EffectivePosts.authorized?(self, :admin, :effective_posts))
+      @posts ||= Effective::Post.posts(user: current_user, category: params[:category], unpublished: EffectiveResources.authorized?(self, :admin, :effective_posts))
       @post = @posts.find(params[:id])
 
       if @post.respond_to?(:roles_permit?)
         raise Effective::AccessDenied.new('Access Denied', :show, @post) unless @post.roles_permit?(current_user)
       end
 
-      EffectivePosts.authorize!(self, :show, @post)
+      EffectiveResources.authorize!(self, :show, @post)
 
-      if EffectivePosts.authorized?(self, :admin, :effective_posts)
+      if EffectiveResources.authorized?(self, :admin, :effective_posts)
         flash.now[:warning] = [
           'Hi Admin!',
           ('You are viewing a hidden post.' unless @post.published?),
           'Click here to',
-          ("<a href='#{effective_regions.edit_path(effective_posts.post_path(@post, exit: effective_posts.post_path(@post)))}' class='alert-link' data-no-turbolink='true' data-turbolinks='false'>edit post content</a> or" unless admin_edit?),
           ("<a href='#{effective_posts.edit_admin_post_path(@post)}' class='alert-link'>edit post settings</a>.")
         ].compact.join(' ')
       end
@@ -59,7 +64,7 @@ module Effective
       @post ||= Effective::Post.new(published_at: Time.zone.now)
       @page_title = 'New Post'
 
-      EffectivePosts.authorize!(self, :new, @post)
+      EffectiveResources.authorize!(self, :new, @post)
     end
 
     def create
@@ -67,7 +72,7 @@ module Effective
       @post.user = current_user if defined?(current_user)
       @post.draft = (EffectivePosts.submissions_require_approval == true)
 
-      EffectivePosts.authorize!(self, :create, @post)
+      EffectiveResources.authorize!(self, :create, @post)
 
       if @post.save
         @page_title ||= 'Post Submitted'
@@ -89,7 +94,7 @@ module Effective
       @post ||= Effective::Post.find(params[:id])
       @page_title ||= 'Edit Post'
 
-      EffectivePosts.authorize!(self, :edit, @post)
+      EffectiveResources.authorize!(self, :edit, @post)
     end
 
     def update
@@ -97,7 +102,7 @@ module Effective
       draft_was = @post.draft
       @post.draft = (EffectivePosts.submissions_require_approval == true)
 
-      EffectivePosts.authorize!(self, :update, @post)
+      EffectiveResources.authorize!(self, :update, @post)
 
       if @post.update_attributes(post_params)
         @page_title ||= 'Post Submitted'
@@ -118,7 +123,7 @@ module Effective
     def destroy
       @post ||= Effective::Post.find(params[:id])
 
-      EffectivePosts.authorize!(self, :destroy, @post)
+      EffectiveResources.authorize!(self, :destroy, @post)
 
       if @post.destroy
         flash[:success] = 'Successfully deleted post'
@@ -136,7 +141,7 @@ module Effective
     end
 
     def admin_edit?
-      EffectivePosts.authorized?(self, :admin, :effective_posts) && (params[:edit].to_s == 'true')
+      EffectiveResources.authorized?(self, :admin, :effective_posts) && (params[:edit].to_s == 'true')
     end
 
   end

data/app/datatables/effective_posts_datatable.rb

@@ -25,7 +25,9 @@ class EffectivePostsDatatable < Effective::Datatable
 
     col :created_at, label: 'Submitted at', visible: false
 
-    actions_col partial: '/admin/posts/actions', partial_as: :post
+    actions_col do |post|
+      dropdown_link_to('View', effective_post_path(post), target: '_blank')
+    end
   end
 
   collection do

data/app/helpers/effective_posts_helper.rb

@@ -3,7 +3,7 @@ require 'cgi'
 module EffectivePostsHelper
 
   def effective_posts_header_tags
-    return unless @post.present? && @post.kind_of?(Effective::Post)
+    return unless @post && @post.kind_of?(Effective::Post) && @post.persisted?
 
     @effective_pages_og_type = 'article'
 
@@ -31,14 +31,15 @@ module EffectivePostsHelper
   def effective_post_category_path(category, opts = nil)
     return effective_posts.posts_path(opts || {}) unless category.present?
 
-    category = category.to_s.downcase
+    category = category.to_s
+    category_path = category.to_s.downcase.parameterize
     opts = (opts || {}).compact
     query = ('?' + opts.to_query) if opts.present?
 
     if EffectivePosts.use_blog_routes
-      "/blog/category/#{category}#{query}"
+      "/blog/category/#{category_path}#{query}"
     elsif EffectivePosts.use_category_routes
-      "/#{category}#{query}"
+      "/#{category_path}#{query}"
     else
       effective_posts.posts_path(opts.merge(category: category.presence).compact)
     end
@@ -68,7 +69,7 @@ module EffectivePostsHelper
   end
 
   def admin_post_status_badge(post)
-    return nil unless EffectivePosts.authorized?(self, :admin, :effective_posts)
+    return nil unless EffectiveResources.authorized?(self, :admin, :effective_posts)
 
     if post.draft?
       content_tag(:span, 'DRAFT', class: 'badge badge-info')
@@ -77,29 +78,9 @@ module EffectivePostsHelper
     end
   end
 
-  # Only supported options are:
-  # :label => 'Read more' to set the label of the 'Read More' link
-  # :omission => '...' passed to the final text node's truncate
-  # :length => 200 to set the max inner_text length of the content
   # All other options are passed to the link_to 'Read more'
-  def post_excerpt(post, read_more_link: true, label: 'Continue reading', omission: '...', length: nil)
-    content = effective_region(post, :body, editable: false) { '<p>Default content</p>'.html_safe }
-    divider = content.index(Effective::Snippets::ReadMoreDivider::TOKEN)
-    excerpt = post.excerpt.to_s
-
-    read_more = (read_more_link && label.present?) ? readmore_link(post, label: label) : ''
-
-    html = (
-      if divider.present?
-        truncate_html(content, Effective::Snippets::ReadMoreDivider::TOKEN, '')
-      elsif length.present?
-        truncate_html(excerpt, length, omission)
-      else
-        excerpt
-      end
-    ).html_safe
-
-    (html + read_more).html_safe
+  def post_excerpt(post, label: 'Continue reading')
+    (post.excerpt.to_s + readmore_link(post, label: label)).html_safe
   end
 
   def read_more_link(post, options = {})

data/app/mailers/effective/posts_mailer.rb

@@ -10,7 +10,8 @@ module Effective
       mail(
         to: EffectivePosts.mailer[:admin_email],
         from: EffectivePosts.mailer[:default_from],
-        subject: subject_for_post_submitted_to_admin(@post)
+        subject: subject_for_post_submitted_to_admin(@post),
+        tenant: (Tenant.current if defined?(Tenant))
       )
     end
 

data/app/models/effective/post.rb

@@ -1,55 +1,63 @@
 module Effective
   class Post < ActiveRecord::Base
-    acts_as_regionable
+    attr_accessor :current_user
+
     acts_as_slugged
 
-    if EffectivePosts.use_effective_roles && respond_to?(:acts_as_role_restricted)
-      acts_as_role_restricted
-    end
+    log_changes if respond_to?(:log_changes)
+    acts_as_role_restricted if respond_to?(:acts_as_role_restricted)
 
-    if EffectivePosts.use_active_storage && respond_to?(:has_one_attached)
-      has_one_attached :image
-    end
+    has_one_attached :image
+
+    has_rich_text :excerpt
+    has_rich_text :body
 
     self.table_name = EffectivePosts.posts_table_name.to_s
 
-    belongs_to :user, optional: true
+    belongs_to :user, polymorphic: true, optional: true
 
-    # Attributes
-    # title             :string
-    # description       :string
+    effective_resource do
+      title             :string
+      description       :string
 
-    # slug              :string
+      category          :string
+      slug              :string
 
-    # category          :string
+      draft             :boolean
+      published_at      :datetime
+      tags              :text
 
-    # draft             :boolean
-    # published_at      :datetime
-    # tags              :text
+      roles_mask        :integer
 
-    # roles_mask        :integer
+      # Event Fields
+      start_at          :datetime
+      end_at            :datetime
 
-    # Event Fields
-    # start_at          :datetime
-    # end_at            :datetime
-    # location          :string
-    # website_name      :website_name
-    # website_href      :website_href
+      location          :string
+      website_name      :string
+      website_href      :string
 
-    # timestamps
+      timestamps
+    end
+
+    before_validation(if: -> { current_user.present? }) do
+      self.user ||= current_user
+    end
 
     validates :title, presence: true, length: { maximum: 255 }
     validates :description, presence: true, length: { maximum: 150 }
     validates :category, presence: true
     validates :published_at, presence: true
 
-    validates :start_at, presence: true, if: -> { category == 'events'}
+    validates :start_at, presence: true, if: -> { category == 'events' }
 
     scope :drafts, -> { where(draft: true) }
     scope :published, -> { where(draft: false).where("#{EffectivePosts.posts_table_name}.published_at < ?", Time.zone.now) }
     scope :unpublished, -> { where(draft: true).or(where("#{EffectivePosts.posts_table_name}.published_at > ?", Time.zone.now)) }
     scope :with_category, -> (category) { where(category: category.to_s.downcase) }
 
+    scope :deep, -> { with_rich_text_excerpt_and_embeds.with_rich_text_body_and_embeds }
+
     scope :paginate, -> (page: nil, per_page: EffectivePosts.per_page) {
       page = (page || 1).to_i
       offset = [(page - 1), 0].max * per_page
@@ -58,7 +66,7 @@ module Effective
     }
 
     scope :posts, -> (user: nil, category: nil, unpublished: false) {
-      scope = all.includes(:regions).order(published_at: :desc)
+      scope = all.deep.order(published_at: :desc)
 
       if defined?(EffectiveRoles) && EffectivePosts.use_effective_roles
         if user.present? && user.respond_to?(:roles)
@@ -77,16 +85,12 @@ module Effective
       scope
     }
 
-    def to_param
-      slug.presence || "#{id}-#{title.parameterize}"
-    end
-
     def to_s
       title.presence || 'New Post'
     end
 
     def published?
-      !draft? && published_at < Time.zone.now
+      !draft? && published_at.present? && published_at < Time.zone.now
     end
 
     def approved?
@@ -97,53 +101,34 @@ module Effective
       category == 'events'
     end
 
-    def body
-      region(:body).content
-    end
-
-    def body=(input)
-      region(:body).content = input
-    end
-
     # 3.333 words/second is the default reading speed.
     def time_to_read_in_seconds(reading_speed = 3.333)
       (regions.to_a.sum { |region| (region.content || '').scan(/\w+/).size } / reading_speed).seconds
     end
 
     def send_post_submitted_to_admin!
-      send_email(:post_submitted_to_admin, to_param)
+      deliver_method = EffectivePosts.mailer[:deliver_method] || raise('expected an EffectivePosts.deliver_method')
+      Effective::PostsMailer.post_submitted_to_admin(to_param).send(deliver_method)
     end
 
     # Returns a duplicated post object, or throws an exception
-    def duplicate!
+    def duplicate
       Post.new(attributes.except('id', 'updated_at', 'created_at')).tap do |post|
         post.title = post.title + ' (Copy)'
         post.slug = post.slug + '-copy'
         post.draft = true
 
-        regions.each do |region|
-          post.regions.build(region.attributes.except('id', 'updated_at', 'created_at'))
-        end
-
-        post.save!
+        post.body = body
+        post.excerpt = excerpt
       end
     end
 
-    private
+    def duplicate!
+      duplicate.tap { |post| post.save! }
+    end
 
-    def send_email(email, *mailer_args)
-      begin
-        if EffectivePosts.mailer[:delayed_job_deliver] && EffectivePosts.mailer[:deliver_method] == :deliver_later
-          Effective::PostsMailer.delay.public_send(email, *mailer_args)
-        elsif EffectivePosts.mailer[:deliver_method].present?
-          Effective::PostsMailer.public_send(email, *mailer_args).public_send(EffectivePosts.mailer[:deliver_method])
-        else
-          Effective::PostsMailer.public_send(email, *mailer_args).deliver_now
-        end
-      rescue => e
-        raise e unless Rails.env.production?
-        return false
-      end
+    def approve!
+      update!(draft: false)
     end
 
   end