decidim 0.4.4 → 0.5.0

data/decidim-core/decidim-core.gemspec

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path("lib", __dir__)
+
+# Maintain your gem's version:
+require "decidim/core/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name = "decidim-core"
+  s.version = Decidim.version
+  s.authors = ["Josep Jaume Rey Peroy", "Marc Riera Casals", "Oriol Gual Oliva"]
+  s.email = ["josepjaume@gmail.com", "mrc2407@gmail.com", "oriolgual@gmail.com"]
+  s.homepage = ""
+  s.summary = "The core of the Decidim framework."
+  s.description = "Adds core features so other engines can hook into the framework."
+  s.license = "AGPLv3"
+
+  s.files = Dir["{app,config,db,lib,vendor}/**/*", "Rakefile", "README.md"]
+
+  s.add_dependency "rails", *Decidim.rails_version
+  s.add_dependency "rails-i18n"
+  s.add_dependency "devise", "~> 4.3"
+  s.add_dependency "devise-i18n", "~> 1.1.0"
+  s.add_dependency "invisible_captcha", "~> 0.9.2"
+  s.add_dependency "rectify", "~> 0.9.1"
+  s.add_dependency "sassc-rails", "~> 1.3.0"
+  s.add_dependency "foundation-rails", "~> 6.3.1.0"
+  s.add_dependency "autoprefixer-rails", "~> 7.1.1"
+  s.add_dependency "jquery-rails", "~> 4.3.1"
+  s.add_dependency "carrierwave", "~> 1.1.0"
+  s.add_dependency "foundation_rails_helper", "~> 3.0.0.rc"
+  s.add_dependency "active_link_to", "~> 1.0.4"
+  s.add_dependency "pg", "~> 0.21.0"
+  s.add_dependency "redis", "~> 3.3.3"
+  s.add_dependency "high_voltage", "~> 3.0.0"
+  s.add_dependency "date_validator", "~> 0.9.0"
+  s.add_dependency "sprockets-es6", "~> 0.9.2"
+  s.add_dependency "cancancan", "~> 2.0.0"
+  s.add_dependency "truncato", "~> 0.7.9"
+  s.add_dependency "mini_magick", "~> 4.7.0"
+  s.add_dependency "file_validators", "~> 2.1.0"
+  s.add_dependency "omniauth", "~> 1.6.1"
+  s.add_dependency "omniauth-facebook", "~> 4.0.0"
+  s.add_dependency "omniauth-twitter", "~> 1.4.0"
+  s.add_dependency "omniauth-google-oauth2", "~> 0.5.0"
+  s.add_dependency "wisper", "~> 2.0.0"
+  s.add_dependency "premailer-rails", "~> 1.9.5"
+  s.add_dependency "nokogiri", "~> 1.7.1"
+  s.add_dependency "geocoder", "~> 1.4.2"
+  s.add_dependency "rubyzip", "1.2.1"
+  s.add_dependency "select2-rails", "~> 4.0.3"
+
+  s.add_dependency "decidim-api", Decidim.version
+
+  s.add_development_dependency "decidim-dev", Decidim.version
+  s.add_development_dependency "decidim-proposals", Decidim.version
+  s.add_development_dependency "decidim-meetings", Decidim.version
+  s.add_development_dependency "decidim-results", Decidim.version
+end

data/decidim-core/lib/decidim/abilities.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Abilities
+    autoload :ParticipatoryProcessRoleAbility, "decidim/abilities/participatory_process_role_ability"
+  end
+end

