decidim-core 0.5.1 → 0.6.0

data/lib/decidim/core/test.rb

@@ -16,3 +16,6 @@ require "decidim/core/test/shared_examples/reports_examples"
 require "decidim/core/test/shared_examples/manage_moderations_examples"
 require "decidim/core/test/shared_examples/paginated_resource_examples"
 require "decidim/core/test/shared_examples/errors"
+require "decidim/core/test/shared_examples/scope_helper_examples"
+require "decidim/core/test/shared_examples/user_localised_email_examples"
+require "decidim/core/test/shared_examples/follows_examples"

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

@@ -27,11 +27,14 @@ FactoryGirl.define do
   factory :category, class: Decidim::Category do
     name { Decidim::Faker::Localized.sentence(3) }
     description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(2) } }
-    participatory_process
+
+    association :participatory_space, factory: :participatory_process
   end
 
   factory :subcategory, parent: :category do
     parent { build(:category) }
+
+    participatory_space { parent.participatory_space }
   end
 
   factory :organization, class: Decidim::Organization do
@@ -54,76 +57,6 @@ FactoryGirl.define do
     official_url { Faker::Internet.url }
   end
 
-  factory :participatory_process, class: Decidim::ParticipatoryProcess do
-    title { Decidim::Faker::Localized.sentence(3) }
-    slug { generate(:slug) }
-    subtitle { Decidim::Faker::Localized.sentence(1) }
-    short_description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(2) } }
-    description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(4) } }
-    hero_image { Decidim::Dev.test_file("city.jpeg", "image/jpeg") }
-    banner_image { Decidim::Dev.test_file("city2.jpeg", "image/jpeg") }
-    published_at { Time.current }
-    organization
-    meta_scope { Decidim::Faker::Localized.word }
-    developer_group { Decidim::Faker::Localized.sentence(1) }
-    local_area { Decidim::Faker::Localized.sentence(2) }
-    target { Decidim::Faker::Localized.sentence(3) }
-    participatory_scope { Decidim::Faker::Localized.sentence(1) }
-    participatory_structure { Decidim::Faker::Localized.sentence(2) }
-    end_date 2.month.from_now.at_midnight
-    show_statistics true
-
-    trait :promoted do
-      promoted true
-    end
-
-    trait :unpublished do
-      published_at nil
-    end
-
-    trait :published do
-      published_at { Time.current }
-    end
-
-    trait :with_steps do
-      transient { current_step_ends 1.month.from_now }
-
-      after(:create) do |participatory_process, evaluator|
-        create(:participatory_process_step,
-               active: true,
-               end_date: evaluator.current_step_ends,
-               participatory_process: participatory_process)
-        participatory_process.reload
-        participatory_process.steps.reload
-      end
-    end
-  end
-
-  factory :participatory_process_group, class: Decidim::ParticipatoryProcessGroup do
-    name { Decidim::Faker::Localized.sentence(3) }
-    description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(4) } }
-    hero_image { Decidim::Dev.test_file("city.jpeg", "image/jpeg") }
-    organization
-  end
-
-  factory :participatory_process_step, class: Decidim::ParticipatoryProcessStep do
-    title { Decidim::Faker::Localized.sentence(3) }
-    description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(4) } }
-    start_date 1.month.ago.at_midnight
-    end_date 2.month.from_now.at_midnight
-    position nil
-    participatory_process
-
-    after(:create) do |step, _evaluator|
-      step.participatory_process.reload
-      step.participatory_process.steps.reload
-    end
-
-    trait :active do
-      active true
-    end
-  end
-
   factory :user, class: Decidim::User do
     email { generate(:email) }
     password "password1234"
@@ -133,8 +66,6 @@ FactoryGirl.define do
     locale { organization.default_locale }
     tos_agreement "1"
     avatar { Decidim::Dev.test_file("avatar.jpg", "image/jpeg") }
-    comments_notifications true
-    replies_notifications true
 
     trait :confirmed do
       confirmed_at { Time.current }
@@ -286,8 +217,12 @@ FactoryGirl.define do
   end
 
   factory :feature, class: Decidim::Feature do
