decidim-core 0.0.1.alpha9 → 0.0.1

data/app/controllers/concerns/decidim/form_factory.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  # A factory to build forms. This is done to add a context when possible, so
+  # that forms can act based on data that varies between requests. This is
+  # mostly done so that i18n form fields can be properly validated with the
+  # `current_organization` available locales, instead of doing so against all
+  # the available locales in the platform. The `current_organization` varies
+  # between requests, so the form need some way to access this data.
+  #
+  # Examples:
+  #
+  #   # in a controller, mostly in a `create` action:
+  #   form(MyFormClass).form_params(params)
+  #
+  #   # in a controller, mostly in a `new` action:
+  #   form(MyFormClass).instance
+  #
+  #   # in a controller, mostly in an `edit` action:
+  #   form(MyFormClass).form_model(@my_resource)
+  #
+  module FormFactory
+    extend ActiveSupport::Concern
+
+    included do
+      # Initializes a factory for the given Form Object class.
+      #
+      # klass - a Form object class name. Must be a constant, not a String.
+      def form(klass)
+        Class.new do
+          # Initializes the form factory object.
+          #
+          # klass - the class name of the Form object that will be initialized
+          # context - the Controller where the form is built.
+          def initialize(klass, context)
+            @klass = klass
+            @context = context
+          end
+
+          # Returns a simple instance of the form klass.
+          def instance(context = {})
+            @klass.new(context)
+          end
+
+          # Initializes a form object from a model. Delegates the functionality
+          # to the form object class method.
+          #
+          # model - the model instance from which the form object will be
+          #   initialized.
+          # context - a Hash with optional context data.
+          def from_model(model, context = {})
+            from_params(model.attributes, context)
+          end
+
+          # Initializes a form object instance from params, and it
+          # automatically adds some context. Context can be extended.
+          #
+          # params - a Hash with params. Mostly a set of params from a form.
+          # context - a Hash with optional context data.
+          def from_params(params, context = {})
+            @klass.from_params(params, context_hash.merge(context))
+          end
+
+          # Sets a base context from the current controller. Since this can be
+          # used from some controllers that do not respond to the helper
+          # methods used here, this Hash can have different keys depending on
+          # the controller that uses it.
+          def context_hash
+            {
+              current_organization: @context.try(:current_organization),
+              current_user: @context.try(:current_user)
+            }.compact
+          end
+        end.new(klass, self)
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/locale_switcher.rb

@@ -9,19 +9,19 @@ module Decidim
 
     included do
       before_action :set_locale
-      helper_method :current_locale, :available_locales
+      helper_method :current_locale, :available_locales, :default_locale
 
       # Sets the locale for the current session.
       #
       # Returns nothing.
       def set_locale
-        I18n.locale = if params["locale"] && available_locales.include?(params["locale"])
-                        params["locale"]
-                      elsif current_user && current_user.locale.present?
-                        current_user.locale
-                      else
-                        I18n.default_locale
-                      end
+        locale = if params["locale"]
+                   params["locale"]
+                 elsif current_user && current_user.locale.present?
+                   current_user.locale
+                 end
+
+        I18n.locale = available_locales.include?(locale) ? locale : default_locale
       end
 
       # Adds the current locale to all the URLs generated by url_for so users
@@ -29,7 +29,7 @@ module Decidim
       #
       # Returns a Hash.
       def default_url_options
-        return {} if current_locale == I18n.default_locale.to_s
+        return {} if current_locale == default_locale.to_s
 
         { locale: current_locale }
       end
@@ -46,7 +46,14 @@ module Decidim
       #
       # Returns an Array of Strings.
       def available_locales
-        @available_locales ||= I18n.available_locales.map(&:to_s)
+        @available_locales ||= current_organization.available_locales.map(&:to_s)
+      end
+
+      # The default locale of this organization.
+      #
+      # Returns a String with the default locale.
+      def default_locale
+        @default_locale ||= current_organization.default_locale
       end
     end
   end

