decidim-notify 0.3

data/db/migrate/20200504071404_create_notify_notes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class CreateNotifyNotes < ActiveRecord::Migration[5.2]
+  def change
+    create_table :decidim_notify_notes do |t|
+      t.string :body, null: false
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200505061547_create_notify_authors.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class CreateNotifyAuthors < ActiveRecord::Migration[5.2]
+  def change
+    create_table :decidim_notify_authors do |t|
+      t.references :decidim_user, index: { name: "index_decidim_notify_authors_on_decidim_user_id" }
+      t.references :decidim_component, index: { name: "index_decidim_notify_authors_on_decidim_component_id" }
+
+      t.integer :code, null: false, default: 0, index: { name: "index_decidim_notify_authors_on_code" }
+      t.string :full_name
+      t.string :avatar
+      t.string :email
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200505061640_add_notify_notes_references.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class AddNotifyNotesReferences < ActiveRecord::Migration[5.2]
+  def change
+    add_reference :decidim_notify_notes, :decidim_notify_author, index: { name: "index_decidim_notify_notes_on_decidim_notify_author_id" }
+    add_reference :decidim_notify_notes, :decidim_user, index: { name: "index_decidim_notify_notes_on_decidim_user_id" }
+    add_reference :decidim_notify_notes, :decidim_component, index: { name: "index_decidim_notify_notes_on_decidim_component_id" }
+  end
+end

data/db/migrate/20200505195918_add_notify_author_admin.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddNotifyAuthorAdmin < ActiveRecord::Migration[5.2]
+  def change
+    add_column :decidim_notify_authors, :admin, :boolean, default: false
+  end
+end

data/db/migrate/20200507103034_change_notify_notes_authors.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class ChangeNotifyNotesAuthors < ActiveRecord::Migration[5.2]
+  def change
+    add_reference :decidim_notify_notes,
+                  :decidim_creator,
+                  index: { name: "index_decidim_notify_notes_on_decidim_creator_id" },
+                  foreign_key: { to_table: :decidim_users }
+    add_reference :decidim_notify_notes,
+                  :decidim_author,
+                  index: { name: "index_decidim_notify_notes_on_decidim_author_id" },
+                  foreign_key: { to_table: :decidim_users }
+    remove_column :decidim_notify_notes, :decidim_user_id
+  end
+end

data/db/migrate/20200514144040_add_notify_note_chapters.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class AddNotifyNoteChapters < ActiveRecord::Migration[5.2]
+  def change
+    create_table :decidim_notify_chapters do |t|
+      t.string :title, null: false
+      t.boolean :active, null: false, default: false
+      t.references :decidim_component, index: { name: "index_decidim_notify_chapters_on_decidim_component_id" }
+
+      t.timestamps
+    end
+
+    add_reference :decidim_notify_notes, :decidim_notify_chapter, index: { name: "index_decidim_notify_notes_on_decidim_notify_chapter_id" }
+  end
+end

data/lib/decidim/notify.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "decidim/notify/admin"
+require "decidim/notify/engine"
+require "decidim/notify/admin_engine"
+require "decidim/notify/component"
+
+module Decidim
+  # This namespace holds the logic of the `Notify` component. This component
+  # allows users to create notify in a participatory space.
+  module Notify
+    include ActiveSupport::Configurable
+
+    class << self
+      def cable
+        return @cable if @cable
+
+        @cable = ActionCable::Server::Configuration.new
+        @cable.mount_path = config.cable_mount_path
+        @cable.connection_class = -> { Decidim::Notify::Connection }
+        @cable.url = config.cable_url
+        @cable.cable = {
+          "adapter" => config.cable_adapter,
+          "channel_prefix" => config.cable_channel_prefix
+        }
+        @cable
+      end
+
+      def server
+        return @server if @server
+
+        @server = ActionCable::Server::Base.new
+        @server.config = cable
+        @server
+      end
+    end
+
+    config_accessor :cable_mount_path do
+      "/cable"
+    end
+
+    # Not recommended to use "async", event for development
+    # postgresql has a 8000 character limitation
+    config_accessor :cable_adapter do
+      "postgresql"
+    end
+
+    # Next 2 values are only important if cable_adapter is "redis"
+    config_accessor :cable_url do
+      "redis://localhost:6379/1"
+    end
+
+    config_accessor :cable_channel_prefix do
+      "notify_"
+    end
+  end
+end

data/lib/decidim/notify/admin.rb

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

