decidim-core 0.0.1.alpha9 → 0.0.1

data/app/helpers/decidim/translations_helper.rb

@@ -12,5 +12,22 @@ module Decidim
     def translated_attribute(attribute)
       attribute.try(:[], I18n.locale.to_s)
     end
+
+    # Public: Creates a translation for each available language in the list
+    # given a translation key.
+    #
+    # key     - The key to translate.
+    # locales - A list of locales to scope the translations to. Picks up all the
+    #           available locales by default.
+    #
+    # Returns a Hash with the locales as keys and the translations as values.
+    def multi_translation(key, locales = I18n.available_locales)
+      locales.each_with_object({}) do |locale, result|
+        I18n.with_locale(locale) do
+          result[locale.to_sym] = I18n.t(key)
+        end
+      end
+    end
+    module_function :multi_translation
   end
 end

data/app/models/decidim/category.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+module Decidim
+  # Categories serve as a taxonomy for components to use for while in the
+  # context of a participatory process.
+  class Category < ApplicationRecord
+    belongs_to :participatory_process, foreign_key: "decidim_participatory_process_id", class_name: Decidim::ParticipatoryProcess, inverse_of: :categories
+    has_many :subcategories, foreign_key: "parent_id", class_name: Decidim::Category, dependent: :destroy, inverse_of: :parent
+    belongs_to :parent, class_name: Decidim::Category, foreign_key: "parent_id", inverse_of: :subcategories
+
+    validate :forbid_deep_nesting
+    before_save :subcategories_have_same_process
+
+    # Scope to return only the first-class categories, that is, those that are
+    # not subcategories.
+    #
+    # Returns an ActiveRecord::Relation.
+    def self.first_class
+      where(parent_id: nil)
+    end
+
+    private
+
+    def forbid_deep_nesting
+      return unless parent
+      return unless parent.parent.present?
+
+      errors.add(:parent_id, :nesting_too_deep)
+    end
+
+    def subcategories_have_same_process
+      return unless parent
+      self.participatory_process = parent.participatory_process
+    end
+  end
+end

data/app/models/decidim/component.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+module Decidim
+  # A Component represents the association between a participatory process and a
+  # Component Engine. It configures how that component should behave, its name,
+  # and other relevant fields.
+  class Component < ApplicationRecord
+    belongs_to :feature, foreign_key: "decidim_feature_id"
+
+    belongs_to :step,
+               foreign_key: "decidim_participatory_process_step_id",
+               class_name: "Decidim::ParticipatoryProcessStep"
+
+    has_one :participatory_process, through: :feature
+
+    validates :feature, :step, :manifest, presence: true
+
+    validate :manifest_belongs_to_feature
+    validate :participatory_process_is_valid
+
+    # Public: Finds the manifest this particular component is associated to.
+    #
+    # Returns a ComponentManifest.
+    def manifest
+      Decidim.find_component_manifest(manifest_name)
+    end
+
+    # Public: Assigns a manifest to this component.
+    #
+    # manifest - The ComponentManifest for this Component.
+    #
+    # Returns nothing.
+    def manifest=(manifest)
+      self.manifest_name = manifest.name
+    end
+
+    private
+
+    def manifest_belongs_to_feature
+      return if feature&.manifest&.component_manifests&.include?(manifest)
+
+      errors.add(:manifest, I18n.t("errors.messages.invalid_manifest"))
+    end
+
+    def participatory_process_is_valid
+      return if !step&.participatory_process || !feature&.participatory_process
+      return if feature.participatory_process == step.participatory_process
+
+      errors.add(:manifest, I18n.t("errors.messages.invalid_participatory_process"))
+    end
+  end
+end

data/app/models/decidim/feature.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+module Decidim
+  # A Feature represents a self-contained group of functionalities usually
+  # defined via a FeatureManifest and its Components. It's meant to be able to
+  # provide a single feature that spans over several steps, each one with its component.
+  class Feature < ApplicationRecord
+    belongs_to :participatory_process, foreign_key: "decidim_participatory_process_id"
+    has_one :organization, through: :participatory_process
+    has_many :categories, through: :participatory_process
+    has_many :scopes, through: :organization
+
+    validates :participatory_process, presence: true
+
+    # Public: Finds the manifest this feature is associated to.
+    #
+    # Returns a FeatureManifest.
+    def manifest
+      Decidim.find_feature_manifest(manifest_name)
+    end
+
+    # Public: Assigns a manifest to this feature.
+    #
+    # manifest - The FeatureManifest for this Feature.
+    #
+    # Returns nothing.
+    def manifest=(manifest)
+      self.manifest_name = manifest.name
+    end
+  end
+end

data/app/models/decidim/organization.rb

@@ -4,7 +4,26 @@ module Decidim
   # installation we can find many organizations and each of them can start
   # their own participatory processes.
   class Organization < ApplicationRecord