data/app/controllers/concerns/decidim/needs_participatory_process.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  # This module, when injected into a controller, ensures there's a
+  # Participatory Process available and deducts it from the context.
+  module NeedsParticipatoryProcess
+    extend ActiveSupport::Concern
+
+    include NeedsOrganization
+
+    included do
+      after_action :verify_participatory_process
+      helper_method :current_participatory_process
+
+      # Public: Finds the current Participatory Process given this controller's
+      # context.
+      #
+      # Returns the current ParticipatoryProcess.
+      def current_participatory_process
+        @current_participatory_process ||=
+          current_organization.participatory_processes.find_by(id: params[:participatory_process_id])
+      end
+
+      private
+
+      def verify_participatory_process
+        raise ActionController::RoutingError, "Not Found" unless current_participatory_process
+      end
+    end
+  end
+end

data/app/controllers/decidim/application_controller.rb

@@ -7,7 +7,7 @@ module Decidim
     include NeedsAuthorization
     protect_from_forgery with: :exception, prepend: true
 
-    layout "application"
+    layout "layouts/decidim/application"
 
     def user_not_authorized_path
       decidim.root_path

data/app/controllers/decidim/devise/confirmations_controller.rb

@@ -5,7 +5,7 @@ module Decidim
     class ConfirmationsController < ::Devise::ConfirmationsController
       include Decidim::NeedsOrganization
       include Decidim::LocaleSwitcher
-      layout "application"
+      layout "layouts/decidim/application"
     end
   end
 end

data/app/controllers/decidim/devise/passwords_controller.rb

@@ -5,7 +5,7 @@ module Decidim
     class PasswordsController < ::Devise::PasswordsController
       include Decidim::NeedsOrganization
       include Decidim::LocaleSwitcher
-      layout "application"
+      layout "layouts/decidim/application"
     end
   end
 end

data/app/controllers/decidim/devise/registrations_controller.rb

@@ -6,7 +6,7 @@ module Decidim
     class RegistrationsController < ::Devise::RegistrationsController
       include Decidim::NeedsOrganization
       include Decidim::LocaleSwitcher
-      layout "application"
+      layout "layouts/decidim/application"
       before_action :configure_permitted_parameters
 
       protected

data/app/controllers/decidim/devise/sessions_controller.rb

@@ -5,15 +5,29 @@ module Decidim
     class SessionsController < ::Devise::SessionsController
       include Decidim::NeedsOrganization
       include Decidim::LocaleSwitcher
-      layout "application"
+      helper Decidim::TranslationsHelper
+
+      layout "layouts/decidim/application"
 
       def after_sign_in_path_for(user)
-        if user.is_a?(User) && user.sign_in_count == 1 && Decidim.authorization_handlers.any?
+        if !pending_redirect?(user) && first_login_and_not_authorized?(user)
           authorizations_path
         else
           super
         end
       end
+
+      # Calling the `stored_location_for` method removes the key, so in order
+      # to check if there's any pending redirect after login I need to call
+      # this method and use the value to set a pending redirect. This is the
+      # only way to do this without checking the session directly.
+      def pending_redirect?(user)
+        store_location_for(user, stored_location_for(user))
+      end
+
+      def first_login_and_not_authorized?(user)
+        user.is_a?(User) && user.sign_in_count == 1 && Decidim.authorization_handlers.any?
+      end
     end
   end
 end

data/app/controllers/decidim/pages_controller.rb

@@ -1,10 +1,24 @@
 # frozen_string_literal: true
 require_dependency "decidim/application_controller"
+require_dependency "decidim/page_finder"
 
 module Decidim
   # This controller serves static pages using HighVoltage.
   class PagesController < ApplicationController
     include HighVoltage::StaticPage
+
+    layout "layouts/decidim/application"
+
     authorize_resource :public_pages, class: false
+    delegate :page, to: :page_finder
+    helper_method :page, :participatory_processes
+
+    def page_finder
+      @page_finder ||= Decidim::PageFinder.new(params[:id], current_organization)
+    end
+
+    def participatory_processes
+      @participatory_processes ||= current_organization.participatory_processes.includes(:active_step).published.promoted
+    end
   end
 end

data/app/controllers/decidim/participatory_processes_controller.rb

@@ -6,6 +6,9 @@ module Decidim
   # public layout.
   class ParticipatoryProcessesController < ApplicationController
     helper_method :participatory_processes, :participatory_process, :promoted_processes