+    transient do
+      organization { create(:organization) }
+    end
+
     name { Decidim::Faker::Localized.sentence(3) }
-    participatory_process
+    participatory_space { create(:participatory_process, organization: organization) }
     manifest_name "dummy"
     published_at { Time.now }
 
@@ -343,7 +278,7 @@ FactoryGirl.define do
 
   factory :moderation, class: Decidim::Moderation do
     reportable { build(:dummy_resource) }
-    participatory_process { reportable.feature.participatory_process }
+    participatory_space { reportable.feature.participatory_space }
   end
 
   factory :report, class: Decidim::Report do
@@ -357,4 +292,31 @@ FactoryGirl.define do
     user { build(:user, :managed, organization: admin.organization) }
     started_at Time.current
   end
+
+  factory :follow, class: "Decidim::Follow" do
+    user do
+      build(
+        :user,
+        organization: followable.try(:organization) || build(:organization)
+      )
+    end
+    followable { build(:dummy_resource) }
+  end
+
+  factory :notification, class: "Decidim::Notification" do
+    user do
+      build(
+        :user,
+        organization: resource.try(:organization) || build(:organization)
+      )
+    end
+    resource { build(:dummy_resource) }
+    event_name { resource.class.name.underscore.tr("/", ".") }
+    event_class { "Decidim::DummyResourceEvent" }
+    extra do
+      {
+        some_extra_data: "1"
+      }
+    end
+  end
 end

data/lib/decidim/core/test/shared_examples/comments_examples.rb

@@ -68,22 +68,6 @@ shared_examples "comments" do
       it "shows comment to the user" do
         expect(page).to have_comment_from(user, "This is a new comment")
       end
-
-      it "send notifications" do
-        expect(page).to have_comment_from(user, "This is a new comment")
-
-        if commentable.notifiable?(author: user)
-          wait_for_email subject: "new comment"
-          relogin_as commentable.users_to_notify.first, scope: :user
-          visit last_email_first_link
-
-          expect(page).to have_comment_from(user, "This is a new comment")
-        else
-          expect do
-            wait_for_email subject: "new comment"
-          end.to raise_error StandardError
-        end
-      end
     end
 
     context "when the user has verified organizations" do
@@ -127,16 +111,6 @@ shared_examples "comments" do
       it "shows reply to the user" do
         expect(page).to have_reply_to(comment, "This is a reply")
       end
-
-      it "sends notifications received by commentable's author" do
-        expect(page).to have_reply_to(comment, "This is a reply")
-
-        wait_for_email subject: "new reply"
-        relogin_as comment.author, scope: :user
-        visit last_email_first_link
-
-        expect(page).to have_reply_to(comment, "This is a reply")
-      end
     end
 
     describe "arguable option" do

data/lib/decidim/core/test/shared_examples/follows_examples.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+shared_examples "follows" do
+  include_context "feature"
+
+  before do
+    login_as user, scope: :user
+  end
+
+  context "when not following the followable" do
+    context "when user clicks the Follow button" do
+      it "makes the user follow the followable" do
+        visit resource_locator(followable).path
+        expect do
+          click_button "Follow"
+          expect(page).to have_content "Stop following"
+        end.to change(Decidim::Follow, :count).by(1)
+      end
+    end
+  end
+
+  context "when the user is following the followable" do
+    before do
+      create(:follow, followable: followable, user: user)
+    end
+
+    context "when user clicks the Follow button" do
+      it "makes the user follow the followable" do
+        visit resource_locator(followable).path
+        expect do
+          click_button "Stop following"
+          expect(page).to have_content "Follow"
+        end.to change(Decidim::Follow, :count).by(-1)
+      end
+    end
+  end
+end

data/lib/decidim/core/test/shared_examples/manage_moderations_examples.rb

@@ -18,7 +18,7 @@ shared_examples "manage moderations" do
   end
 
   before do
-    visit decidim_admin.edit_participatory_process_path(participatory_process)
+    visit decidim_admin_participatory_processes.edit_participatory_process_path(participatory_process)
     click_link "Moderations"
   end
 

data/lib/decidim/core/test/shared_examples/process_announcements_examples.rb

