decidim 0.4.4 → 0.5.0

data/decidim-core/app/forms/decidim/attachment_form.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Decidim
+  # A form object used to create attachments.
+  #
+  class AttachmentForm < Form
+    attribute :title, String
+    attribute :file
+
+    mimic :attachment
+
+    validates :title, presence: true, if: ->(form) { form.file.present? }
+  end
+end

data/decidim-core/app/forms/decidim/delete_account_form.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Decidim
+  # The form object that handles the data behind deleting users account.
+  class DeleteAccountForm < Form
+    attribute :delete_reason, String
+  end
+end

data/decidim-core/app/forms/decidim/form.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  # A base form object to hold common logic, like automatically adding as
+  # public method the params sent as context by the `FormFactory` concern.
+  class Form < Rectify::Form
+    delegate :current_organization,
+             :current_user,
+             :current_feature,
+             to: :context, prefix: false, allow_nil: true
+
+    def available_locales
+      current_organization&.available_locales
+    end
+  end
+end

data/decidim-core/app/forms/decidim/invite_user_form.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Decidim
+  # A form object used to invite users to an organization.
+  #
+  class InviteUserForm < Form
+    mimic :user
+
+    attribute :email, String
+    attribute :name, String
+    attribute :invitation_instructions, String
+    attribute :organization, Decidim::Organization
+    attribute :invited_by, Decidim::User
+    attribute :role, String
+
+    validates :email, :name, :organization, :invitation_instructions, presence: true
+    validates :role, inclusion: { in: Decidim::User::ROLES }
+
+    validate :admin_uniqueness
+
+    def email
+      super&.downcase
+    end
+
+    def organization
+      super || current_organization
+    end
+
+    def invited_by
+      super || current_user
+    end
+
+    def available_roles_for_select
+      Decidim::User::ROLES.map do |role|
+        [
+          I18n.t(role, scope: "decidim.admin.models.user.fields.roles"),
+          role
+        ]
+      end
+    end
+
+    private
+
+    def admin_uniqueness
+      errors.add(:email, :taken) if organization.admins.where(email: email).exists?
+    end
+  end
+end

data/decidim-core/app/forms/decidim/notifications_settings_form.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Decidim
+  # The form object that handles the data behind updating a user's
+  # notifications settings in her profile page.
+  class NotificationsSettingsForm < Form
+    mimic :user
+
+    attribute :comments_notifications
+    attribute :replies_notifications
+    attribute :newsletter_notifications
+
+    validates :comments_notifications, presence: true
+    validates :replies_notifications, presence: true
+    validates :newsletter_notifications, presence: true
+  end
+end

data/decidim-core/app/forms/decidim/omniauth_registration_form.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Decidim
+  # A form object used to fisnish signup from omniauth data
+  class OmniauthRegistrationForm < Form
+    mimic :user
+
+    attribute :email, String
+    attribute :name, String
+    attribute :provider, String
+    attribute :uid, String
+    attribute :tos_agreement, Boolean
+    attribute :oauth_signature, String
+
+    validates :email, presence: true
+    validates :name, presence: true
+    validates :provider, presence: true
+    validates :uid, presence: true
+
+    def self.create_signature(provider, uid)
+      Digest::MD5.hexdigest("#{provider}-#{uid}-#{Rails.application.secrets.secret_key_base}")
+    end
+  end
+end

