decidim-collaborative_texts 0.31.0.rc1

data/lib/decidim/api/document_input_filter.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Decidim
+  module CollaborativeTexts
+    class DocumentInputFilter < Decidim::Core::BaseInputFilter
+      include Decidim::Core::HasTimestampInputFilter
+
+      graphql_name "CollaborativeTextFilter"
+      description "A type used for filtering collaborative texts inside a participatory space.
+
+A typical query would look like:
+
+```
+  {
+    participatoryProcesses {
+      components {
+        ...on CollaborativeTexts {
+          collaborativeTexts(filter:{ createdBefore: \"2020-01-01\" }) {
+            id
+          }
+        }
+      }
+    }
+  }
+```
+"
+    end
+  end
+end

data/lib/decidim/api/document_input_sort.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Decidim
+  module CollaborativeTexts
+    class DocumentInputSort < Decidim::Core::BaseInputSort
+      include Decidim::Core::HasTimestampInputSort
+
+      graphql_name "CollaborativeTextSort"
+      description "A type used for sorting blog collaborative texts"
+
+      argument :id, GraphQL::Types::String, "Sort by ID, valid values are ASC or DESC", required: false
+    end
+  end
+end

data/lib/decidim/api/document_type.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Decidim
+  module CollaborativeTexts
+    class DocumentType < Decidim::Api::Types::BaseObject
+      graphql_name "CollaborativeText"
+      description "A collaborative text document."
+
+      implements Decidim::Core::CoauthorableInterface
+      implements Decidim::Core::TraceableInterface
+      implements Decidim::Core::TimestampsInterface
+
+      field :accepting_suggestions, GraphQL::Types::Boolean, "Whether this collaborative text document is accepting suggestions or not", null: true
+      field :announcement, Decidim::Core::TranslatedFieldType, "The announcement of this collaborative text document.", null: true
+      field :body, GraphQL::Types::String, "The body of this collaborative text document.", null: true
+      field :document_versions, [Decidim::CollaborativeTexts::VersionType], "The versions of this collaborative text document.", null: true
+      field :document_versions_count, GraphQL::Types::Int, "The number of versions for this collaborative text document.", null: true
+      field :draft, GraphQL::Types::Boolean, "Whether this collaborative text document is a draft or not", null: true
+      field :id, GraphQL::Types::ID, "The id of the collaborative text document", null: false
+      field :published_at, Decidim::Core::DateTimeType, description: "The date and time this collaborative text document was published", null: true
+      field :suggestions, [Decidim::CollaborativeTexts::SuggestionType], "The suggestions for this collaborative text document.", null: true
+      field :suggestions_count, GraphQL::Types::Int, "The number of suggestions for this collaborative text document.", null: true
+      field :title, GraphQL::Types::String, "The title of this collaborative text document.", null: false
+      field :url, String, "The URL for this project", null: false
+
+      def url
+        Decidim::ResourceLocatorPresenter.new(object).url
+      end
+    end
+  end
+end

data/lib/decidim/api/documents_type.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Decidim
+  module CollaborativeTexts
+    class DocumentsType < Decidim::Core::ComponentType
+      graphql_name "CollaborativeTexts"
+      description "A collaborative texts component of a participatory space."
+
+      field :collaborative_text, Decidim::CollaborativeTexts::DocumentType, "A single CollaborativeText object", null: true do
+        argument :id, GraphQL::Types::ID, "The id of the CollaborativeText requested", required: true
+      end
+
+      field :collaborative_texts, Decidim::CollaborativeTexts::DocumentType.connection_type, "A collection of CollaborativeTexts", null: false, connection: true do
+        argument :filter, Decidim::CollaborativeTexts::DocumentInputFilter, "Provides several methods to filter the results", required: false
+        argument :order, Decidim::CollaborativeTexts::DocumentInputSort, "Provides several methods to order the results", required: false
+      end
+
+      def collaborative_texts(filter: {}, order: {})
+        base_query = Decidim::Core::ComponentListBase.new(model_class: Document).call(object, { filter:, order: }, context)
+        if context[:current_user]&.admin?
+          base_query
+        else
+          base_query.published
+        end
+      end
+
+      def collaborative_text(id:)
+        scope =
+          if context[:current_user]&.admin?
+            Document
+          else
+            Document.published
+          end
+
+        Decidim::Core::ComponentFinderBase.new(model_class: scope).call(object, { id: }, context)
+      end
+    end
+  end
+end