@@ -22,7 +22,7 @@ shared_examples "manage processes announcements" do
       expect(page).to have_content("successfully")
     end
 
-    visit decidim_admin.participatory_processes_path
+    visit decidim_admin_participatory_processes.participatory_processes_path
 
     within "tr", text: translated(participatory_process.title) do
       page.find("a.action-icon--preview").click

data/lib/decidim/core/test/shared_examples/reportable.rb

@@ -4,8 +4,8 @@ require "spec_helper"
 
 shared_examples_for "reportable" do
   let(:user) { create(:user, organization: subject.organization) }
-  let(:participatory_process) { subject.feature.participatory_process }
-  let(:moderation) { create(:moderation, reportable: subject, participatory_process: participatory_process, report_count: 1) }
+  let(:participatory_space) { subject.feature.participatory_space }
+  let(:moderation) { create(:moderation, reportable: subject, participatory_space: participatory_space, report_count: 1) }
   let!(:report) { create(:report, moderation: moderation, user: user) }
 
   describe "#reported_by?" do
@@ -26,14 +26,14 @@ shared_examples_for "reportable" do
     end
 
     context "when the resource has been hidden" do
-      let(:moderation) { create(:moderation, reportable: subject, participatory_process: participatory_process, report_count: 1, hidden_at: Time.current) }
+      let(:moderation) { create(:moderation, reportable: subject, participatory_space: participatory_space, report_count: 1, hidden_at: Time.current) }
       it { expect(subject).to be_hidden }
     end
   end
 
   context "#reported?" do
     context "when the report count is equal to 0" do
-      let(:moderation) { create(:moderation, reportable: subject, participatory_process: participatory_process, report_count: 0) }
+      let(:moderation) { create(:moderation, reportable: subject, participatory_space: participatory_space, report_count: 0) }
       let!(:report) { nil }
       it { expect(subject).not_to be_reported }
     end

data/lib/decidim/core/test/shared_examples/reports_examples.rb

@@ -42,7 +42,7 @@ shared_examples "reports" do
 
     context "and the user has reported the resource previously" do
       before do
-        moderation = create(:moderation, reportable: reportable, participatory_process: participatory_process)
+        moderation = create(:moderation, reportable: reportable, participatory_space: participatory_process)
         create(:report, moderation: moderation, user: user, reason: "spam")
       end
 

data/lib/decidim/core/test/shared_examples/scope_helper_examples.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+shared_examples "scope helpers" do
+  describe Decidim::ScopesHelper do
+    let(:organization) { create(:organization) }
+    let(:scopes_enabled) { true }
+    let(:participatory_space_scope) { nil }
+    let(:feature) { create(:feature, manifest_name: "dummy", participatory_space: participatory_space) }
+    let(:scope) { create(:scope, organization: organization) }
+    let(:resource) { create(:dummy_resource, feature: feature, scope: scope) }
+
+    subject { helper.has_visible_scopes?(resource) }
+
+    before do
+      allow(helper).to receive(:current_participatory_space).and_return(participatory_space)
+    end
+
+    describe "has_visible_scopes?" do
+      context "when all conditions are met" do
+        it { is_expected.to be_truthy }
+      end
+
+      context "when the process has not scope enabled" do
+        let(:scopes_enabled) { false }
+        it { is_expected.to be_falsey }
+      end
+
+      context "when the process has a scope" do
+        let(:participatory_space_scope) { create(:scope, organization: organization) }
+        it { is_expected.to be_falsey }
+      end
+
+      context "when the resource has not a scope" do
+        let(:scope) { nil }
+        it { is_expected.to be_falsey }
+      end
+    end
+  end
+end

data/lib/decidim/core/test/shared_examples/user_localised_email_examples.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+shared_examples "user localised email" do
+  let(:user) { create(:user, locale: locale, organization: organization) }
+
+  context "when the user has a custom locale" do
+    let(:locale) { "ca" }
+
+    it "uses the user's locale" do
+      expect(mail.subject).to eq(subject)
+      expect(mail.body.encoded).to match(body)
+    end
+  end
+
+  context "otherwise" do
+    let(:locale) { nil }
+
+    it "uses the default locale" do
+      expect(mail.subject).to eq(default_subject)
+      expect(mail.body.encoded).to match(default_body)
+    end
+  end
+end