data/decidim-core/app/forms/decidim/registration_form.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Decidim
+  # A form object used to handle user registrations
+  class RegistrationForm < Form
+    mimic :user
+
+    attribute :sign_up_as, String
+    attribute :name, String
+    attribute :email, String
+    attribute :password, String
+    attribute :password_confirmation, String
+    attribute :newsletter_notifications, Boolean
+    attribute :tos_agreement, Boolean
+
+    attribute :user_group_name, String
+    attribute :user_group_document_number, String
+    attribute :user_group_phone, String
+
+    validates :sign_up_as, inclusion: { in: %w(user user_group) }
+    validates :name, presence: true
+    validates :email, presence: true
+    validates :password, presence: true, confirmation: true, length: { in: Decidim::User.password_length }
+    validates :tos_agreement, allow_nil: false, acceptance: true
+
+    validates :user_group_name, presence: true, if: :user_group?
+    validates :user_group_document_number, presence: true, if: :user_group?
+    validates :user_group_phone, presence: true, if: :user_group?
+
+    validate :email_unique_in_organization
+    validate :user_group_name_unique_in_organization
+    validate :user_group_document_number_unique_in_organization
+
+    def user_group?
+      sign_up_as == "user_group"
+    end
+
+    private
+
+    def email_unique_in_organization
+      errors.add :email, :taken if User.where(email: email, organization: current_organization).first.present?
+    end
+
+    def user_group_name_unique_in_organization
+      errors.add :user_group_name, :taken if UserGroup.where(name: user_group_name, decidim_organization_id: current_organization.id).first.present?
+    end
+
+    def user_group_document_number_unique_in_organization
+      errors.add :user_group_document_number, :taken if UserGroup.where(
+        document_number: user_group_document_number,
+        decidim_organization_id: current_organization.id
+      ).first.present?
+    end
+  end
+end

data/decidim-core/app/forms/decidim/report_form.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  # A form object to be used when public users want to report a reportable.
+  class ReportForm < Decidim::Form
+    mimic :report
+
+    attribute :reason, String
+    attribute :details, String
+
+    validates :reason, inclusion: { in: Report::REASONS }
+  end
+end

data/decidim-core/app/forms/translatable_presence_validator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# A custom validator to check for presence in I18n-enabled fields. In order to
+# use it do the following:
+#
+#   validates :my_i18n_field, translatable_presence: true
+#
+# This will automatically check for presence for each of the
+# `available_locales` of the form object (or the `available_locales` of the
+# form's organization) for the given field.
+class TranslatablePresenceValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, _value)
+    available_locales_for(record).each do |locale|
+      translated_attr = "#{attribute}_#{locale}"
+      record.errors.add(translated_attr, :blank) unless record.send(translated_attr).present?
+    end
+  end
+
+  private
+
+  def available_locales_for(record)
+    return record.available_locales if record.respond_to?(:available_locales)
+
+    if record.current_organization
+      record.current_organization.available_locales
+    else
+      record.errors.add(:current_organization, :blank)
+      []
+    end
+  end
+end

data/decidim-core/app/helpers/decidim/action_authorization_helper.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ActionAuthorizationHelper
+    # Public: Renders a modal that explains why she can't perform an action,
+    # if that's the case. The modal isn't shown by default, and it's usually
+    # triggered by `action_authorized_link_to` or `action_authorized_button_to`.
+    #
+    # action - The action to authenticate against.
+    #
+    # Returns a String with the modal.
+    def action_authorization_modal(action)
+      render partial: "decidim/shared/action_authorization_modal",
+             locals: { action: action.to_s }
+    end
+
+    # Public: Emulates a `link_to` but conditionally renders a popup modal
+    # blocking the action in case the user isn't allowed to perform it.
+    #
+    # action     - The name of the action to authorize against.
+    # *arguments - A regular set of arguments that would be provided to
+    #              `link_to`.
+    #
+    # Returns a String with the link.
+    def action_authorized_link_to(action, *arguments, &block)
+      if block_given?
+        body = block
+        url = arguments[0]
+        html_options = arguments[1]
+      else
+        body = arguments[0]
+        url = arguments[1]
+        html_options = arguments[2]
+      end
+
+      unless current_user_authorized?(action)
+        html_options ||= {}
+        html_options["onclick"] = "event.preventDefault();"
+        html_options["data-toggle"] = current_user ? "#{action.to_s.underscore}AuthorizationModal" : "loginModal"
+        url = ""
+      end
+
+      if block_given?
+        link_to(url, html_options, &body)
+      else
+        link_to(body, url, html_options)
+      end
+    end
+
+    # Public: Emulates a `button_to` but conditionally renders a popup modal
+    # blocking the action in case the user isn't allowed to perform it.
+    #
+    # action     - The name of the action to authorize against.
+    # *arguments - A regular set of arguments that would be provided to
+    #              `button_to`.
+    #
+    # Returns a String with the button.
+    def action_authorized_button_to(action, *arguments, &block)
+      if block_given?
+        body = block
+        url = arguments[0]
+        html_options = arguments[1] || {}
+      else
+        body = arguments[0]
+        url = arguments[1]
+        html_options = arguments[2] || {}
+      end
+
+      unless current_user_authorized?(action)
+        html_options["onclick"] = "event.preventDefault();"
+        html_options["data-toggle"] = current_user ? "#{action.to_s.underscore}AuthorizationModal" : "loginModal"
+        url = ""
+      end
+
+      if block_given?
+        button_to(url, html_options, &body)
+      else
+        button_to(body, url, html_options)
+      end
+    end
+
+    private
+
+    def current_user_authorized?(action)
+      current_user && action_authorization(action).ok?
+    end
+  end
+end