data/decidim-core/lib/decidim/abilities/participatory_process_role_ability.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Abilities
+    # Base class used for any participatory process role ability.
+    class ParticipatoryProcessRoleAbility
+      include CanCan::Ability
+
+      def initialize(user, context)
+        @user = user
+        @context = context
+
+        # Define abilities if the user is not an admin and has at least one process to manage.
+        if not_admin? && has_manageable_processes?
+          define_abilities
+
+          if current_participatory_process && can_manage_process?(current_participatory_process)
+            define_participatory_process_abilities
+          end
+        end
+      end
+
+      # Grant access to admin panel by default.
+      def define_abilities
+        can :read, :admin_dashboard
+      end
+
+      def define_participatory_process_abilities; end
+
+      # Abstract: A subclass must define this method returning a valid role.
+      # See ParticipatoryProcessUserRoles::ROLES for more information.
+      def role
+        raise "Needs implementation"
+      end
+
+      # Whether the user is an admin or not.
+      def not_admin?
+        @user && !@user.admin?
+      end
+
+      # Returns a collection of Participatory processes where the given user has the
+      # specific role privilege.
+      def participatory_processes_with_role_privileges
+        @participatory_processes ||= Decidim::ParticipatoryProcessesWithUserRole.for(@user, role)
+      end
+
+      # Whether the user has at least one process to manage or not.
+      def has_manageable_processes?
+        participatory_processes_with_role_privileges.any?
+      end
+
+      # Whether the user can manage the given process or not.
+      def can_manage_process?(process)
+        participatory_processes_with_role_privileges.include? process
+      end
+
+      def current_participatory_process
+        @current_participatory_process ||= @context[:current_participatory_process]
+      end
+    end
+  end
+end

data/decidim-core/lib/decidim/attributes.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Attributes
+    autoload :TimeWithZone, "decidim/attributes/time_with_zone"
+  end
+end

data/decidim-core/lib/decidim/attributes/time_with_zone.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Attributes
+    # Custom Virtus value to parse a String representing a Time using
+    # the app TimeZone.
+    class TimeWithZone < Virtus::Attribute
+      def coerce(value)
+        return value unless value.is_a?(String)
+        Time.zone.parse(value)
+      end
+    end
+  end
+end

data/decidim-core/lib/decidim/authorable.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This concern contains the logic related to authorship
+  module Authorable
+    extend ActiveSupport::Concern
+
+    included do
+      belongs_to :author, foreign_key: "decidim_author_id", class_name: "Decidim::User", optional: true
+      belongs_to :user_group, foreign_key: "decidim_user_group_id", class_name: "Decidim::UserGroup", optional: true
+
+      validate :verified_user_group, :user_group_membership
+      validate :author_belongs_to_organization
+
+      private
+
+      def verified_user_group
+        return unless user_group
+        errors.add :user_group, :invalid unless user_group.verified?
+      end
+
+      def user_group_membership
+        return unless user_group
+        errors.add :user_group, :invalid unless user_group.users.include? author
+      end
+
+      def author_belongs_to_organization
+        return if !author || !organization
+        errors.add(:author, :invalid) unless author.organization == organization
+      end
+    end
+  end
+end

data/decidim-core/lib/decidim/authorization_form_builder.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "decidim/form_builder"
+
+module Decidim
+  # A customf orm builder to render AuthorizationHandler forms.
+  class AuthorizationFormBuilder < Decidim::FormBuilder
+    # Renders all form attributes defined by the handler.
+    #
+    # Returns a String.
+    def all_fields
+      fields = public_attributes.map do |name, type|
+        @template.content_tag(:div, input_field(name, type), class: "field")
+      end
+
+      safe_join(fields)
+    end
+
+    # Renders a single attribute from the form handlers.
+    #
+    # name - The String name of the attribute.
+    # options - An optional Hash, accepted options are:
+    #           :as - A String name with the type the field to render
+    #           :input - An optional Hash to pass to the field method.
+    #
+    # Returns a String.
+    def input(name, options = {})
+      if options[:as]
+        send(options[:as].to_s, name, options[:input] || {})
+      else
+        type = find_input_type(name.to_s)
+        input_field(name, type)
+      end
+    end
+
+    private
+
+    def input_field(name, type)
+      return hidden_field(name) if name.to_s == "handler_name"
+
+      case type.name
+      when "Date"
+        date_field name
+      else
+        text_field name
+      end
+    end
+
+    def find_input_type(name)
+      found_attribute = object.class.attribute_set.detect do |attribute|
+        attribute.name.to_s == name
+      end
+
+      raise "Could not find attribute #{name} in #{object.class.name}" unless found_attribute
+
+      found_attribute.type.primitive
+    end
+
+    def public_attributes
+      form_attributes.inject({}) do |all, attribute|
+        all.update(attribute.name => attribute.type.primitive)
+      end
+    end
+
+    def form_attributes
+      object.class.attribute_set.select do |attribute|
+        object.form_attributes.include?(attribute.name)
+      end
+    end
+  end
+end

