decidim-feeds 1.0.0

data/README.md

@@ -0,0 +1,39 @@
+# Decidim::Feeds participatory space (under development)
+
+This Feeds module adds a simple Feeds Participatory Space to hold a feed component.
+
+**The module is currently in development and not yet ready.**
+
+## Usage
+
+Feeds will be available as a Participatory Space.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "decidim-feeds", git: "https://github.com/DecidimAustria/decidim-module-feeds.git", branch: "main"
+```
+
+And then execute:
+
+```bash
+bundle
+bundle exec rails decidim_feeds:install:migrations
+bundle exec rails db:migrate
+```
+
+## Contributing
+
+Contributions are welcome !
+
+We expect the contributions to follow the [Decidim's contribution guide](https://github.com/decidim/decidim/blob/develop/CONTRIBUTING.adoc).
+
+## Security
+
+Security is very important to us. If you have any issue regarding security, please disclose the information responsibly by sending an email to __security [at] mitgestalten [dot] jetzt__ and not by creating a Github issue.
+
+## License
+
+This engine is distributed under the GNU AFFERO GENERAL PUBLIC LICENSE.

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "decidim/dev/common_rake"
+
+desc "Generates a dummy app for testing"
+task test_app: "decidim:generate_external_test_app"
+
+desc "Generates a development app."
+task development_app: "decidim:generate_external_development_app"

data/app/cells/decidim/feeds/content_blocks/feeds_settings_form/show.erb

@@ -0,0 +1,3 @@
+<% form.fields_for :settings, form.object.settings do |settings_fields| %>
+  <%= settings_fields.select :component_id, available_feeds_options, prompt: "", label: t(".component") %>
+<% end %>

data/app/cells/decidim/feeds/content_blocks/feeds_settings_form_cell.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    module ContentBlocks
+      class FeedsSettingsFormCell < Decidim::ViewModel
+        # Found in HighlightedElementsForComponentSettingsFormCell
+        #include Decidim::ContentBlocks::HasRelatedComponents
+        alias form model
+
+        def available_feeds_options
+          available_feeds.map do |component|
+            [translated_attribute(component.name), component.id]
+          end
+        end
+
+        def available_feeds
+          @available_feeds ||= Decidim::Component.where(manifest_name: "posts").where(participatory_space_id: current_organization.participatory_spaces.pluck(:id))
+        end
+      end
+    end
+  end
+end

data/app/cells/decidim/feeds/feed_cell.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    # This cell renders the process card for an instance of a Feed
+    # the default size is the Medium Card (:m)
+    class FeedCell < Decidim::ViewModel
+      def show
+        cell card_size, model, options
+      end
+
+      private
+
+      def card_size
+        case @options[:size]
+        when :s
+          "decidim/feeds/feed_s"
+        else
+          "decidim/feeds/feed_g"
+        end
+      end
+    end
+  end
+end

data/app/cells/decidim/feeds/feed_dropdown_metadata_cell.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    class FeedDropdownMetadataCell < Decidim::ParticipatorySpaceDropdownMetadataCell
+      # include FeedsHelper
+      include Decidim::ComponentPathHelper
+      include ActiveLinkTo
+
+      def decidim_feeds
+        Decidim::Feeds::Engine.routes.url_helpers
+      end
+
+      private
+
+      def nav_items_method = :feed_nav_items
+    end
+  end
+end

data/app/cells/decidim/feeds/feed_g_cell.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    # This cell renders the Grid (:g) feed card
+    # for a given instance of a feed
+    class FeedGCell < Decidim::CardGCell
+      private
+
+      def resource_path
+        Decidim::Feeds::Engine.routes.url_helpers.feed_path(model)
+      end
+
+      def has_image?
+        # image.present?
+        false
+      end
+
+      def image
+        # @image ||= model.attachments.find(&:image?)
+        nil
+      end
+
+      def resource_image_path
+        image.url if has_image?
+      end
+
+      def metadata_cell
+        "decidim/feeds/feed_metadata_g"
+      end
+    end
+  end
+end

data/app/cells/decidim/feeds/feed_metadata_g_cell.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    # This cell renders the feed metadata for g card
+    class FeedMetadataGCell < Decidim::CardMetadataCell
+      include Cell::ViewModel::Partial
+
+      alias current_feed resource
+      alias feed resource
+
+      def initialize(*)
+        super
+
+        @items.prepend(*feed_items)
+      end
+
+      private
+
+      def feed_items
+        []
+      end
+    end
+  end
+end

data/app/cells/decidim/feeds/feed_s_cell.rb

@@ -0,0 +1,13 @@
+module Decidim
+  module Feeds
+    # This cell renders the Search (:s) feed card
+    # for a given instance of a feed
+    class FeedSCell < Decidim::CardSCell
+      private
+
+      def metadata_cell
+        "decidim/feeds/feed_metadata_g"
+      end
+    end
+  end
+end

data/app/commands/decidim/feeds/admin/create_feed.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    module Admin
+      # A command with all the business logic when creating a new participatory
+      # feed in the system.
+      class CreateFeed < Decidim::Command
+        include ::Decidim::MultipleAttachmentsMethods
+
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        def initialize(form)
+          @form = form
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form was not valid and we could not proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          if process_attachments?
+            build_attachments
+            return broadcast(:invalid) if attachments_invalid?
+          end
+
+          if feed.persisted?
+            # link_participatory_processes(feed)
+            # Decidim::ContentBlocksCreator.new(feed).create_default!
+
+            broadcast(:ok, feed)
+          else
+            # form.errors.add(:hero_image, feed.errors[:hero_image]) if feed.errors.include? :hero_image
+            # form.errors.add(:banner_image, feed.errors[:banner_image]) if feed.errors.include? :banner_image
+            broadcast(:invalid)
+          end
+        end
+
+        private
+
+        attr_reader :form
+
+        def feed
+          @feed ||= Decidim.traceability.create(
+            Feed,
+            form.current_user,
+            organization: form.current_organization,
+            title: form.title,
+            slug: form.slug,
+            created_by: form.created_by
+          )
+          @attached_to = @feed
+          @feed
+        end
+
+        # def add_admins_as_followers(feed)
+        #   feed.organization.admins.each do |admin|
+        #     form = Decidim::FollowForm
+        #            .from_params(followable_gid: feed.to_signed_global_id.to_s)
+        #            .with_context(
+        #              current_organization: feed.organization,
+        #              current_user: admin
+        #            )
+
+        #     Decidim::CreateFollow.new(form, admin).call
+        #   end
+        # end
+
+        # def participatory_processes(feed)
+        #   @participatory_processes ||= feed.participatory_space_sibling_scope(:participatory_processes).where(id: @form.participatory_processes_ids)
+        # end
+
+        # def link_participatory_processes(feed)
+        #   feed.link_participatory_space_resources(participatory_processes(feed), "included_participatory_processes")
+        # end
+
+        def first_attachment_weight
+          return 1 if feed.documents.count.zero?
+
+          feed.documents.count
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/feeds/admin/update_feed.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    module Admin
+      # A command with all the business logic when creating a new participatory
+      # feed in the system.
+      class UpdateFeed < Decidim::Command
+        include ::Decidim::MultipleAttachmentsMethods
+
+        # Public: Initializes the command.
+        #
+        # feed - the Feed to update
+        # form - A form object with the params.
+        def initialize(feed, form)
+          @feed = feed
+          @form = form
+          @attached_to = feed
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form was not valid and we could not proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          if process_attachments?
+            build_attachments
+            return broadcast(:invalid) if attachments_invalid?
+          end
+
+          update_feed
+          # link_participatory_processes(@feed)
+          document_cleanup!(include_all_attachments: true)
+          create_attachments if process_attachments?
+
+          if @feed.valid?
+            broadcast(:ok, @feed)
+          else
+            # form.errors.add(:hero_image, @feed.errors[:hero_image]) if @feed.errors.include? :hero_image
+            # form.errors.add(:banner_image, @feed.errors[:banner_image]) if @feed.errors.include? :banner_image
+            broadcast(:invalid)
+          end
+        end
+
+        private
+
+        attr_reader :form, :feed
+
+        def update_feed
+          @feed.assign_attributes(attributes)
+          save_feed if @feed.valid?
+        end
+
+        def save_feed
+          transaction do
+            @feed.save!
+            Decidim.traceability.perform_action!(:update, @feed, form.current_user) do
+              @feed
+            end
+          end
+        end
+
+        def attributes
+          {
+            title: form.title,
+            slug: form.slug,
+            created_by: form.created_by
+          }
+        end
+
+        # def participatory_processes(feed)
+        #   @participatory_processes ||= feed.participatory_space_sibling_scope(:participatory_processes).where(id: @form.participatory_processes_ids)
+        # end
+
+        # def link_participatory_processes(feed)
+        #   feed.link_participatory_space_resources(participatory_processes(feed), "included_participatory_processes")
+        # end
+      end
+    end
+  end
+end

data/app/commands/decidim/feeds/create_feed.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    # A command with all the business logic when creating a new participatory
+    # feed in the system.
+    class CreateFeed < Decidim::Command
+      # Public: Initializes the command.
+      #
+      # form - A form object with the params.
+      def initialize(form)
+        @form = form
+        @author = author
+      end
+
+      # Executes the command. Broadcasts these events:
+      #
+      # - :ok when everything is valid.
+      # - :invalid if the form was not valid and we could not proceed.
+      #
+      # Returns nothing.
+      def call
+        return broadcast(:invalid) if form.invalid?
+
+        if feed.persisted?
+          # link_participatory_processes(feed)
+          # Decidim::ContentBlocksCreator.new(feed).create_default!
+          if create_posts_component
+            broadcast(:ok, feed)
+          else
+            broadcast(:invalid)
+          end
+
+        else
+          # form.errors.add(:hero_image, feed.errors[:hero_image]) if feed.errors.include? :hero_image
+          # form.errors.add(:banner_image, feed.errors[:banner_image]) if feed.errors.include? :banner_image
+          broadcast(:invalid)
+        end
+      end
+
+      private
+
+      attr_reader :form, :author
+
+      def feed
+        @feed ||= Decidim.traceability.create(
+          Feed,
+          form.current_user,
+          organization: form.current_organization,
+          title: { I18n.locale => form.title },
+          slug: form.title.parameterize,
+          created_by: form.current_user
+        )
+      end
+
+      def create_posts_component
+        Decidim.traceability.create!(
+          Component,
+          form.current_user,
+          manifest_name: "posts",
+          name: { I18n.locale => "Posts" },
+          participatory_space: feed,
+          weight: 0,
+          settings: {}
+        )
+      end
+
+      # def add_admins_as_followers(feed)
+      #   feed.organization.admins.each do |admin|
+      #     form = Decidim::FollowForm
+      #            .from_params(followable_gid: feed.to_signed_global_id.to_s)
+      #            .with_context(
+      #              current_organization: feed.organization,
+      #              current_user: admin
+      #            )
+
+      #     Decidim::CreateFollow.new(form, admin).call
+      #   end
+      # end
+
+      # def participatory_processes(feed)
+      #   @participatory_processes ||= feed.participatory_space_sibling_scope(:participatory_processes).where(id: @form.participatory_processes_ids)
+      # end
+
+      # def link_participatory_processes(feed)
+      #   feed.link_participatory_space_resources(participatory_processes(feed), "included_participatory_processes")
+      # end
+    end
+  end
+end

data/app/commands/decidim/feeds/update_feed.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    # A command with all the business logic when creating a new participatory
+    # feed in the system.
+    class UpdateFeed < Decidim::Command
+      include ::Decidim::AttachmentAttributesMethods
+
+      # Public: Initializes the command.
+      #
+      # feed - the Feed to update
+      # form - A form object with the params.
+      def initialize(feed, form)
+        @feed = feed
+        @form = form
+      end
+
+      # Executes the command. Broadcasts these events:
+      #
+      # - :ok when everything is valid.
+      # - :invalid if the form was not valid and we could not proceed.
+      #
+      # Returns nothing.
+      def call
+        return broadcast(:invalid) if form.invalid?
+
+        update_feed
+        # link_participatory_processes(@feed)
+
+        if @feed.valid?
+          broadcast(:ok, @feed)
+        else
+          # form.errors.add(:hero_image, @feed.errors[:hero_image]) if @feed.errors.include? :hero_image
+          # form.errors.add(:banner_image, @feed.errors[:banner_image]) if @feed.errors.include? :banner_image
+          broadcast(:invalid)
+        end
+      end
+
+      private
+
+      attr_reader :form, :feed
+
+      def update_feed
+        @feed.assign_attributes(attributes)
+        save_feed if @feed.valid?
+      end
+
+      def save_feed
+        transaction do
+          @feed.save!
+          Decidim.traceability.perform_action!(:update, @feed, form.current_user) do
+            @feed
+          end
+        end
+      end
+
+      def attributes
+        {
+          title: form.title
+        }
+      end
+
+      # def participatory_processes(feed)
+      #   @participatory_processes ||= feed.participatory_space_sibling_scope(:participatory_processes).where(id: @form.participatory_processes_ids)
+      # end
+
+      # def link_participatory_processes(feed)
+      #   feed.link_participatory_space_resources(participatory_processes(feed), "included_participatory_processes")
+      # end
+    end
+  end
+end

data/app/constraints/decidim/feeds/current_component.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    # This class infers the current component on a feed context
+    # request parameters and injects it into the environment.
+    class CurrentComponent
+      # Public: Initializes the class.
+      #
+      # manifest - The manifest of the component to check against.
+      def initialize(manifest)
+        @manifest = manifest
+      end
+
+      # Public: Matches the request against a component and injects it into the
+      #         environment.
+      #
+      # request - The request that holds the current component relevant information.
+      #
+      # Returns a true if the request matches a feed and a
+      # component belonging to that feed, false otherwise
+      def matches?(request)
+        CurrentFeed.new.matches?(request) &&
+          Decidim::CurrentComponent.new(@manifest).matches?(request)
+      end
+    end
+  end
+end

data/app/constraints/decidim/feeds/current_feed.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    # This class infers the current feed we are scoped to by
+    # looking at the request parameters and the organization in the request
+    # environment, and injects it into the environment.
+    class CurrentFeed
+      # Public: Matches the request against a feed and injects it
+      #         into the environment.
+      #
+      # request - The request that holds the feeds relevant
+      #           information.
+      #
+      # Returns a true if the request matched, false otherwise
+      def matches?(request)
+        env = request.env
+
+        @organization = env["decidim.current_organization"]
+        return false unless @organization
+
+        current_feed(env, request.params) ? true : false
+      end
+
+      private
+
+      def current_feed(env, params)
+        env["decidim.current_participatory_space"] ||=
+          detect_current_feed(params)
+      end
+
+      def detect_current_feed(params)
+        organization_feeds.where(slug: params["feed_slug"]).or(
+          organization_feeds.where(id: params["feed_slug"])
+        ).first!
+      end
+
+      def organization_feeds
+        @organization_feeds ||= OrganizationFeeds.new(@organization).query
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/feeds/feed_breadcrumb.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    # Concern to provide a specific breadcrumb item to controllers using it
+    module FeedBreadcrumb
+      extend ActiveSupport::Concern
+
+      private
+
+      def current_participatory_space_breadcrumb_item
+        return {} if current_participatory_space.blank?
+
+        dropdown_cell = current_participatory_space_manifest.breadcrumb_cell
+
+        items = current_participatory_space.ancestors.map do |participatory_space|
+          {
+            label: participatory_space.title,
+            url: Decidim::ResourceLocatorPresenter.new(participatory_space).path,
+            active: false,
+            dropdown_cell:,
+            resource: participatory_space
+          }
+        end
+
+        items << {
+          label: current_participatory_space.title,
+          url: Decidim::ResourceLocatorPresenter.new(current_participatory_space).path,
+          active: true,
+          dropdown_cell:,
+          resource: current_participatory_space
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    module Admin
+      # The main admin application controller for feeds
+      class ApplicationController < Decidim::Admin::ApplicationController
+        register_permissions(::Decidim::Feeds::Admin::ApplicationController,
+                             Decidim::Feeds::Permissions,
+                             Decidim::Admin::Permissions)
+
+        private
+
+        def permissions_context
+          super.merge(
+            current_participatory_space: try(:current_participatory_space)
+          )
+        end
+
+        def permission_class_chain
+          ::Decidim.permissions_registry.chain_for(::Decidim::Feeds::Admin::ApplicationController)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Feeds
+    module Admin
+      # Controller that allows managing the Feed Components in the
+      # admin panel.
+      #
+      class ComponentsController < Decidim::Admin::ComponentsController
+        include Concerns::FeedAdmin
+      end
+    end
+  end
+end