decidim-feeds 1.0.0

data/app/controllers/decidim/feeds/admin/concerns/feed_admin.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Feeds
+    module Admin
+      module Concerns
+        # This concern is meant to be included in all controllers that are scoped
+        # into a feed's admin panel. It will override the layout so it shows
+        # the sidebar, preload the feed, etc.
+        module FeedAdmin
+          extend ActiveSupport::Concern
+
+          RegistersPermissions
+            .register_permissions(::Decidim::Feeds::Admin::Concerns::FeedAdmin,
+                                  Decidim::Feeds::Permissions,
+                                  Decidim::Admin::Permissions)
+
+          included do
+            include Decidim::Admin::ParticipatorySpaceAdminContext
+            helper_method :current_feed
+            add_breadcrumb_item_from_menu :admin_feed_menu
+
+            participatory_space_admin_layout
+
+            def current_feed
+              @current_feed ||= organization_feeds.find_by!(
+                slug: params[:feed_slug] || params[:slug]
+              )
+            end
+
+            alias_method :current_participatory_space, :current_feed
+
+            def organization_feeds
+              @organization_feeds ||= OrganizationFeeds.new(current_organization).query
+            end
+
+            def permissions_context
+              super.merge(current_participatory_space:)
+            end
+
+            def permission_class_chain
+              PermissionsRegistry.chain_for(FeedAdmin)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/feeds/admin/feeds_controller.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    module Admin
+      # Controller that allows managing feeds.
+      #
+      class FeedsController < Decidim::Feeds::Admin::ApplicationController
+        include Decidim::Admin::ParticipatorySpaceAdminBreadcrumb
+        helper_method :current_feed, :current_participatory_space
+        layout "decidim/admin/feeds"
+
+        def index
+          enforce_permission_to :read, :feed_list
+          @feeds = collection
+        end
+
+        def new
+          enforce_permission_to :create, :feed
+          @form = form(FeedForm).instance
+        end
+
+        def create
+          enforce_permission_to :create, :feed
+
+          params[:created_by] = current_user
+          @form = form(FeedForm).from_params(params)
+
+          CreateFeed.call(@form) do
+            on(:ok) do |feed|
+              flash[:notice] = I18n.t("feeds.create.success", scope: "decidim.admin")
+              redirect_to feeds_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("feeds.create.error", scope: "decidim.admin")
+              render :new
+            end
+          end
+        end
+
+        def edit
+          enforce_permission_to :update, :feed, feed: current_feed
+          @form = form(FeedForm).from_model(current_feed)
+          render layout: "decidim/admin/feed"
+        end
+
+        def update
+          enforce_permission_to :update, :feed, feed: current_feed
+          @form = form(FeedForm).from_params(
+            feed_params,
+            feed_id: current_feed.id
+          )
+
+          UpdateFeed.call(current_feed, @form) do
+            on(:ok) do |feed|
+              flash[:notice] = I18n.t("feeds.update.success", scope: "decidim.admin")
+              redirect_to edit_feed_path(feed)
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("feeds.update.error", scope: "decidim.admin")
+              render :edit, layout: "decidim/admin/feed"
+            end
+          end
+        end
+
+        def copy
+          enforce_permission_to :create, :feed
+        end
+
+        private
+
+        def collection
+          @collection ||= OrganizationFeeds.new(current_user.organization).query
+        end
+
+        def current_feed
+          @current_feed ||= collection.where(slug: params[:slug]).or(
+            collection.where(id: params[:slug])
+          ).first
+        end
+
+        alias current_participatory_space current_feed
+
+        def feed_params
+          { id: params[:slug] }.merge(params[:feed].to_unsafe_h)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    # The main admin application controller for feeds
+    class ApplicationController < Decidim::ApplicationController
+      helper Decidim::ApplicationHelper
+      helper Decidim::Feeds::FeedsHelper
+      include NeedsPermission
+
+      register_permissions(Decidim::Feeds::ApplicationController,
+                           ::Decidim::Feeds::Permissions,
+                           ::Decidim::Admin::Permissions,
+                           ::Decidim::Permissions)
+
+      private
+
+      def user_has_no_permission_path
+        decidim.new_user_session_path
+      end
+
+      def permissions_context
+        super.merge(
+          current_participatory_space: try(:current_participatory_space)
+        )
+      end
+
+      def permission_class_chain
+        ::Decidim.permissions_registry.chain_for(::Decidim::Feeds::ApplicationController)
+      end
+
+      def permission_scope
+        :public
+      end
+    end
+  end
+end