-    has_many :participatory_processes, foreign_key: "decidim_organization_id", class_name: Decidim::ParticipatoryProcess
+    has_many :participatory_processes, foreign_key: "decidim_organization_id", class_name: Decidim::ParticipatoryProcess, inverse_of: :organization
+    has_many :static_pages, foreign_key: "decidim_organization_id", class_name: Decidim::StaticPage, inverse_of: :organization
+    has_many :scopes, foreign_key: "decidim_organization_id", class_name: Decidim::Scope, inverse_of: :organization
+
     validates :name, :host, uniqueness: true
+
+    mount_uploader :homepage_image, Decidim::HomepageImageUploader
+    mount_uploader :logo, Decidim::OrganizationLogoUploader
+
+    def homepage_big_url
+      homepage_image.big.url
+    end
+
+    # Fetches the admins of the given organization.
+    #
+    # Returns an ActiveRecord::Relation.
+    def admins
+      @admins ||= Decidim::User
+                  .where(organization: self)
+                  .where("roles @> ?", "{admin}")
+    end
   end
 end

data/app/models/decidim/participatory_process.rb

@@ -6,14 +6,39 @@ module Decidim
   # steps that get enabled or disabled depending on which step is currently
   # active.
   class ParticipatoryProcess < ApplicationRecord
-    belongs_to :organization, foreign_key: "decidim_organization_id", class_name: Decidim::Organization
-    has_many :steps, -> { order(position: :asc) }, foreign_key: "decidim_participatory_process_id", class_name: Decidim::ParticipatoryProcessStep
-    has_one :active_step, -> { where(active: true) }, foreign_key: "decidim_participatory_process_id", class_name: Decidim::ParticipatoryProcessStep
+    belongs_to :organization,
+               foreign_key: "decidim_organization_id",
+               class_name: Decidim::Organization,
+               inverse_of: :participatory_processes
+    has_many :steps,
+             -> { order(position: :asc) },
+             foreign_key: "decidim_participatory_process_id",
+             class_name: Decidim::ParticipatoryProcessStep,
+             dependent: :destroy,
+             inverse_of: :participatory_process
+    has_one :active_step,
+            -> { where(active: true) },
+            foreign_key: "decidim_participatory_process_id",
+            class_name: Decidim::ParticipatoryProcessStep,
+            dependent: :destroy,
+            inverse_of: :participatory_process
+    has_many :attachments,
+             foreign_key: "decidim_participatory_process_id",
+             class_name: Decidim::ParticipatoryProcessAttachment,
+             dependent: :destroy,
+             inverse_of: :participatory_process
+    has_many :categories,
+             foreign_key: "decidim_participatory_process_id",
+             class_name: Decidim::Category,
+             dependent: :destroy,
+             inverse_of: :participatory_process
+
+    has_many :features, foreign_key: "decidim_participatory_process_id"
 
     attr_readonly :active_step
 
     validates :slug, presence: true
-    validates :slug, uniqueness: true
+    validates :slug, uniqueness: { scope: :organization }
 
     mount_uploader :hero_image, Decidim::HeroImageUploader
     mount_uploader :banner_image, Decidim::BannerImageUploader
@@ -38,5 +63,19 @@ module Decidim
     def published?
       published_at.present?
     end
+
+    # All the attachments that are photos for this porcess.
+    #
+    # Returns an Array<Attachment>
+    def photos
+      @photos ||= attachments.select(&:photo?)
+    end
+
+    # All the attachments that are documents for this porcess.
+    #
+    # Returns an Array<Attachment>
+    def documents
+      @documents ||= attachments.select(&:document?)
+    end
   end
 end

data/app/models/decidim/participatory_process_attachment.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+module Decidim
+  # Attachment can be any type of document or images related to a partcipatory
+  # process.
+  class ParticipatoryProcessAttachment < ApplicationRecord
+    belongs_to :participatory_process, foreign_key: "decidim_participatory_process_id", class_name: Decidim::ParticipatoryProcess, inverse_of: :attachments
+
+    validates :file, :participatory_process, :content_type, presence: true
+    validates :file, file_size: { less_than_or_equal_to: 10.megabytes }
+    mount_uploader :file, Decidim::AttachmentUploader
+
+    # Whether this attachment is a photo or not.
+    #
+    # Returns Boolean.
+    def photo?
+      @photo ||= content_type.start_with? "image"
+    end
+
+    # Whether this attachment is a document or not.
+    #
+    # Returns Boolean.
+    def document?
+      !photo?
+    end
+
+    # Which kind of file this is.
+    #
+    # Returns String.
+    def file_type
+      file.file.extension
+    end
+
+    # The URL to download the file.
+    #
+    # Returns String.
+    def url
+      file.url
+    end
+
+    # The URL to download the thumbnail of the file. Only works with images.
+    #
+    # Returns String.
+    def thumbnail_url
+      return unless photo?
+      file.thumbnail.url
+    end
+
+    # The URL to download the a big version of the file. Only works with images.
+    #
+    # Returns String.
+    def big_url
+      return unless photo?
+      file.big.url
+    end
+  end
+end