data/lib/decidim/notify/admin_engine.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Notify
+    # This is the engine that runs on the public interface of `Notify`.
+    class AdminEngine < ::Rails::Engine
+      isolate_namespace Decidim::Notify::Admin
+
+      paths["db/migrate"] = nil
+      paths["lib/tasks"] = nil
+
+      routes do
+        # Add admin engine routes here
+        resources :conversations
+        resources :chapters
+        get :users, to: "conversations#users"
+        root to: "conversations#index"
+      end
+
+      def load_seed
+        nil
+      end
+    end
+  end
+end

data/lib/decidim/notify/component.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require_dependency "decidim/components/namer"
+
+Decidim.register_component(:notify) do |component|
+  component.engine = Decidim::Notify::Engine
+  component.admin_engine = Decidim::Notify::AdminEngine
+  component.icon = "decidim/notify/icon.svg"
+  component.stylesheet = "decidim/notify/notify"
+  component.admin_stylesheet = "decidim/notify/admin"
+
+  component.on(:before_destroy) do |instance|
+    # Code executed before removing the component
+    raise StandardEerror, "Can't remove this component, there's notes in it!" if Decidim::Notify::Note.for(instance).any?
+  end
+
+  # These actions permissions can be configured in the admin panel
+  # component.actions = %w()
+
+  component.settings(:global) do |settings|
+    settings.attribute :announcement, type: :text, translated: true, editor: true
+    settings.attribute :private, type: :boolean
+    settings.attribute :restricted, type: :boolean
+  end
+
+  component.settings(:step) do |settings|
+    settings.attribute :announcement, type: :text, translated: true, editor: true
+  end
+
+  # component.register_resource(:some_resource) do |resource|
+  #   # Register a optional resource that can be references from other resources.
+  #   resource.model_class_name = "Decidim::Notify::SomeResource"
+  #   resource.template = "decidim/notify/some_resources/linked_some_resources"
+  # end
+
+  # component.register_stat :some_stat do |context, start_at, end_at|
+  #   # Register some stat number to the application
+  # end
+
+  component.register_stat :notify_conversations_count, priority: Decidim::StatsRegistry::HIGH_PRIORITY do |components, start_at, end_at|
+    conversations = components.published.where(manifest_name: :notify)
+    conversations = conversations.where("created_at >= ?", start_at) if start_at.present?
+    conversations = conversations.where("created_at <= ?", end_at) if end_at.present?
+    conversations.count
+  end
+
+  component.register_stat :notify_notes_count, primary: true, priority: Decidim::StatsRegistry::MEDIUM_PRIORITY do |components, start_at, end_at|
+    notes = Decidim::Notify::Note.where(component: components)
+    notes = notes.where("created_at >= ?", start_at) if start_at.present?
+    notes = notes.where("created_at <= ?", end_at) if end_at.present?
+    notes.count
+  end
+
+  component.register_stat :notify_authors_count, priority: Decidim::StatsRegistry::MEDIUM_PRIORITY do |components, start_at, end_at|
+    authors = Decidim::Notify::Author.where(component: components)
+    authors = authors.where("created_at >= ?", start_at) if start_at.present?
+    authors = authors.where("created_at <= ?", end_at) if end_at.present?
+    authors.count
+  end
+
+  component.register_stat :notify_chapters_count, priority: Decidim::StatsRegistry::MEDIUM_PRIORITY do |components, start_at, end_at|
+    chapters = Decidim::Notify::Chapter.where(component: components)
+    chapters = chapters.where("created_at >= ?", start_at) if start_at.present?
+    chapters = chapters.where("created_at <= ?", end_at) if end_at.present?
+    chapters.count
+  end
+
+  component.seeds do |participatory_space|
+    # Add some seeds for this component
+    admin_user = Decidim::User.find_by(
+      organization: participatory_space.organization,
+      email: "admin@example.org"
+    )
+
+    params = {
+      name: Decidim::Components::Namer.new(participatory_space.organization.available_locales, :notify).i18n_name,
+      manifest_name: :notify,
+      published_at: Time.current,
+      participatory_space: participatory_space,
+      settings: {
+        announcement: { en: Faker::Lorem.paragraphs(2).join("\n") },
+        private: Faker::Boolean.boolean(0.5),
+        restricted: Faker::Boolean.boolean(0.5)
+      }
+    }
+
+    component = Decidim.traceability.perform_action!(
+      "publish",
+      Decidim::Component,
+      admin_user,
+      visibility: "all"
+    ) do
+      Decidim::Component.create!(params)
+    end
+
+    notes = [
+      "I love dinosaurs, there where amazing beasts!",
+      "Dinosaurs when extinct 65 million years ago",
+      "Dinosaurs are not really extinct, they evolve into birds!",
+      "Actually, there's more species of birds than mammals, so we could say that they still rule the earth!"
+    ]
+
+    # Create a chapter
+    chapter = Decidim::Notify::Chapter.create!(
+      title: "Extinctions",
+      active: true,
+      component: component
+    )
+    # add admin user as a note taker
+    # add a random user as a note taker
+    # add 2 users as participants
+    participants = [admin_user] + Decidim::User.where(organization: component.organization).sample(3)
+    # add avatars and create participants
+    participants.each.with_index(1) do |user, index|
+      user.avatar = File.new(File.join(__dir__, "seeds", "avatar#{index}.png"))
+      user.save!
+      # create author
+      author = Decidim::Notify::Author.find_or_create_by(
+        user: user,
+        component: component
+      )
+      author.code = index
+      author.admin = index < 3
+      author.save!
+      # Create a note for the conversation
+      Decidim::Notify::Note.create!(
+        component: component,
+        author: author.user,
+        creator: admin_user,
+        chapter: index > 1 ? chapter : nil,
+        body: notes[index - 1]
+      )
+    end
+  end
+end