data/lib/decidim/api/suggestion_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module CollaborativeTexts
+    class SuggestionType < Decidim::Api::Types::BaseObject
+      description "A suggestion for a collaborative text document version."
+
+      implements Decidim::Core::TraceableInterface
+      implements Decidim::Core::TimestampsInterface
+      implements Decidim::Core::AuthorableInterface
+
+      field :changeset, GraphQL::Types::JSON, "The changeset of this suggestion", null: false
+      field :document_version, Decidim::CollaborativeTexts::VersionType, "The version this suggestion belongs to", null: false
+      field :id, GraphQL::Types::ID, "The id of the suggestion", null: false
+      field :status, GraphQL::Types::String, "The status of the suggestion", null: false
+    end
+  end
+end

data/lib/decidim/api/version_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module CollaborativeTexts
+    class VersionType < Decidim::Api::Types::BaseObject
+      graphql_name "DocumentVersion"
+      description "A specific version for a collaborative text document."
+
+      implements Decidim::Core::TraceableInterface
+      implements Decidim::Core::TimestampsInterface
+
+      field :body, GraphQL::Types::String, "The body of this collaborative text document version.", null: true
+      field :document, Decidim::CollaborativeTexts::DocumentType, "The collaborative text document this version belongs to.", null: true
+      field :draft, GraphQL::Types::Boolean, "Whether this collaborative text document version is a draft or not", null: true
+      field :id, GraphQL::Types::ID, "The id of the collaborative text document version", null: false
+      field :suggestions, [Decidim::CollaborativeTexts::SuggestionType, { null: true }], "The suggestions for this collaborative text document version.", null: true
+      field :suggestions_count, GraphQL::Types::Int, "The number of suggestions for this collaborative text document version.", null: true
+      field :title, GraphQL::Types::String, "The title of this collaborative text document version.", null: false
+    end
+  end
+end

data/lib/decidim/collaborative_texts/admin.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module CollaborativeTexts
+    # This module contains all the domain logic associated to Decidim's
+    # CollaborativeTexts participatory space admin panel.
+    module Admin
+    end
+  end
+end

data/lib/decidim/collaborative_texts/admin_engine.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Decidim
+  module CollaborativeTexts
+    # This is the engine that runs on the public interface of `decidim-collaborative_texts`.
+    class AdminEngine < ::Rails::Engine
+      isolate_namespace Decidim::CollaborativeTexts::Admin
+
+      paths["db/migrate"] = nil
+      paths["lib/tasks"] = nil
+
+      routes do
+        resources :documents, except: [:destroy], controller: "documents" do
+          member do
+            patch :soft_delete
+            patch :restore
+            put :publish
+            put :unpublish
+            get :edit_settings
+            patch :update_settings
+          end
+
+          get :manage_trash, on: :collection
+        end
+
+        root to: "documents#index"
+      end
+
+      def load_seed
+        nil
+      end
+    end
+  end
+end

data/lib/decidim/collaborative_texts/api.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Decidim
+  module CollaborativeTexts
+    autoload :DocumentsType, "decidim/api/documents_type"
+    autoload :DocumentInputFilter, "decidim/api/document_input_filter"
+    autoload :DocumentInputSort, "decidim/api/document_input_sort"
+    autoload :DocumentType, "decidim/api/document_type"
+    autoload :VersionType, "decidim/api/version_type"
+    autoload :SuggestionType, "decidim/api/suggestion_type"
+  end
+end

