decidim-core 0.8.4 → 0.9.0

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

@@ -36,10 +36,11 @@ shared_examples "manage announcements" do
 
     it "customize an announcement for the current step and it has more priority" do
       visit edit_feature_path(current_feature)
+      step_id = current_feature.participatory_space.steps.first.id
 
       fill_in_i18n_editor(
-        :feature_step_settings_1_announcement,
-        "#step-1-settings-announcement-tabs",
+        :"feature_step_settings_#{step_id}_announcement",
+        "#step-#{step_id}-settings-announcement-tabs",
         en: "An announcement for this step",
         es: "Un aviso para esta fase",
         ca: "Un avís per a aquesta fase"

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

@@ -23,12 +23,14 @@ shared_examples "comments" do
     end
   end
 
-  it "allows user to sort the comments" do
+  it "allows user to sort the comments", :slow do
     comment = create(:comment, commentable: commentable, body: "Most Rated Comment")
     create(:comment_vote, comment: comment, author: user, weight: 1)
 
     visit resource_path
 
+    expect(page).to have_no_content("Comments are disabled at this time")
+
     expect(page).to have_css(".comment", minimum: 1)
     page.find(".order-by .dropdown.menu .is-dropdown-submenu-parent").hover
 
@@ -88,7 +90,7 @@ shared_examples "comments" do
       end
     end
 
-    context "when a user replies to a comment" do
+    context "when a user replies to a comment", :slow do
       let!(:comment_author) { create(:user, :confirmed, organization: organization) }
       let!(:comment) { create(:comment, commentable: commentable, author: comment_author) }
 
@@ -99,6 +101,7 @@ shared_examples "comments" do
 
         within "#comments #comment_#{comment.id}" do
           click_button "Reply"
+          expect(page).to have_selector(".add-comment")
           fill_in "add-comment-Decidim::Comments::Comment-#{comment.id}", with: "This is a reply"
           click_button "Send"
         end

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

@@ -10,13 +10,19 @@ shared_examples "scope helpers" do
   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
+  let(:helper) do
+    Class.new.tap do |v|
+      v.extend(Decidim::ScopesHelper)
+      v.extend(Decidim::TranslationsHelper)
+    end
+  end
 
   describe "has_visible_scopes?" do
+    subject { helper.has_visible_scopes?(resource) }
+
     context "when all conditions are met" do
       it { is_expected.to be_truthy }
     end
@@ -26,8 +32,13 @@ shared_examples "scope helpers" do
       it { is_expected.to be_falsey }
     end
 
-    context "when the process has a scope" do
+    context "when the process has a different scope than the organization" do
       let(:participatory_space_scope) { create(:scope, organization: organization) }
+      it { is_expected.to be_truthy }
+    end
+
+    context "when the process has the same scope as the organization" do
+      let(:participatory_space_scope) { scope }
       it { is_expected.to be_falsey }
     end
 
@@ -36,4 +47,30 @@ shared_examples "scope helpers" do
       it { is_expected.to be_falsey }
     end
   end
+
+  describe "scope_name_for_picker" do
+    let(:global_name) { "Global name" }
+    subject { helper.scope_name_for_picker(scope, global_name) }
+
+    context "when a scope is given" do
+      context "when the scope has a scope type" do
+        it { is_expected.to include(scope.name["en"]) }
+        it { is_expected.to include(scope.scope_type.name["en"]) }
+      end
+
+      context "when the scope has no type" do
+        before do
+          scope.scope_type = nil
+        end
+
+        it { is_expected.to eq(scope.name["en"]) }
+      end
+    end
+
+    context "when no scope is given" do
+      let(:scope) { nil }
+
+      it { is_expected.to eq("Global name") }
+    end
+  end
 end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+shared_context "simple event" do
+  subject do
+    described_class.new(
+      resource: resource,
+      event_name: event_name,
+      user: user,
+      extra: extra
+    )
+  end
+
+  let(:organization) do
+    if resource.respond_to?(:organization)
+      resource.organization
+    else
+      create :organization
+    end
+  end
+  let(:user) { create :user, organization: organization }
+  let(:extra) { {} }
+  let(:resource_path) { resource_locator(resource).path }
+  let(:resource_url) { resource_locator(resource).url }
+  let(:resource_title) { resource.title["en"] }
+  let(:author) { resource.author }
+  let(:author_presenter) { Decidim::UserPresenter.new(author) }
+end
+
+shared_examples_for "an simple event" do
+  describe "types" do
+    subject { described_class }
+
+    it "supports notifications" do
+      expect(subject.types).to include :notification
+    end
+
+    it "supports emails" do
+      expect(subject.types).to include :email
+    end
+  end
+
+  describe "email_subject" do
+    it "is generated correctly" do
+      expect(subject.email_subject).to be_kind_of(String)
+    end
+  end
+
+  describe "email_intro" do
+    it "is generated correctly" do
+      expect(subject.email_intro).to be_kind_of(String)
+    end
+  end
+
+  describe "email_outro" do
+    it "is generated correctly" do
+      expect(subject.email_outro).to be_kind_of(String)
+    end
+  end
+
+  describe "email_greeting" do
+    it "is generated correctly" do
+      expect(subject.email_greeting).to be_kind_of(String)
+    end
+  end
+
+  describe "notification_title" do
+    it "is generated correctly" do
+      expect(subject.notification_title).to be_kind_of(String)
+    end
+  end
+end

data/lib/decidim/core/version.rb

@@ -4,7 +4,7 @@ module Decidim
   # This holds the decidim-core version.
   module Core
     def self.version
-      "0.8.4"
+      "0.9.0"
     end
   end
 end

data/lib/decidim/events.rb

@@ -5,5 +5,7 @@ module Decidim
     autoload :BaseEvent, "decidim/events/base_event"
     autoload :EmailEvent, "decidim/events/email_event"
     autoload :NotificationEvent, "decidim/events/notification_event"
+    autoload :SimpleEvent, "decidim/events/simple_event"
+    autoload :AuthorEvent, "decidim/events/author_event"
   end
 end

data/lib/decidim/events/author_event.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Events
+    # This module is used to be included in event classes inheriting from SimpleEvent
+    # whose resource has an author.
+    #
+    # It adds the author_name, author_nickname, author_path and author_url to the i18n interpolations.
+    module AuthorEvent
+      extend ActiveSupport::Concern
+
+      included do
+        i18n_attributes :author_name, :author_nickname, :author_path, :author_url
+
+        def author_nickname
+          author_presenter.nickname
+        end
+
+        def author_name
+          author_presenter.name
+        end
+
+        def author_path
+          author_presenter.profile_path
+        end
+
+        def author_url
+          author_presenter.profile_url
+        end
+
+        def author_presenter
+          @author ||= Decidim::UserPresenter.new(author)
+        end
+
+        def author
+          resource.author if resource.respond_to?(:author)
+        end
+      end
+    end
+  end
+end

data/lib/decidim/events/base_event.rb

@@ -6,6 +6,9 @@ module Decidim
     # 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
+      class_attribute :types
+      self.types = []
+
       # 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:
@@ -16,7 +19,7 @@ module Decidim
       #     extend ActiveSupport::Concern
       #
       #     included do
-      #       types << :web_push_notifications
+      #       type :web_push_notifications
       #     end
       #   end
       #
@@ -25,8 +28,8 @@ module Decidim
       #   end
       #
       #   MyEvent.types # => [:web_push_notifications]
-      def self.types
-        @types ||= []
+      def self.type(type)
+        self.types += Array(type)
       end
 
       # Initializes the class.
@@ -58,10 +61,32 @@ module Decidim
         @resource_url ||= resource_locator.url
       end
 
+      # Whether this event should be notified or not. Useful when you want the
+      # event to decide based on the params.
+      #
+      # It returns false when the resource or any element in the chain is a
+      # `Decidim::Publicable` and it isn't published.
+      def notifiable?
+        return false if resource.is_a?(Decidim::Publicable) && !resource.published?
+        return false if participatory_space.is_a?(Decidim::Publicable) && !participatory_space&.published?
+        return false unless feature&.published?
+
+        true
+      end
+
       private
 
       attr_reader :event_name, :resource, :user, :extra
 
+      def feature
+        return resource.feature if resource.is_a?(Decidim::HasFeature)
+        return resource if resource.is_a?(Decidim::Feature)
+      end
+
+      def participatory_space
+        return feature.participatory_space if feature
+      end
+
       def resource_title
         resource.title.is_a?(Hash) ? resource.title[I18n.locale.to_s] : resource.title
       end

data/lib/decidim/events/email_event.rb

@@ -16,7 +16,7 @@ module Decidim
       extend ActiveSupport::Concern
 
       included do
-        types << :email
+        type :email
 
         def email_subject
           I18n.t("decidim.events.email_event.email_subject", resource_title: resource_title)

data/lib/decidim/events/notification_event.rb

@@ -17,7 +17,7 @@ module Decidim
       extend ActiveSupport::Concern
 
       included do
-        types << :notification
+        type :notification
 
         def notification_title
           I18n.t(

data/lib/decidim/events/simple_event.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Events
+    # Extends the BaseEvent to add common features to most events so you don't
+    # need to write each time the same code.
+    #
+    # The only convention you need to keep in mind is that the event name will be
+    # used as the i18n scope to search for the keys.
+    class SimpleEvent < BaseEvent
+      include Decidim::Events::EmailEvent
+      include Decidim::Events::NotificationEvent
+
+      class_attribute :i18n_interpolations
+      self.i18n_interpolations = []
+
+      # Public: A method to add values to pass as interpolations to the I18n.t method.
+      #
+      # By default the resource_path, resource_title and resource_url are already included.
+      #
+      # attribute - A Symbol of the method name (and interpolation value) to add.
+      #
+      # Example:
+      #
+      #   class MyEvent < Decidim::Events::SimpleEvent
+      #     i18n_attributes :participatory_space_title
+      #   end
+      def self.i18n_attributes(*attributes)
+        self.i18n_interpolations += Array(attributes)
+      end
+
+      def email_subject
+        I18n.t("email_subject", i18n_options).html_safe
+      end
+
+      def email_intro
+        I18n.t("email_intro", i18n_options).html_safe
+      end
+
+      def email_outro
+        I18n.t("email_outro", i18n_options).html_safe
+      end
+
+      def notification_title
+        I18n.t("notification_title", i18n_options).html_safe
+      end
+
+      # Public: The String to use as scope to search for the keys
+      # when using I18n.t
+      #
+      # By default is the same value as the event name.
+      def i18n_scope
+        event_name
+      end
+
+      # Public: The Hash of options to pass to the I18.t method.
+      def i18n_options
+        default_i18n_options.merge(event_interpolations)
+      end
+
+      private
+
+      def event_interpolations
+        Array(self.class.i18n_interpolations).inject({}) do |all, attribute|
+          all.update(attribute => send(attribute))
+        end
+      end
+
+      def default_i18n_options
+        {
+          resource_path: resource_path,
+          resource_title: resource_title,
+          resource_url: resource_url,
+          scope: i18n_scope
+        }
+      end
+    end
+  end
+end

data/lib/decidim/filter_form_builder.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/ParameterLists
 require "decidim/form_builder"
 
 module Decidim
@@ -41,8 +40,8 @@ module Decidim
       end
     end
 
-    # Wrap the scopes select in a custom fieldset.
-    def scopes_select(method, options = {})
+    # Wrap the scopes picker in a custom fieldset.
+    def scopes_picker(method, options = {})
       fieldset_wrapper options[:legend_title] do
         super(method, options)
       end

data/lib/decidim/form_builder.rb

@@ -25,6 +25,7 @@ module Decidim
     def collection_check_boxes(attribute, collection, value_attribute, text_attribute, options = {}, html_options = {})
       super + error_and_help_text(attribute, options)
     end
+    # rubocop:enable Metrics/ParameterLists
 
     # Public: Generates an form field for each locale.
     #
@@ -131,29 +132,28 @@ module Decidim
       select(name, @template.options_for_select(categories, selected: selected, disabled: disabled), options, html_options)
     end
 
-    # Public: Generates a select field with the scopes.
+    # Public: Generates a picker field for scope selection.
     #
-    # name       - The name of the field (usually scope_id)
-    # collection - A collection of scopes.
-    # options    - An optional Hash with options:
-    # - prompt   - An optional String with the text to display as prompt.
+    # name          - The name of the field (usually scope_id)
+    # options       - An optional Hash with options:
+    # - multiple    - Multiple mode, to allow multiple scopes selection.
+    # - label       - Show label?
+    #
+    # Also it should receive a block that returns a Hash with :url and :text for each selected scope (and for null scope for prompt)
     #
     # Returns a String.
-    def scopes_select(name, options = {})
-      selected = object.send(name)
-      if selected.present?
-        selected = selected.values if selected.is_a?(Hash)
-        selected = [selected] unless selected.is_a?(Array)
-        scopes = Decidim::Scope.where(id: selected.map(&:to_i)).map { |scope| [scope.name[I18n.locale.to_s], scope.id] }
-      else
-        scopes = []
-      end
-      prompt = options.delete(:prompt)
-      remote_path = options.delete(:remote_path) || false
-      multiple = options.delete(:multiple) || false
-      html_options = { multiple: multiple, class: "select2", "data-remote-path" => remote_path, "data-placeholder" => prompt }
+    def scopes_picker(attribute, options = {})
+      picker_options = { id: "#{@object_name}_#{attribute}", class: "picker-#{options[:multiple] ? "multiple" : "single"}",
+                         name: "#{@object_name}[#{attribute}]" }
+      picker_options[:class] += " is-invalid-input" if error?(attribute)
 
-      select(name, @template.options_for_select(scopes, selected: selected), options, html_options)
+      prompt_params = yield(nil)
+      scopes = selected_scopes(attribute).map { |scope| [scope, yield(scope)] }
+      template = ""
+      template += label(attribute, label_for(attribute) + required_for_attribute(attribute)) unless options[:label] == false
+      template += @template.render("decidim/scopes/scopes_picker_input", picker_options: picker_options, prompt_params: prompt_params, scopes: scopes)
+      template += error_and_help_text(attribute, options)
+      template.html_safe
     end
 
     # Public: Override so checkboxes are rendered before the label.
@@ -259,6 +259,17 @@ module Decidim
       template.html_safe
     end
 
+    # Public: Returns the translated name for the given attribute.
+    #
+    # attribute    - The String name of the attribute to return the name.
+    def label_for(attribute)
+      if object.class.respond_to?(:human_attribute_name)
+        object.class.human_attribute_name(attribute)
+      else
+        attribute.to_s.humanize
+      end
+    end
+
     private
 
     # Private: Override from FoundationRailsHelper in order to render
@@ -461,14 +472,6 @@ module Decidim
                    end
     end
 
-    def label_for(attribute)
-      if object.class.respond_to?(:human_attribute_name)
-        object.class.human_attribute_name(attribute)
-      else
-        attribute.to_s.humanize
-      end
-    end
-
     def name_with_locale(name, locale)
       "#{name}_#{locale.to_s.gsub("-", "__")}"
     end
@@ -506,5 +509,14 @@ module Decidim
       end
       "".html_safe
     end
+
+    # Private: Returns an array of scopes related to object attribute
+    def selected_scopes(attribute)
+      selected = object.send(attribute) || []
+      selected = selected.values if selected.is_a?(Hash)
+      selected = [selected] unless selected.is_a?(Array)
+      selected = Decidim::Scope.where(id: selected.map(&:to_i)) unless selected.first.is_a?(Decidim::Scope)
+      selected
+    end
   end
 end