data/lib/decidim/notify/engine.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "rails"
+require "decidim/core"
+
+module Decidim
+  module Notify
+    # This is the engine that runs on the public interface of notify.
+    class Engine < ::Rails::Engine
+      isolate_namespace Decidim::Notify
+
+      routes do
+        # Add engine routes here
+        resources :conversations
+        resources :chapters, only: [:update, :destroy]
+        get :users, to: "conversations#users"
+        root to: "conversations#index"
+      end
+
+      initializer "decidim_notify.assets" do |app|
+        app.config.assets.precompile += %w(decidim_notify_manifest.js decidim_notify_manifest.css)
+      end
+
+      initializer "decidim_notify.cable" do |_app|
+        Decidim::Core::Engine.routes do
+          mount Decidim::Notify.server => Decidim::Notify.config.cable_mount_path
+        end
+      end
+
+      initializer "decidim_notify.cable.logger" do
+        Decidim::Notify.cable.logger ||= ::Rails.logger
+      end
+
+      initializer "decidim.notify.add_cells_view_paths" do
+        Cell::ViewModel.view_paths << File.expand_path("#{Decidim::Notify::Engine.root}/app/cells")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "decidim/core/test/factories"
+
+FactoryBot.define do
+  factory :notify_component, parent: :component do
+    name { Decidim::Components::Namer.new(participatory_space.organization.available_locales, :notify).i18n_name }
+    manifest_name { :notify }
+    participatory_space { create(:participatory_process, :with_steps) }
+  end
+
+  factory :notify_note, class: "Decidim::Notify::Note" do
+    component { create(:notify_component) }
+    body { Faker::Lorem.sentences(3).join("\n") }
+    creator { create(:user) }
+
+    trait :with_author do
+      author { create(:user) }
+    end
+
+    trait :with_chapter do
+      chapter { create(:notify_chapter, component: component) }
+    end
+  end
+
+  factory :notify_author, class: "Decidim::Notify::Author" do
+    component { create(:notify_component) }
+    code { Faker::Number.between(1, 20) }
+    # name { Faker::Name.name }
+
+    trait :with_user do
+      user { create(:user) }
+    end
+
+    trait :is_note_taker do
+      admin { true }
+    end
+  end
+
+  factory :notify_chapter, class: "Decidim::Notify::Chapter" do
+    component { create(:notify_component) }
+    title { Faker::Lorem.sentences(3).join("\n") }
+
+    trait :with_user do
+      user { create(:user) }
+    end
+  end
+end

data/lib/decidim/notify/test/shared_examples/component_examples.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+shared_examples "model component is notify" do
+  it "is associated with a component" do
+    expect(subject.component).to be_a(Decidim::Component)
+  end
+
+  context "when component is not notify" do
+    let(:another_component) { create :dummy_component }
+
+    before do
+      subject.component = another_component
+    end
+
+    it { is_expected.to be_invalid }
+  end
+
+  context "when obtaining all elements for the component" do
+    it "returns current element" do
+      expect(subject.class.for(subject.component)).to include(subject)
+    end
+  end
+end

data/lib/decidim/notify/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This holds the decidim-notify version.
+  module Notify
+    VERSION = "0.3"
+    MIN_DECIDIM_VERSION = ">= 0.21"
+  end
+end