data/app/controllers/decidim/feeds/feeds_controller.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    # A controller that holds the logic to show Feeds in a public layout.
+    class FeedsController < Decidim::Feeds::ApplicationController
+      include ParticipatorySpaceContext
+      include FeedBreadcrumb
+      include FormFactory
+
+      participatory_space_layout only: :show
+
+      include FilterResource
+      include Paginable
+      include HasParticipatorySpaceContentBlocks
+
+      # helper_method :collection, :stats
+
+      def index
+        enforce_permission_to :list, :feed
+
+        @feeds = published_feeds.query
+      end
+
+      def show
+        enforce_permission_to :read, :feed, feed: current_participatory_space
+
+        @posts_component = current_feed.components.find_by(manifest_name: "posts")
+
+        if @posts_component.nil?
+          flash[:alert] = I18n.t("feeds.show.posts_component_not_found", scope: "decidim.feeds")
+          redirect_to feeds_path
+        end
+
+        # redirect_to decidim_feed_posts_path(current_participatory_space, posts_component) if posts_component
+      end
+
+      def new
+        enforce_permission_to :create, :feed
+
+        @form = form(FeedForm).instance
+      end
+
+      def create
+        enforce_permission_to :create, :feed
+
+        @form = form(FeedForm).from_params(params)
+
+        CreateFeed.call(@form) do
+          on(:ok) do |feed|
+            flash[:notice] = I18n.t("feeds.create.success", scope: "decidim.feeds")
+            redirect_to feeds_path
+          end
+
+          on(:invalid) do
+            flash.now[:alert] = I18n.t("feeds.create.error", scope: "decidim.feeds")
+            render :new
+          end
+        end
+      end
+
+      def edit
+        enforce_permission_to :update, :feed, feed: current_feed
+
+        @form = form(FeedForm).from_model(current_feed)
+      end
+
+      def update
+        enforce_permission_to :update, :feed, feed: current_feed
+
+        @form = form(FeedForm).from_params(
+          feed_params,
+          feed_id: current_feed.id
+        )
+
+        UpdateFeed.call(current_feed, @form) do
+          on(:ok) do |feed|
+            flash[:notice] = I18n.t("feeds.update.success", scope: "decidim.feeds")
+            redirect_to feed
+          end
+
+          on(:invalid) do
+            flash.now[:alert] = I18n.t("feeds.update.error", scope: "decidim.feeds")
+            render :edit
+          end
+        end
+      end
+
+      private
+
+      def collection
+        @collection ||= OrganizationFeeds.new(current_user.organization).query
+      end
+
+      def current_feed
+        @current_feed ||= collection.where(slug: params[:slug]).or(
+          collection.where(id: params[:slug])
+        ).first
+      end
+
+      def search_collection
+        Feed.where(organization: current_organization)
+      end
+
+      def default_filter_params
+        {
+          with_any_scope: nil,
+          with_any_area: nil,
+          with_any_type: nil
+        }
+      end
+
+      def current_participatory_space
+        return unless params[:slug]
+
+        @current_participatory_space ||= OrganizationFeeds.new(current_organization).query.where(slug: params[:slug]).or(
+          OrganizationFeeds.new(current_organization).query.where(id: params[:slug])
+        ).first!
+      end
+
+      def published_feeds
+        @published_feeds ||= OrganizationFeeds.new(current_organization)
+      end
+
+      # def collection
+      #   @collection ||= paginate(Kaminari.paginate_array(parent_feeds))
+      # end
+
+      def feed_params
+        # only allow title to be updated
+        title_params = current_organization.available_locales.map { |locale| "title_#{locale}" }
+        permitted_params = params.require(:feed).permit(title_params)
+        { id: params[:slug] }.merge(permitted_params)
+      end
+    end
+  end
+end