data/app/models/decidim/scope.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module Decidim
+  # Scopes are used in some entities through Decidim to help users know which is
+  # the scope of a participatory process.
+  # (i.e. does it affect the whole city or just a district?)
+  class Scope < ApplicationRecord
+    belongs_to :organization,
+               foreign_key: "decidim_organization_id",
+               class_name: Decidim::Organization,
+               inverse_of: :scopes
+
+    validates :name, presence: true, uniqueness: { scope: :organization }
+  end
+end

data/app/models/decidim/static_page.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+module Decidim
+  # A page is used to add static content to the website, it can be useful so
+  # organization can add their own terms and conditions, privacy policy or
+  # other pages they might need from an admin panel.
+  #
+  # Pages with a default slug cannot be destroyed and its slug cannot be
+  # modified.
+  class StaticPage < ApplicationRecord
+    belongs_to :organization, foreign_key: "decidim_organization_id", class_name: Decidim::Organization, inverse_of: :static_pages
+
+    validates :slug, :organization, presence: true
+    validates :slug, uniqueness: { scope: :organization }
+
+    # These pages will be created by default when registering an organization
+    # and cannot be deleted.
+    DEFAULT_PAGES = %w(faq terms-and-conditions accessibility).freeze
+
+    before_destroy :can_be_destroyed?
+    before_update :can_update_slug?
+
+    # Whether this is slug of a default page or not.
+    #
+    # slug - The String with the value of the slug.
+    #
+    # Returns Boolean.
+    def self.default?(slug)
+      DEFAULT_PAGES.include?(slug)
+    end
+
+    # Whether this is page is a default one or not.
+    #
+    # Returns Boolean.
+    def default?
+      self.class.default?(slug)
+    end
+
+    # Customize to_param so when we want to create a link to a page we use the
+    # slug instead of the id.
+    #
+    # Returns a String.
+    def to_param
+      slug
+    end
+
+    private
+
+    def can_be_destroyed?
+      throw(:abort) if default?
+    end
+
+    def can_update_slug?
+      throw(:abort) if slug_changed? && self.class.default?(slug_was)
+    end
+  end
+end

data/app/models/decidim/user.rb

@@ -16,6 +16,8 @@ module Decidim
     validates :locale, inclusion: { in: I18n.available_locales.map(&:to_s) }, allow_blank: true
     validates :tos_agreement, acceptance: true, allow_nil: false, on: :create
     validate :all_roles_are_valid
+    validates :avatar, file_size: { less_than_or_equal_to: 5.megabytes }
+    mount_uploader :avatar, Decidim::AvatarUploader
 
     # Public: Allows customizing the invitation instruction email content when
     # inviting a user.

data/app/queries/decidim/organization_participatory_processes.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module Decidim
+  # This query class returns the visible Participatory Processes given an
+  # Organization.
+  class OrganizationParticipatoryProcesses < Rectify::Query
+    def initialize(organization)
+      @organization = organization
+    end
+
+    def query
+      raise MandatoryOrganization unless @organization
+      ParticipatoryProcess.where(organization: @organization).published
+    end
+
+    class MandatoryOrganization < StandardError; end
+  end
+end

data/app/services/decidim/authorization_handler.rb

@@ -7,7 +7,7 @@ module Decidim
   # authorization will be created for the user.
   #
   # It also sets two default attributes, `user` and `handler_name`.
-  class AuthorizationHandler < Rectify::Form
+  class AuthorizationHandler < Form
     # The user that is trying to authorize, it's initialized with the
     # `current_user` from the controller.
     attribute :user, Decidim::User
@@ -86,7 +86,7 @@ module Decidim
 
       return unless Decidim.authorization_handlers.include?(handler_klass)
 
-      handler_klass.new(params || {})
+      handler_klass.from_params(params || {})
     rescue NameError
       nil
     end

data/app/types/decidim/process_step_type.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module Decidim
+  # This type represents a step on a participatory process.
+  ProcessStepType = GraphQL::ObjectType.define do
+    name "ProcessStep"
+    description "A participatory process step"
+
+    field :id, !types.ID, "The unique ID of this step."
+
+    field :process do
+      type ProcessType
+      description "The participatory process in which this step belongs to."
+      property :participatory_process
+    end
+
+    field :title, Api::TranslatedFieldType, "The title of this step"
+
+    field :shortDescription do
+      type Api::TranslatedFieldType
+      description "A short description of the step."
+      property :short_description
+    end
+  end
+end

data/app/types/decidim/process_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module Decidim
+  # This type represents a ParticipatoryProcess.
+  ProcessType = GraphQL::ObjectType.define do
+    name "Process"
+    description "A participatory process"
+
+    field :id, !types.ID, "The Process' unique ID"
+
+    field :title, Api::TranslatedFieldType, "The title of this process."
+
+    connection :steps, ProcessStepType.connection_type do
+      description "All the steps of this process."
+    end
+  end
+end