decidim-blogs 0.11.0.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 77d681860119dee520f12322bc3f82962b485e3710348cf0f95d3c2a3ac8fa2e
+  data.tar.gz: b48ac462f570f74867ff27af60100619bac5a9324654ac916696e8266fd90f43
+SHA512:
+  metadata.gz: 46b48ee482df01acd8c07a2e24dd98efd75a5550eee2a33d96bf4d3ffae82718f269c5fdcb3f1bf01b5d7e7bc0b46fbdf3e4f502904bf2d7fd0407962b21fce8
+  data.tar.gz: 401e1475f4107a3b265ea7f3bbf1e72ec2dc6188ce213da3f229f8bea989eec290708ce3008fa5d6aaf1c1022381634b09edef1c16e1e81c78d44958f7ccd6cb

data/README.md

@@ -0,0 +1,30 @@
+# decidim-blogs
+
+The BLOG module adds posts to any participatory process. It adds a CRUD engine
+to the admin and public view scoped inside the participatory process.
+
+## Usage
+
+BLOG will be available as a Component for a Participatory Process.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'decidim-blogs'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+## Contributing
+
+See [Decidim](https://github.com/decidim/decidim).
+
+## License
+
+See [Decidim](https://github.com/decidim/decidim).

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "decidim/dev/common_rake"

data/app/assets/images/decidim/blogs/icon.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 36 36">
+  <path d="M18 0C8.07 0 0 8.07 0 18s8.07 18 18 18 18-8.071 18-18S27.93 0 18 0zm0 2c8.85 0 16 7.152 16 16 0 8.848-7.15 16-16 16-8.848 0-16-7.152-16-16C2 9.152 9.152 2 18 2zm-7 9a1 1 0 1 0 0 2h14a1 1 0 1 0 0-2H11zm0 4a1 1 0 1 0 0 2h10a1 1 0 1 0 0-2H11zm0 4a1 1 0 1 0 0 2h14a1 1 0 1 0 0-2H11zm0 4a1 1 0 1 0 0 2h10a1 1 0 1 0 0-2H11z"/>
+</svg>

data/app/commands/decidim/blogs/admin/create_post.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Blogs
+    module Admin
+      # This command is executed when the user creates a Post from the admin
+      # panel.
+      class CreatePost < Rectify::Command
+        def initialize(form, current_user)
+          @form = form
+          @current_user = current_user
+        end
+
+        # Creates the post if valid.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          return broadcast(:invalid) if @form.invalid?
+
+          transaction do
+            create_post!
+            send_notification
+          end
+
+          broadcast(:ok, @post)
+        end
+
+        private
+
+        def create_post!
+          @post = Post.create!(
+            title: @form.title,
+            body: @form.body,
+            component: @form.current_component,
+            decidim_author_id: @current_user.id
+          )
+        end
+
+        def send_notification
+          Decidim::EventsManager.publish(
+            event: "decidim.events.blogs.post_created",
+            event_class: Decidim::Blogs::CreatePostEvent,
+            resource: @post,
+            recipient_ids: @post.participatory_space.followers.pluck(:id)
+          )
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/blogs/admin/update_post.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Blogs
+    module Admin
+      # This command is executed when the user changes a Blog from the admin
+      # panel.
+      class UpdatePost < Rectify::Command
+        # Initializes a UpdateBlog Command.
+        #
+        # form - The form from which to get the data.
+        # blog - The current instance of the page to be updated.
+        def initialize(form, post)
+          @form = form
+          @post = post
+        end
+
+        # Updates the blog if valid.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          transaction do
+            update_post!
+          end
+
+          broadcast(:ok, post)
+        end
+
+        private
+
+        attr_reader :form, :post
+
+        def update_post!
+          post.update!(
+            title: form.title,
+            body: form.body
+          )
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/blogs/admin/application_controller.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Blogs
+    module Admin
+      # Base controller for the administration of this module. It inherits from
+      # Decidim's admin base controller in order to inherit the layout and other
+      # convenience methods relevant to a this component.
+      class ApplicationController < Decidim::Admin::Components::BaseController
+        helper_method :posts, :post
+
+        def posts
+          @posts ||= Post.where(component: current_component).page(params[:page]).per(15)
+        end
+
+        def post
+          @post ||= posts.find(params[:id])
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/blogs/admin/posts_controller.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Blogs
+    module Admin
+      # This controller allows the create or update a blog.
+      class PostsController < Admin::ApplicationController
+        def new
+          @form = form(PostForm).instance
+        end
+
+        def create
+          @form = form(PostForm).from_params(params, current_component: current_component)
+
+          CreatePost.call(@form, current_user) do
+            on(:ok) do
+              flash[:notice] = I18n.t("posts.create.success", scope: "decidim.blogs.admin")
+              redirect_to posts_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("posts.create.invalid", scope: "decidim.blogs.admin")
+              render action: "new"
+            end
+          end
+        end
+
+        def edit
+          @form = form(PostForm).from_model(post)
+        end
+
+        def update
+          @form = form(PostForm).from_params(params, current_component: current_component)
+
+          UpdatePost.call(@form, post) do
+            on(:ok) do
+              flash[:notice] = I18n.t("posts.update.success", scope: "decidim.blogs.admin")
+              redirect_to posts_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("posts.update.invalid", scope: "decidim.blogs.admin")
+              render action: "edit"
+            end
+          end
+        end
+
+        def destroy
+          post.destroy!
+
+          flash[:notice] = I18n.t("posts.destroy.success", scope: "decidim.blogs.admin")
+
+          redirect_to posts_path
+        end
+
+        private
+
+        def post
+          @post ||= Blogs::Post.find_by(component: current_component)
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/blogs/application_controller.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Blogs
+    # This controller is the abstract class from which all other controllers of
+    # this engine inherit.
+    #
+    # Note that it inherits from `Decidim::Components::Basecontroller`, which
+    # override its layout and provide all kinds of useful methods.
+    class ApplicationController < Decidim::Components::BaseController
+      helper Decidim::Blogs::ApplicationHelper
+    end
+  end
+end

data/app/controllers/decidim/blogs/posts_controller.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Blogs
+    # Exposes the blog resource so users can view them
+    class PostsController < Decidim::Blogs::ApplicationController
+      helper_method :posts, :post, :paginate_posts, :posts_most_commented
+
+      def index; end
+
+      def show; end
+
+      private
+
+      def paginate_posts
+        @paginate_posts ||= posts.created_at_desc.page(params[:page]).per(4)
+      end
+
+      def post
+        @post ||= posts.find(params[:id])
+      end
+
+      def posts
+        @posts ||= Post.where(component: current_component)
+      end
+
+      # PROVISIONAL if we implement counter cache
+      def posts_most_commented
+        @posts_most_commented ||= posts.joins(:comments).group(:id)
+                                       .select("count(decidim_comments_comments.id) as counter")
+                                       .select("decidim_blogs_posts.*").order("counter DESC").created_at_desc.limit(7)
+      end
+    end
+  end
+end

data/app/events/decidim/blogs/create_post_event.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Blogs
+    class CreatePostEvent < Decidim::Events::SimpleEvent
+    end
+  end
+end

data/app/forms/decidim/blogs/admin/post_form.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Blogs
+    module Admin
+      # This class holds a Form to update pages from Decidim's admin panel.
+      class PostForm < Decidim::Form
+        include TranslatableAttributes
+
+        translatable_attribute :title, String
+        translatable_attribute :body, String
+
+        validates :title, translatable_presence: true
+        validates :body, translatable_presence: true
+      end
+    end
+  end
+end

data/app/helpers/decidim/blogs/admin/posts_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Blogs
+    module Admin
+      # Custom helpers used in posts views
+      module PostsHelper
+        include Decidim::ApplicationHelper
+        # include Decidim::TranslationsHelper
+        # include Decidim::ResourceHelper
+
+        # Public: truncates the post body
+        #
+        # post - a Decidim::Blog instance
+        # max_length - a number to limit the length of the body
+        #
+        # Returns the post's body truncated.
+        def post_description_admin(post, max_length = 100)
+          body = translated_attribute(post.body)
+          CGI.unescapeHTML html_truncate(body, max_length: max_length)
+        end
+      end
+    end
+  end
+end

data/app/helpers/decidim/blogs/application_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Blogs
+    # Custom helpers, scoped to the blogs engine.
+    #
+    module ApplicationHelper
+      include PaginateHelper
+      include Decidim::Blogs::PostsHelper
+      include Decidim::Comments::CommentsHelper
+    end
+  end
+end

data/app/helpers/decidim/blogs/posts_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Blogs
+    # Custom helpers used in posts views
+    module PostsHelper
+      include Decidim::ApplicationHelper
+      include Decidim::TranslationsHelper
+      include Decidim::ResourceHelper
+
+      # Public: truncates the post body
+      #
+      # post - a Decidim::Blog instance
+      # max_length - a number to limit the length of the body
+      #
+      # Returns the post's body truncated.
+      def post_description(post, max_length = 600)
+        link = post_path(post)
+        body = translated_attribute(post.body)
+        tail = "... <br/> #{link_to(t("read_more", scope: "decidim.blogs"), link)}".html_safe
+        CGI.unescapeHTML html_truncate(body, max_length: max_length, tail: tail)
+      end
+    end
+  end
+end

data/app/models/decidim/blogs/application_record.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Blogs
+    # Abstract class from which all models in this engine inherit.
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/models/decidim/blogs/post.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Blogs
+    # The data store for a Blog in the Decidim::Blogs component. It stores a
+    # title, description and any other useful information to render a blog.
+    class Post < Blogs::ApplicationRecord
+      include Decidim::Resourceable
+      include Decidim::HasComponent
+      include Decidim::Authorable
+      include Decidim::Comments::Commentable
+
+      component_manifest_name "blogs"
+
+      validates :title, presence: true
+
+      scope :created_at_desc, -> { order(arel_table[:created_at].desc) }
+
+      # Public: Overrides the `commentable?` Commentable concern method.
+      def commentable?
+        component.settings.comments_enabled?
+      end
+
+      # Public: Overrides the `accepts_new_comments?` Commentable concern method.
+      def accepts_new_comments?
+        commentable? && !component.current_settings.comments_blocked
+      end
+
+      # Public: Overrides the `comments_have_alignment?` Commentable concern method.
+      def comments_have_alignment?
+        true
+      end
+
+      # Public: Overrides the `comments_have_votes?` Commentable concern method.
+      def comments_have_votes?
+        true
+      end
+
+      def official?
+        author.nil?
+      end
+    end
+  end
+end