data/app/forms/decidim/feeds/admin/feed_form.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    module Admin
+      # A form object used to create feeds from the admin
+      # dashboard.
+      #
+      class FeedForm < Form
+        include TranslatableAttributes
+        include AttachmentAttributes
+
+        mimic :feed
+
+        translatable_attribute :title, String
+
+        attribute :created_by, String
+        attribute :slug, String
+        attribute :attachment, AttachmentForm
+        # attribute :participatory_processes_ids, Array[Integer]
+        # attribute :included_at, Decidim::Attributes::LocalizedDate
+
+        # attribute :banner_image
+        # attribute :hero_image
+        # attribute :remove_banner_image, Boolean, default: false
+        # attribute :remove_hero_image, Boolean, default: false
+
+        attachments_attribute :documents
+
+        validates :slug, presence: true, format: { with: Decidim::Feeds::Feed.slug_format }
+
+        validate :slug_uniqueness
+        # validate :same_type_organization, if: ->(form) { form.decidim_feeds_type_id }
+
+        validates :title, translatable_presence: true
+
+        # validates :banner_image, passthru: { to: Decidim::Feed }
+        # validates :hero_image, passthru: { to: Decidim::Feed }
+
+        # validates :weight, presence: true
+
+        alias organization current_organization
+
+        def map_model(model)
+          self.title = model.title # translated_attribute(model.title)
+          self.slug = model.slug
+          self.documents = model.attachments
+        end
+
+        # def created_by_for_select
+        #   CREATED_BY.map do |creator|
+        #     [
+        #       I18n.t("created_by.#{creator}", scope: "decidim.feeds"),
+        #       creator
+        #     ]
+        #   end
+        # end
+
+        # def processes_for_select
+        #   @processes_for_select ||= organization_participatory_processes
+        #                                 &.map { |pp| [translated_attribute(pp.title), pp.id] }
+        #                                 &.sort_by { |arr| arr[0] }
+        # end
+
+        def has_attachments?
+          feed.has_attachments? && errors[:documents].empty? && documents.present?
+        end
+  
+        def has_error_in_attachments?
+          errors[:documents].present?
+        end
+
+        private
+
+        # def organization_participatory_processes
+        #   Decidim.find_participatory_space_manifest(:participatory_processes)
+        #          .participatory_spaces.call(current_organization)
+        # end
+
+        def organization_feeds
+          OrganizationFeeds.new(current_organization).query
+        end
+
+        def slug_uniqueness
+          return unless organization_feeds
+                        .where(slug:)
+                        .where.not(id: context[:feed_id])
+                        .any?
+
+          errors.add(:slug, :taken)
+        end
+
+        # def same_type_organization
+        #   return unless feed_type
+        #   return if feed_type.organization == current_organization
+
+        #   errors.add(:feed_type, :invalid)
+        # end
+      end
+    end
+  end
+end