data/lib/decidim/core/version.rb

@@ -3,7 +3,7 @@
 # This holds Decidim's version and the Rails version on which it depends.
 module Decidim
   def self.version
-    "0.5.1"
+    "0.6.0"
   end
 
   def self.rails_version

data/lib/decidim/engine_router.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Decidim
+  #
+  # This class is responsible for sending route helper methods to the correct
+  # mounted engine. To do that, it needs to know the name of the mounted helper
+  # for the engine, and the contextual parameters to identify the mount point
+  # for it, which are added to the parameters passed to the route helper.
+  #
+  class EngineRouter
+    include Rails.application.routes.mounted_helpers
+
+    # Instantiates a router to the frontend engine for an object.
+    #
+    # @param target [#mounted_engine, #mounted_params] Object to be routed
+    #
+    # @return [EngineRouter] The new engine router
+    def self.main_proxy(target)
+      new(target.mounted_engine, target.mounted_params)
+    end
+
+    # Instantiates a router to the backend engine for an object.
+    #
+    # @param target [#mounted_admin_engine, #mounted_params] Object to be routed
+    #
+    # @return [EngineRouter] The new engine router
+    def self.admin_proxy(target)
+      new(target.mounted_admin_engine, target.mounted_params)
+    end
+
+    attr_reader :default_url_options
+
+    def initialize(engine, default_url_options)
+      @engine = engine
+      @default_url_options = default_url_options
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      route_helper?(method_name) || super
+    end
+
+    def method_missing(method_name, *args)
+      return super unless route_helper?(method_name)
+
+      send(@engine).send(method_name, *args)
+    end
+
+    private
+
+    def route_helper?(method_name)
+      method_name.to_s.match?(/_(url|path)$/)
+    end
+  end
+end

data/lib/decidim/events.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Events
+    autoload :BaseEvent, "decidim/events/base_event"
+    autoload :EmailEvent, "decidim/events/email_event"
+    autoload :NotificationEvent, "decidim/events/notification_event"
+  end
+end

data/lib/decidim/events/base_event.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Events
+    # This class serves as a base for all event classes. Event classes are intended to
+    # add more logic to a `Decidim::Notification` and are used to render them in the
+    # notifications dashboard and to generate other notifications (emails, for example).
+    class BaseEvent
+      # Public: Stores all the notification types this event can create. Please, do not
+      # overwrite this method, consider it final. Instead, add values to the array via
+      # modules, take the `NotificationEvent` module as an example:
+      #
+      # Example:
+      #
+      #   module WebPushNotificationEvent
+      #     extend ActiveSupport::Concern
+      #
+      #     included do
+      #       types << :web_push_notifications
+      #     end
+      #   end
+      #
+      #   class MyEvent < Decidim::Events::BaseEvent
+      #     include WebPushNotificationEvent
+      #   end
+      #
+      #   MyEvent.types # => [:web_push_notifications]
+      def self.types
+        @types ||= []
+      end
+
+      # Initializes the class.
+      #
+      # event_name - a String with the name of the event.
+      # resource - the resource that received the event
+      # user - the User that receives the event
+      # extra - a Hash with extra information of the event.
+      def initialize(resource:, event_name:, user:, extra:)
+        @event_name = event_name
+        @resource = resource
+        @user = user
+        @extra = extra
+      end
+
+      # Caches the locator for the given resource, so that
+      # we can find the resource URL.
+      def resource_locator
+        @resource_locator ||= Decidim::ResourceLocatorPresenter.new(resource)
+      end
+
+      # Caches the path for the given resource.
+      def resource_path
+        @resource_path ||= resource_locator.path
+      end
+
+      # Caches the URL for the given resource.
+      def resource_url
+        @resource_url ||= resource_locator.url
+      end
+
+      private
+
+      attr_reader :event_name, :resource, :user, :extra
+
+      def resource_title
+        resource.title.is_a?(Hash) ? resource.title[I18n.locale.to_s] : resource.title
+      end
+    end
+  end
+end