data/decidim-core/app/helpers/decidim/application_helper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Decidim
+  # Main module to add application-wide helpers.
+  module ApplicationHelper
+    include Decidim::OmniauthHelper
+    include Decidim::ScopesHelper
+
+    # Truncates a given text respecting its HTML tags.
+    #
+    # text    - The String text to be truncated.
+    # options - A Hash with the options to truncate the text (default: {}):
+    #           :length - An Integer number with the max length of the text.
+    #           :separator - A String to append to the text when it's being
+    #           truncated. See `truncato` gem for more options.
+    #
+    # Returns a String.
+    def html_truncate(text, options = {})
+      options[:max_length] = options.delete(:length) || options[:max_length]
+      options[:tail] = options.delete(:separator) || options[:tail] || "..."
+      options[:count_tags] ||= false
+      options[:count_tail] ||= false
+      options[:tail_before_final_tag] ||= true
+
+      Truncato.truncate(text, options)
+    end
+  end
+end

data/decidim-core/app/helpers/decidim/aria_selected_link_to_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Decidim
+  # Module to add the attribute `aria-selected` to links when they are
+  # pointing to the current path. Uses the `active_link_to` gem to calculate
+  # this.
+  #
+  module AriaSelectedLinkToHelper
+    # Adds the `aria-selected` attribute to a link when it's pointing to the
+    # current path. The API is the same than the `link_to` one, and uses this
+    # helper internally.
+    #
+    # text - a String with the link text
+    # link - Where the link should point to. Accepts the same value than
+    #   `link_to` helper.
+    # options - An options Hash that will be passed to `link_to`.
+    def aria_selected_link_to(text, link, options = {})
+      link_to(
+        text,
+        link,
+        options.merge(
+          "aria-selected": is_active_link?(link, options[:aria_link_type] || :inclusive)
+        )
+      )
+    end
+  end
+end

data/decidim-core/app/helpers/decidim/attachments_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Decidim
+  # A Helper to render and link to resources.
+  module AttachmentsHelper
+    # Renders a the attachments of a model that includes the
+    # HasAttachments concern.
+    #
+    # attached_to - The model to render the attachments from.
+    #
+    # Returns nothing.
+    def attachments_for(attached_to)
+      render partial: "attachments", locals: { attached_to: attached_to }
+    end
+
+    # Renders the attachment's title.
+    # Checks if the attachment's title is translated or not and use
+    # the correct render method.
+    #
+    # attachment - An Attachment object
+    #
+    # Returns String.
+    def attachment_title(attachment)
+      attachment.title.is_a?(Hash) ? translated_attribute(attachment.title) : attachment.title
+    end
+  end
+end

data/decidim-core/app/helpers/decidim/authorization_form_helper.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Decidim
+  # A heper to expose an easy way to add authorization forms in a view.
+  module AuthorizationFormHelper
+    # Creates a ew authorization form in a view, accepts the same arguments as
+    # `form_for`.
+    #
+    # record  - The record to use in the form, it shoulde be a descendant of
+    # AuthorizationHandler.
+    # options - An optional hash with options to pass wo the form builder.
+    # block   - A block with the content of the form.
+    #
+    # Returns a String.
+    def authorization_form_for(record, options = {}, &block)
+      default_options = {
+        builder: AuthorizationFormBuilder,
+        as: "authorization_handler",
+        url: authorizations_path
+      }
+
+      options = default_options.merge(options)
+      decidim_form_for(record, options, &block)
+    end
+  end
+end