data/app/forms/decidim/feeds/feed_form.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    # A form object used to create feeds from the admin
+    # dashboard.
+    #
+    class FeedForm < Form
+      include TranslatableAttributes
+
+      mimic :feed
+
+      translatable_attribute :title, String
+
+      attribute :created_by, String
+      
+      # attribute :participatory_processes_ids, Array[Integer]
+      # attribute :included_at, Decidim::Attributes::LocalizedDate
+
+      # attribute :banner_image
+      # attribute :hero_image
+      # attribute :remove_banner_image, Boolean, default: false
+      # attribute :remove_hero_image, Boolean, default: false
+
+      # validate :same_type_organization, if: ->(form) { form.decidim_feeds_type_id }
+
+      validates :title, translatable_presence: true
+
+      # validates :banner_image, passthru: { to: Decidim::Feed }
+      # validates :hero_image, passthru: { to: Decidim::Feed }
+
+      # validates :weight, presence: true
+
+      alias organization current_organization
+
+      # def created_by_for_select
+      #   CREATED_BY.map do |creator|
+      #     [
+      #       I18n.t("created_by.#{creator}", scope: "decidim.feeds"),
+      #       creator
+      #     ]
+      #   end
+      # end
+
+      # def processes_for_select
+      #   @processes_for_select ||= organization_participatory_processes
+      #                                 &.map { |pp| [translated_attribute(pp.title), pp.id] }
+      #                                 &.sort_by { |arr| arr[0] }
+      # end
+
+      private
+
+      # def organization_participatory_processes
+      #   Decidim.find_participatory_space_manifest(:participatory_processes)
+      #          .participatory_spaces.call(current_organization)
+      # end
+
+      def organization_feeds
+        OrganizationFeeds.new(current_organization).query
+      end
+
+      # def same_type_organization
+      #   return unless feed_type
+      #   return if feed_type.organization == current_organization
+
+      #   errors.add(:feed_type, :invalid)
+      # end
+    end
+  end
+end

data/app/helpers/decidim/feeds/admin/feeds_admin_menu_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    module Admin
+      module FeedsAdminMenuHelper
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    # Custom helpers, scoped to the feeds engine.
+    #
+    module ApplicationHelper
+      include PaginateHelper
+      include SanitizeHelper
+      # include Decidim::Feeds::PostsHelper
+      include ::Decidim::EndorsableHelper
+      include ::Decidim::FollowableHelper
+      include Decidim::Comments::CommentsHelper
+    end
+  end
+end