+    helper_method :current_participatory_process
+
+    layout "layouts/decidim/participatory_process", only: [:show]
 
     def index
       authorize! :read, ParticipatoryProcess
@@ -17,6 +20,10 @@ module Decidim
 
     private
 
+    def current_participatory_process
+      participatory_process
+    end
+
     def participatory_process
       @participatory_process ||= ParticipatoryProcess.find(params[:id])
     end

data/app/forms/decidim/form.rb

@@ -0,0 +1,15 @@
+# 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
+    attr_reader :current_organization, :current_user, :current_feature
+
+    def initialize(attributes = {})
+      @current_organization = attributes.delete("current_organization") || attributes.delete(:current_organization)
+      @current_user = attributes.delete("current_user") || attributes.delete(:current_user)
+      @current_feature = attributes.delete("current_feature") || attributes.delete(:current_feature)
+      super
+    end
+  end
+end

data/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/app/helpers/decidim/application_helper.rb

@@ -1,9 +1,24 @@
+# encoding: utf-8
 # frozen_string_literal: true
 module Decidim
   # Main module to add application-wide helpers.
   module ApplicationHelper
-    def link_to_organization(organization)
-      link_to(organization.name, root_url(host: organization.host))
+    # 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
+
+      Truncato.truncate(text, options)
     end
   end
 end

data/app/helpers/decidim/layout_helper.rb

@@ -3,7 +3,8 @@ module Decidim
   # View helpers related to the layout.
   module LayoutHelper
     def decidim_page_title
-      current_organization.name
+      title = content_for(:title)
+      title ? "#{title} - #{current_organization.name}" : current_organization.name
     end
 
     # Outputs an SVG-based icon.
@@ -19,6 +20,12 @@ module Decidim
     #
     # Returns a String.
     def icon(name, options = {})
+      # Ugly hack to work around the issue of phantomjs not sending js events
+      # when clicking on a SVG element.
+      if Rails.env.test?
+        return content_tag(:span, "?", class: "icon icon--#{name}")
+      end
+
       html_properties = {}
 
       html_properties["width"] = options[:width]

data/app/helpers/decidim/localized_locales_helper.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+module Decidim
+  # A helper that converts an array of locale IDs (two-letter identifiers, e.g.
+  # `"en"`) to an array of Objects that have both the ID and their name in
+  # their own language (e.g., `"English"`).
+  #
+  # This is intended to be used in forms, when selecting the default locale
+  # form a given list, or when creating a list of radio buttons, for example.
+  #
+  # Examples:
+  #
+  #   <%= form.collection_select :default_locale, localized_locales(current_organization.available_locales), :id, :name %>
+  #
+  #   <% localized_locales(current_organization.available_locales).each do |locale| %>
+  #     <p><%= locale.name %></p>
+  #   <% end %>
+  #
+  module LocalizedLocalesHelper
+    # Converts a given array of strings to an array of Objects representing
+    # locales.
+    #
+    # collection - an Array of Strings. By default it uses all the available
+    #   locales in Decidim, but you can passa nother collection of locales (for
+    #   example, the available locales for an organization)
+    def localized_locales(collection = Decidim.available_locales)
+      klass = Class.new do
+        def initialize(locale)
+          @locale = locale
+        end
+
+        def id
+          @locale.to_s
+        end
+
+        def name
+          I18n.t(id, scope: "locales")
+        end
+      end
+
+      collection.map { |locale| klass.new(locale) }
+    end
+  end
+end

data/app/helpers/decidim/participatory_process_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module Decidim
+  # Helpers related to the Participatory Process layout.
+  module ParticipatoryProcessHelper
+    # Public: Returns the dates for a step in a readable format like
+    # "2016-01-01 - 2016-02-05".
+    #
+    # participatory_process_step - The step to format to
+    #
+    # Returns a String with the formatted dates.
+    def participatory_process_step_dates(participatory_process_step)
+      dates = [participatory_process_step.start_date, participatory_process_step.end_date]
+      dates.map { |date| date ? localize(date.to_date, format: :default) : "?" }.join(" - ")
+    end
+  end
+end