data/lib/decidim/collaborative_texts/component.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+Decidim.register_component(:collaborative_texts) do |component|
+  component.engine = Decidim::CollaborativeTexts::Engine
+  component.admin_engine = Decidim::CollaborativeTexts::AdminEngine
+  component.icon = "media/images/decidim_collaborative_texts.svg"
+  component.icon_key = "draft-line"
+  component.permissions_class_name = "Decidim::CollaborativeTexts::Permissions"
+
+  component.query_type = "Decidim::CollaborativeTexts::DocumentsType"
+
+  component.register_stat :collaborative_texts_count,
+                          primary: true,
+                          priority: Decidim::StatsRegistry::MEDIUM_PRIORITY,
+                          icon_name: "draft-line",
+                          tooltip_key: "collaborative_texts_count_tooltip" do |components, start_at, end_at|
+    collaborative_texts = Decidim::CollaborativeTexts::Document.where(component: components).published
+    collaborative_texts = collaborative_texts.where(created_at: start_at..) if start_at.present?
+    collaborative_texts = collaborative_texts.where(created_at: ..end_at) if end_at.present?
+    collaborative_texts.count
+  end
+
+  # For the admin sidebar (primary: true)
+  component.register_stat :all_collaborative_texts_count, primary: true, priority: Decidim::StatsRegistry::LOW_PRIORITY do |components, start_at, end_at|
+    collaborative_texts = Decidim::CollaborativeTexts::Document.where(component: components)
+    collaborative_texts = collaborative_texts.where(created_at: start_at..) if start_at.present?
+    collaborative_texts = collaborative_texts.where(created_at: ..end_at) if end_at.present?
+    collaborative_texts.count
+  end
+
+  component.actions = %w(create update destroy)
+
+  component.settings(:global) do |settings|
+    settings.attribute :announcement, type: :text, translated: true, editor: true
+  end
+
+  component.settings(:step) do |settings|
+    settings.attribute :announcement, type: :text, translated: true, editor: true
+  end
+
+  component.register_resource(:collaborative_text) do |resource|
+    resource.model_class_name = "Decidim::CollaborativeTexts::Document"
+    resource.card = "decidim/collaborative_texts/document"
+    resource.searchable = true
+  end
+
+  # component.exports ...
+
+  component.seeds do |participatory_space|
+    require "decidim/collaborative_texts/seeds"
+
+    Decidim::CollaborativeTexts::Seeds.new(participatory_space:).call
+  end
+end

data/lib/decidim/collaborative_texts/engine.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Decidim
+  module CollaborativeTexts
+    class Engine < ::Rails::Engine
+      isolate_namespace Decidim::CollaborativeTexts
+
+      routes do
+        resources :documents do
+          resources :suggestions
+        end
+        scope "/documents" do
+          root to: "documents#index"
+        end
+        get "/", to: redirect("documents", status: 301)
+      end
+
+      initializer "decidim_collaborative_texts.shakapacker.assets_path" do
+        Decidim.register_assets_path File.expand_path("app/packs", root)
+      end
+
+      initializer "decidim_collaborative_texts.add_cells_view_paths" do
+        Cell::ViewModel.view_paths << File.expand_path("#{Decidim::CollaborativeTexts::Engine.root}/app/cells")
+        Cell::ViewModel.view_paths << File.expand_path("#{Decidim::CollaborativeTexts::Engine.root}/app/views") # for partials
+      end
+    end
+  end
+end

data/lib/decidim/collaborative_texts/seeds.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require "decidim/components/namer"
+require "decidim/seeds"
+
+module Decidim
+  module CollaborativeTexts
+    class Seeds < Decidim::Seeds
+      attr_reader :participatory_space
+
+      def initialize(participatory_space:)
+        @participatory_space = participatory_space
+      end
+
+      def call
+        component = create_component!
+
+        number_of_records.times do
+          create_document!(component:)
+        end
+
+        number_of_records.times do
+          create_document!(component:, published_at: nil)
+        end
+      end
+
+      def create_component!
+        params = {
+          name: Decidim::Components::Namer.new(participatory_space.organization.available_locales, :collaborative_texts).i18n_name,
+          manifest_name: :collaborative_texts,
+          published_at: Time.current,
+          participatory_space: participatory_space
+        }
+
+        Decidim.traceability.perform_action!(
+          "publish",
+          Decidim::Component,
+          admin_user,
+          visibility: "all"
+        ) do
+          Decidim::Component.create!(params)
+        end
+      end
+
+      def create_document!(component:, published_at: Time.current)
+        body_blocks = create_body_blocks
+        params = {
+          component:,
+          title: ::Faker::Lorem.paragraph,
+          body: body_blocks.join("\n"),
+          published_at:,
+          accepting_suggestions: [true, false].sample,
+          coauthorships: [Decidim::Coauthorship.new(author: organization)]
+        }
+
+        document = Decidim.traceability.create!(
+          Decidim::CollaborativeTexts::Document,
+          admin_user,
+          params,
+          visibility: "all"
+        )
+
+        # Create some versions
+        number_of_records.times do |num|
+          params = {
+            document:,
+            body: create_body_blocks.join("\n"),
+            created_at: num.seconds.from_now
+          }
+          Decidim.traceability.create!(
+            Decidim::CollaborativeTexts::Version,
+            admin_user,
+            params,
+            visibility: "all"
+          )
+        end
+
+        # Create some suggestions
+        random_positions = (0...body_blocks.size).to_a.sample(5)
+        random_positions.each do |position|
+          changeset = {
+            firstNode: position.to_s,
+            lastNode: (position + rand(1..3)).to_s,
+            replace: rand(1..4).times.map { ::Faker::HTML.paragraph(sentence_count: rand(1..3)) }
+          }
+          create_suggestion!(document_version: document.current_version, changeset:)
+        end
+
+        document
+      end
+
+      def create_suggestion!(document_version:, changeset:)
+        params = {
+          document_version:,
+          changeset:,
+          author: document_version.organization.users.sample
+        }
+        Decidim::CollaborativeTexts::Suggestion.create!(params)
+      end
+
+      def create_body_blocks
+        blocks = []
+        rand(3..5).times do
+          blocks << "<h2>#{::Faker::Lorem.word.capitalize}</h2>"
+          level = 3
+          rand(1..4).times do
+            blocks << "<h#{level}>#{::Faker::Lorem.word.capitalize}</h#{level}>"
+            blocks << ::Faker::HTML.paragraph(sentence_count: rand(3..5))
+            blocks << ::Faker::HTML.random(exclude: [:heading, :script, :table])
+            level += 1
+          end
+        end
+        blocks
+      end
+    end
+  end
+end