data/app/helpers/decidim/feeds/feeds_helper.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    # Helpers related to the Feeds layout.
+    module FeedsHelper
+      include Decidim::ResourceHelper
+      # include Decidim::AttachmentsHelper
+      include Decidim::IconHelper
+      include Decidim::SanitizeHelper
+      include Decidim::ResourceReferenceHelper
+      # include Decidim::FiltersHelper
+      # include FilterFeedsHelper
+
+      # Items to display in the navigation of an feed
+      def feed_nav_items(participatory_space)
+        components = participatory_space.components.published.or(Decidim::Component.where(id: try(:current_component)))
+
+        [
+          *(if participatory_space.members.not_ceased.any?
+              [{
+                name: t("feed_member_menu_item", scope: "layouts.decidim.feed_navigation"),
+                url: decidim_feeds.feed_feed_members_path(participatory_space),
+                active: is_active_link?(decidim_feeds.feed_feed_members_path(participatory_space), :inclusive)
+              }]
+            end
+           )
+        ] + components.map do |component|
+          {
+            name: decidim_escape_translated(component.name),
+            url: main_component_path(component),
+            active: is_active_link?(main_component_path(component), :inclusive)
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    # 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/feeds/feed.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    class Feed < ApplicationRecord
+      include Decidim::Participable
+      include Decidim::ParticipatorySpaceResourceable
+      include Decidim::TranslatableResource
+      include Decidim::Loggable
+      include Decidim::Traceable
+      include Decidim::Searchable
+      include Decidim::HasAttachments
+      # include Decidim::HasAttachmentCollections
+      # include Decidim::Publicable
+      # include Decidim::ScopableParticipatorySpace
+      # include Decidim::Followable
+      # include Decidim::HasReference
+      # include Decidim::HasPrivateUsers
+      # include Decidim::HasUploadValidations
+      # include Decidim::FilterableResource
+
+      translatable_fields :title
+
+      belongs_to :organization,
+                foreign_key: "decidim_organization_id",
+                class_name: "Decidim::Organization"
+
+      has_many :components, as: :participatory_space, dependent: :destroy
+      has_many :categories,
+             foreign_key: "decidim_participatory_space_id",
+             foreign_type: "decidim_participatory_space_type",
+             dependent: :destroy,
+             as: :participatory_space
+
+      # has_one_attached :hero_image
+      # validates_upload :hero_image, uploader: Decidim::HeroImageUploader
+
+      # has_one_attached :banner_image
+      # validates_upload :banner_image, uploader: Decidim::BannerImageUploader
+
+      validates :slug, uniqueness: { scope: :organization }
+      validates :slug, presence: true, format: { with: Decidim::Feeds::Feed.slug_format }
+
+      searchable_fields({
+                          # scope_id: :decidim_scope_id,
+                          participatory_space: :itself,
+                          A: :title,
+                          # B: :subtitle,
+                          # C: :short_description,
+                          # D: :description,
+                          datetime: :created_at
+                        },
+                        index_on_create: true,
+                        index_on_update: true
+      )
+
+      # Overwriting existing method Decidim::HasPrivateUsers.public_spaces
+      # def self.public_spaces
+      #   where(private_space: false).or(where(private_space: true).where(is_transparent: true)).published
+      # end
+
+      def self.log_presenter_class_for(_log)
+        Decidim::Feeds::AdminLog::FeedPresenter
+      end
+
+      # This is required by participable, but Feed is not publicable
+      def self.published
+        all
+      end
+
+      # def hashtag
+      #   attributes["hashtag"].to_s.delete("#")
+      # end
+
+      def to_param
+        slug
+      end
+
+      def translated_title
+        Decidim::FeedPresenter.new(self).translated_title
+      end
+
+      def scopes_enabled?
+        false
+      end
+
+      def scope
+        nil
+      end
+
+      def followers
+        Decidim::User.none
+      end
+
+      def private_space?
+        false
+      end
+
+      def has_subscopes?
+        false
+      end
+
+      def published?
+        true
+      end
+
+      # private
+
+      # Allow ransacker to search for a key in a hstore column (`title`.`en`)
+      # ransacker_i18n :title # requires filterable
+    end
+  end
+end

data/app/packs/entrypoints/decidim_feeds.js

@@ -0,0 +1,5 @@
+import 'src/decidim/feeds/feeds.js';
+
+require.context('../images', true);
+
+import 'entrypoints/decidim_feeds.scss';

data/app/packs/entrypoints/decidim_feeds.scss

@@ -0,0 +1 @@
+@import 'stylesheets/decidim/feeds/feeds';

data/app/packs/images/decidim/feeds/decidim_feeds.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 35 35"><path d="M17.5 35A17.5 17.5 0 1 1 35 17.5 17.52 17.52 0 0 1 17.5 35zm0-33.06A15.56 15.56 0 1 0 33.06 17.5 15.57 15.57 0 0 0 17.5 1.94zm9.5 13.7H8a1 1 0 0 1 0-1.94h19a1 1 0 0 1 0 1.94zm0 3.68H8a1 1 0 0 1 0-1.94h19a1 1 0 0 1 0 1.94zM22.26 23H8a1 1 0 0 1 0-1.94h14.26a1 1 0 0 1 0 1.94z"/></svg>

data/app/packs/images/decidim/feeds/icon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 35 35"><path d="M17.5 35A17.5 17.5 0 1 1 35 17.5 17.52 17.52 0 0 1 17.5 35zm0-33.06A15.56 15.56 0 1 0 33.06 17.5 15.57 15.57 0 0 0 17.5 1.94zm9.5 13.7H8a1 1 0 0 1 0-1.94h19a1 1 0 0 1 0 1.94zm0 3.68H8a1 1 0 0 1 0-1.94h19a1 1 0 0 1 0 1.94zM22.26 23H8a1 1 0 0 1 0-1.94h14.26a1 1 0 0 1 0 1.94z"/></svg>