data/decidim-core/lib/decidim/core.rb

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+
+require "decidim/core/engine"
+require "decidim/core/version"
+require "decidim/core/api"
+
+# Decidim configuration.
+module Decidim
+  autoload :TranslatableAttributes, "decidim/translatable_attributes"
+  autoload :FormBuilder, "decidim/form_builder"
+  autoload :AuthorizationFormBuilder, "decidim/authorization_form_builder"
+  autoload :FilterFormBuilder, "decidim/filter_form_builder"
+  autoload :DeviseFailureApp, "decidim/devise_failure_app"
+  autoload :FeatureManifest, "decidim/feature_manifest"
+  autoload :ResourceManifest, "decidim/resource_manifest"
+  autoload :Resourceable, "decidim/resourceable"
+  autoload :Reportable, "decidim/reportable"
+  autoload :Authorable, "decidim/authorable"
+  autoload :Notifiable, "decidim/notifiable"
+  autoload :Publicable, "decidim/publicable"
+  autoload :Scopable, "decidim/scopable"
+  autoload :Features, "decidim/features"
+  autoload :HasAttachments, "decidim/has_attachments"
+  autoload :FeatureValidator, "decidim/feature_validator"
+  autoload :HasSettings, "decidim/has_settings"
+  autoload :HasFeature, "decidim/has_feature"
+  autoload :HasScope, "decidim/has_scope"
+  autoload :HasCategory, "decidim/has_category"
+  autoload :HasReference, "decidim/has_reference"
+  autoload :Attributes, "decidim/attributes"
+  autoload :StatsRegistry, "decidim/stats_registry"
+  autoload :Exporters, "decidim/exporters"
+  autoload :FileZipper, "decidim/file_zipper"
+  autoload :Menu, "decidim/menu"
+  autoload :MenuItem, "decidim/menu_item"
+  autoload :MenuRegistry, "decidim/menu_registry"
+  autoload :ManifestRegistry, "decidim/manifest_registry"
+  autoload :Abilities, "decidim/abilities"
+
+  include ActiveSupport::Configurable
+
+  # Loads seeds from all engines.
+  def self.seed!
+    # Faker needs to have the `:en` locale in order to work properly, so we
+    # must enforce it during the seeds.
+    original_locale = I18n.available_locales
+    I18n.available_locales = original_locale + [:en] unless original_locale.include?(:en)
+
+    Rails.application.railties.to_a.uniq.each do |railtie|
+      next unless railtie.respond_to?(:load_seed) && railtie.class.name.include?("Decidim::")
+
+      railtie.load_seed
+    end
+
+    Decidim::ParticipatoryProcess.find_each do |process|
+      Decidim.feature_manifests.each do |feature|
+        feature.seed!(process)
+      end
+    end
+
+    I18n.available_locales = original_locale
+  end
+
+  # Exposes a configuration option: The application name String.
+  config_accessor :application_name
+
+  # Exposes a configuration option: The email String to use as sender in all
+  # the mails.
+  config_accessor :mailer_sender
+
+  # Exposes a configuration option: an Array of `cancancan`'s Ability classes
+  # that will be automatically included to the base `Decidim::Abilities::BaseAbility`
+  # class.
+  config_accessor :abilities do
+    []
+  end
+
+  # Exposes a configuration option: an Array of `cancancan`'s Ability classes
+  # that will be automatically included to the `Decidim::Admin::Abilities::BaseAbility`
+  # class.
+  config_accessor :admin_abilities do
+    []
+  end
+
+  # Exposes a configuration option: an Array of classes that can be used as
+  # AuthorizaionHandlers so users can be verified against different systems.
+  config_accessor :authorization_handlers do
+    []
+  end
+
+  # Exposes a configuration option: The application available locales.
+  config_accessor :available_locales do
+    %w(en ca es eu it fi fr nl)
+  end
+
+  # Exposes a configuration option: The application default locale.
+  config_accessor :default_locale do
+    :en
+  end
+
+  # Exposes a configuration option: an object to configure geocoder
+  config_accessor :geocoder
+
+  # Exposes a configuration option: a custom method to generate references
+  # Default: Calculates a unique reference for the model in
+  # the following format:
+  #
+  # "BCN-DPP-2017-02-6589" which in this example translates to:
+  #
+  # BCN: A setting configured at the organization to be prepended to each reference.
+  # PROP: Unique name identifier for a resource: Decidim::Proposals::Proposal (MEET for meetings or PROJ for projects).
+  # 2017-02: Year-Month of the resource creation date
+  # 6589: ID of the resource
+  config_accessor :resource_reference_generator do
+    lambda do |resource, feature|
+      ref = feature.participatory_process.organization.reference_prefix
+      class_identifier = resource.class.name.demodulize[0..3].upcase
+      year_month = (resource.created_at || Time.current).strftime("%Y-%m")
+
+      [ref, class_identifier, year_month, resource.id].join("-")
+    end
+  end
+
+  # Exposes a configuration option: the currency unit
+  config_accessor :currency_unit do
+    "€"
+  end
+
+  # Exposes a configuration option: The maximum file size of an attachment.
+  config_accessor :maximum_attachment_size do
+    10.megabytes
+  end
+
+  # The number of reports which an object can receive before hiding it
+  config_accessor :max_reports_before_hiding do
+    3
+  end
+
+  # A base path for the uploads. If set, make sure it ends in a slash.
+  # Uploads will be set to `<base_path>/uploads/`. This can be useful if you
+  # want to use the same uploads place for both staging and production
+  # environments, but in different folders.
+  config_accessor :base_uploads_path
+
+  # Public: Registers a feature, usually held in an external library or in a
+  # separate folder in the main repository. Exposes a DSL defined by
+  # `Decidim::FeatureManifest`.
+  #
+  # Feature manifests are held in a global registry and are used in all kinds of
+  # places to figure out what new components or functionalities the feature provides.
+  #
+  # name - A Symbol with the feature's unique name.
+  #
+  # Returns nothing.
+  def self.register_feature(name, &block)
+    feature_registry.register(name, &block)
+  end
+
+  # Public: Finds all registered feature manifest's via the `register_feature`
+  # method.
+  #
+  # Returns an Array[FeatureManifest].
+  def self.feature_manifests
+    feature_registry.manifests
+  end
+
+  # Public: Finds a feature manifest by the feature's name.
+  #
+  # name - The name of the FeatureManifest to find.
+  #
+  # Returns a FeatureManifest if found, nil otherwise.
+  def self.find_feature_manifest(name)
+    feature_registry.find(name.to_sym)
+  end
+
+  # Public: Finds a resource manifest by the resource's name.
+  #
+  # resource_name_or_class - The String of the ResourceManifest name or the class of
+  # the ResourceManifest model_class to find.
+  #
+  # Returns a ResourceManifest if found, nil otherwise.
+  def self.find_resource_manifest(resource_name_or_klass)
+    feature_registry.find_resource_manifest(resource_name_or_klass)
+  end
+
+  # Public: Stores the registry of features
+  def self.feature_registry
+    @feature_registry ||= ManifestRegistry.new(:features)
+  end
+
+  # Public: Stores an instance of StatsRegistry
+  def self.stats
+    @stats ||= StatsRegistry.new
+  end
+
+  # Public: Registers configuration for a new or existing menu
+  #
+  # name   - A string or symbol with the name of the menu
+  # &block - A block using the DSL defined in `Decidim::MenuItem`
+  #
+  def self.menu(name, &block)
+    MenuRegistry.register(name.to_sym, &block)
+  end
+end