data/lib/decidim/collaborative_texts/test/factories.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "decidim/components/namer"
+require "decidim/core/test/factories"
+require "decidim/participatory_processes/test/factories"
+
+FactoryBot.define do
+  factory :collaborative_text_component, parent: :component do
+    transient do
+      skip_injection { false }
+    end
+
+    name { generate_component_name(participatory_space.organization.available_locales, :collaborative_texts, skip_injection:) }
+    manifest_name { :collaborative_texts }
+    participatory_space { create(:participatory_process, :with_steps, skip_injection:, organization:) }
+  end
+
+  factory :collaborative_text_document, class: "Decidim::CollaborativeTexts::Document" do
+    transient do
+      users { nil }
+      skip_injection { false }
+    end
+    title { generate_title(:collaborative_text_document_title, skip_injection:) }
+    component { create(:collaborative_text_component, skip_injection:) }
+
+    trait :with_body do
+      body { Faker::HTML.paragraph }
+    end
+
+    trait :with_versions do
+      document_versions { build_list(:collaborative_text_version, 3) }
+    end
+
+    trait :published do
+      published_at { Time.current }
+    end
+
+    after :build do |document, evaluator|
+      if document.component
+        users = evaluator.users || [document.component.organization]
+        users.each do |user|
+          document.coauthorships.build(author: user)
+        end
+      end
+    end
+  end
+
+  factory :collaborative_text_version, class: "Decidim::CollaborativeTexts::Version" do
+    body { Faker::HTML.paragraph }
+    document { create(:collaborative_text_document) }
+    draft { false }
+
+    trait :draft do
+      draft { true }
+    end
+  end
+
+  factory :collaborative_text_suggestion, class: "Decidim::CollaborativeTexts::Suggestion" do
+    document_version { build(:collaborative_text_version) }
+    author { build(:user, :confirmed, organization: document_version.document.organization) }
+    trait :pending do
+      status { :pending }
+    end
+    trait :accepted do
+      status { :accepted }
+    end
+    trait :rejected do
+      status { :rejected }
+    end
+
+    changeset do
+      {
+        firstNode: "1",
+        lastNode: "2",
+        original: [Faker::HTML.paragraph(sentence_count: rand(1..3))],
+        replace: [Faker::HTML.paragraph(sentence_count: rand(1..3))]
+      }
+    end
+  end
+end

data/lib/decidim/collaborative_texts/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Decidim
+  module CollaborativeTexts
+    def self.version
+      "0.31.0.rc1"
+    end
+  end
+end

data/lib/decidim/collaborative_texts.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "decidim/collaborative_texts/admin"
+require "decidim/collaborative_texts/api"
+require "decidim/collaborative_texts/engine"
+require "decidim/collaborative_texts/admin_engine"
+require "decidim/collaborative_texts/component"
+
+module Decidim
+  # Base module for the collaborative_texts engine.
+  module CollaborativeTexts
+  end
+end