decidim-core 0.0.3 → 0.0.5

data/lib/decidim/attributes.rb

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

data/lib/decidim/attributes/time_with_zone.rb

@@ -0,0 +1,13 @@
+# 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/lib/decidim/authorable.rb

@@ -5,8 +5,8 @@ module Decidim
     extend ActiveSupport::Concern
 
     included do
-      belongs_to :author, foreign_key: "decidim_author_id", class_name: Decidim::User
-      belongs_to :user_group, foreign_key: "decidim_user_group_id", class_name: Decidim::UserGroup
+      belongs_to :author, foreign_key: "decidim_author_id", class_name: "Decidim::User"
+      belongs_to :user_group, foreign_key: "decidim_user_group_id", class_name: "Decidim::UserGroup"
 
       validate :verified_user_group, :user_group_membership
       validate :author_belongs_to_organization

data/lib/decidim/core.rb

@@ -1,6 +1,8 @@
+# -*- coding: utf-8 -*-
 # frozen_string_literal: true
 require "decidim/core/engine"
 require "decidim/core/version"
+require "decidim/core/api"
 
 # Decidim configuration.
 module Decidim
@@ -15,9 +17,11 @@ module Decidim
   autoload :Authorable, "decidim/authorable"
   autoload :Features, "decidim/features"
   autoload :HasAttachments, "decidim/has_attachments"
+  autoload :FeatureValidator, "decidim/feature_validator"
   autoload :HasFeature, "decidim/has_feature"
   autoload :HasScope, "decidim/has_scope"
   autoload :HasCategory, "decidim/has_category"
+  autoload :Attributes, "decidim/attributes"
 
   include ActiveSupport::Configurable
 
@@ -58,6 +62,13 @@ module Decidim
     []
   end
 
+  # Exposes a configuration option: an Array of `cancancan`'s Ability classes
+  # that will be automatically included to the `Decidim::Admin::Abilities::Base`
+  # 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

data/lib/decidim/core/api.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module Decidim
+  autoload :AuthorInterface, "decidim/core/api/author_interface"
+  autoload :TranslatedFieldType, "decidim/core/api/translated_field_type"
+  autoload :LocalizedStringType, "decidim/core/api/localized_string_type"
+  autoload :ProcessStepType, "decidim/core/api/process_step_type"
+  autoload :ProcessType, "decidim/core/api/process_type"
+  autoload :SessionType, "decidim/core/api/session_type"
+  autoload :UserGroupType, "decidim/core/api/user_group_type"
+  autoload :UserType, "decidim/core/api/user_type"
+end

data/lib/decidim/core/api/author_interface.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module Decidim
+  # This interface represents an author who owns a resource.
+  AuthorInterface = GraphQL::InterfaceType.define do
+    name "Author"
+    description "An author"
+
+    field :name, !types.String, "The author's name"
+    field :avatarUrl, !types.String, "The author's avatar url"
+  end
+end

data/lib/decidim/core/api/localized_string_type.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module Decidim
+  # This type represents a localized string in a single language.
+  LocalizedStringType = GraphQL::ObjectType.define do
+    name "LocalizedString"
+    description "Represents a particular translation of a LocalizedStringType"
+
+    field :locale, !types.String, "The standard locale of this translation."
+    field :text, types.String, "The content of this translation."
+  end
+end

data/{app/types/decidim → lib/decidim/core/api}/process_step_type.rb

@@ -13,10 +13,10 @@ module Decidim
       property :participatory_process
     end
 
-    field :title, Api::TranslatedFieldType, "The title of this step"
+    field :title, TranslatedFieldType, "The title of this step"
 
     field :shortDescription do
-      type Api::TranslatedFieldType
+      type TranslatedFieldType
       description "A short description of the step."
       property :short_description
     end

data/{app/types/decidim → lib/decidim/core/api}/process_type.rb

@@ -7,7 +7,7 @@ module Decidim
 
     field :id, !types.ID, "The Process' unique ID"
 
-    field :title, Api::TranslatedFieldType, "The title of this process."
+    field :title, TranslatedFieldType, "The title of this process."
 
     connection :steps, ProcessStepType.connection_type do
       description "All the steps of this process."

data/lib/decidim/core/api/translated_field_type.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+module Decidim
+  # This type represents a translated field in multiple languages.
+  TranslatedFieldType = GraphQL::ObjectType.define do
+    name "TranslatedField"
+    description "A translated field"
+
+    field :locales do
+      type types[types.String]
+      description "Lists all the locales in which this translation is available"
+      resolve ->(obj, _args, _ctx) { obj.keys }
+    end
+
+    field :translations do
+      type !types[LocalizedStringType]
+      description "All the localized strings for this translation."
+
+      argument :locales do
+        type types[types.String]
+        description "A list of locales to scope the translations to."
+      end
+
+      resolve ->(obj, args, _ctx) {
+        translations = obj.stringify_keys
+        translations = translations.slice(*args["locales"]) if args["locales"]
+
+        translations.map { |locale, text| OpenStruct.new(locale: locale, text: text) }
+      }
+    end
+
+    field :translation do
+      type types.String
+      description "Returns a single translation given a locale."
+      argument :locale, !types.String, "A locale to search for"
+
+      resolve ->(obj, args, _ctx) {
+        translations = obj.stringify_keys
+        translations[args["locale"]]
+      }
+    end
+  end
+end

data/{app/types/decidim → lib/decidim/core/api}/user_group_type.rb

@@ -6,7 +6,7 @@ module Decidim
     description "A user group"
 
     interfaces [
-      Decidim::Api::AuthorInterface
+      Decidim::AuthorInterface
     ]
 
     field :id, !types.ID, "The user group's id"

data/{app/types/decidim → lib/decidim/core/api}/user_type.rb

@@ -6,7 +6,7 @@ module Decidim
     description "A user"
 
     interfaces [
-      Decidim::Api::AuthorInterface
+      Decidim::AuthorInterface
     ]
 
     field :name, !types.String, "The user's name"

data/lib/decidim/core/engine.rb

@@ -14,7 +14,6 @@ require "foundation-rails"
 require "foundation_rails_helper"
 require "active_link_to"
 require "rectify"
-require "roadie-rails"
 require "carrierwave"
 require "high_voltage"
 require "rails-i18n"
@@ -27,6 +26,9 @@ require "omniauth"
 require "omniauth-facebook"
 require "omniauth-twitter"
 require "omniauth-google-oauth2"
+require "invisible_captcha"
+require "premailer/rails"
+require "nokogiri"
 
 require "decidim/api"
 
@@ -85,6 +87,10 @@ module Decidim
       initializer "decidim.query_extensions" do
         QueryExtensions.extend!(Decidim::Api::QueryType)
       end
+
+      initializer "decidim.i18n_exceptions" do
+        ActionView::Base.raise_on_missing_translations = true unless Rails.env.production?
+      end
     end
   end
 end

data/lib/decidim/core/test.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require "decidim/core/test/shared_examples/authorable"
+require "decidim/core/test/shared_examples/localised_email"
 require "decidim/core/test/shared_examples/has_attachments"
 require "decidim/core/test/shared_examples/has_feature"
 require "decidim/core/test/shared_examples/has_scope"

data/lib/decidim/core/test/factories.rb

@@ -30,15 +30,22 @@ FactoryGirl.define do
   end
 
   factory :organization, class: Decidim::Organization do
-    name { Faker::Company.name }
+    name { Faker::Company.unique.name }
     twitter_handler { Faker::Hipster.word }
+    facebook_handler { Faker::Hipster.word }
+    instagram_handler { Faker::Hipster.word }
+    youtube_handler { Faker::Hipster.word }
+    github_handler { Faker::Hipster.word }
     sequence(:host) { |n| "#{n}.lvh.me" }
     description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(2) } }
     welcome_text { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(2) } }
     homepage_image { test_file("city.jpeg", "image/jpeg") }
     favicon { test_file("icon.png", "image/png") }
-    default_locale I18n.default_locale
-    available_locales Decidim.available_locales
+    default_locale { I18n.default_locale }
+    available_locales { Decidim.available_locales }
+    official_img_header { test_file("avatar.jpg", "image/jpeg") }
+    official_img_footer { test_file("avatar.jpg", "image/jpeg") }
+    official_url { Faker::Internet.url }
   end
 
   factory :participatory_process, class: Decidim::ParticipatoryProcess do
@@ -51,11 +58,13 @@ FactoryGirl.define do
     banner_image { test_file("city2.jpeg", "image/jpeg") }
     published_at { Time.current }
     organization
-    scope  { Decidim::Faker::Localized.word }
-    domain { Decidim::Faker::Localized.word }
-    developer_group { Faker::Company.name }
+    scope { Decidim::Faker::Localized.word }
+    developer_group { Decidim::Faker::Localized.sentence(1) }
+    local_area { Decidim::Faker::Localized.sentence(2) }
+    target { Decidim::Faker::Localized.sentence(3) }
+    participatory_scope { Decidim::Faker::Localized.sentence(1) }
+    participatory_structure { Decidim::Faker::Localized.sentence(2) }
     end_date 2.month.from_now.at_midnight
-
     trait :promoted do
       promoted true
     end
@@ -100,6 +109,8 @@ FactoryGirl.define do
     locale                { organization.default_locale }
     tos_agreement         "1"
     avatar                { test_file("avatar.jpg", "image/jpeg") }
+    comments_notifications true
+    replies_notifications true
 
     trait :confirmed do
       confirmed_at { Time.current }
@@ -116,6 +127,10 @@ FactoryGirl.define do
     trait :official do
       roles ["official"]
     end
+
+    trait :collaborator do
+      roles ["collaborator"]
+    end
   end
 
   factory :user_group, class: Decidim::UserGroup do
@@ -184,6 +199,15 @@ FactoryGirl.define do
     name { Decidim::Faker::Localized.sentence(3) }
     participatory_process
     manifest_name "dummy"
+    published_at { Time.now }
+
+    trait :unpublished do
+      published_at { nil }
+    end
+
+    trait :published do
+      published_at { Time.current }
+    end
   end
 
   factory :scope, class: Decidim::Scope do
@@ -193,7 +217,8 @@ FactoryGirl.define do
 
   factory :dummy_resource, class: Decidim::DummyResource do
     title { generate(:name) }
-    feature
+    feature { create(:feature, manifest_name: "dummy") }
+    author { create(:user, :confirmed, organization: feature.organization) }
   end
 
   factory :resource_link, class: Decidim::ResourceLink do
@@ -201,6 +226,14 @@ FactoryGirl.define do
     to { build(:dummy_resource) }
     from { build(:dummy_resource, feature: to.feature) }
   end
+
+  factory :newsletter, class: Decidim::Newsletter do
+    author { build(:user, :confirmed, organization: organization) }
+    organization
+
+    subject { Decidim::Faker::Localized.sentence(3) }
+    body { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(4) } }
+  end
 end
 
 def test_file(filename, content_type)

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require "spec_helper"
+
+shared_examples "localised email" do
+  let(:user) { build(:user, locale: locale) }
+
+  context "when the user has a custom locale" do
+    let(:locale) { "ca" }
+
+    it "uses the user's locale" do
+      expect(mail.subject).to eq(subject)
+      expect(mail.body.encoded).to match(body)
+    end
+  end
+
+  context "otherwise" do
+    let(:locale) { nil }
+
+    it "uses the default locale" do
+      expect(mail.subject).to eq(default_subject)
+      expect(mail.body.encoded).to match(default_body)
+    end
+  end
+end

data/lib/decidim/core/version.rb

@@ -2,7 +2,7 @@
 # This holds Decidim's version and the Rails version on which it depends.
 module Decidim
   def self.version
-    "0.0.3"
+    "0.0.5"
   end
 
   def self.rails_version

data/lib/decidim/feature_manifest.rb

@@ -26,6 +26,17 @@ module Decidim
     # engine's assets path.
     attribute :icon, String
 
+    # Actions are used to validate permissions of a feature against particular
+    # authorizations or potentially other authorization rules.
+    #
+    # An example would be `vote` on participatory processes, or `create_meeting`
+    # on meetings.
+    #
+    # A Feature can expose as many actions as it wants and the admin panel will
+    # generate a UI to handle them. There's a set of controller helpers available
+    # as well that allows checking for those permissions.
+    attribute :actions, Array[String]
+
     validates :name, presence: true
 
     # Public: Registers a hook to this manifest. Hooks get fired when some

data/{app/validators → lib/decidim}/feature_validator.rb

@@ -16,8 +16,6 @@ class FeatureValidator < ActiveModel::EachValidator
       return
     end
 
-    manifest_name = options[:manifest].respond_to?(:call) ? options[:manifest].call : options[:manifest].to_s
-
-    record.errors[attribute] << :invalid if feature.manifest_name.to_s != manifest_name
+    record.errors[attribute] << :invalid if feature.manifest_name.to_s != options[:manifest].to_s
   end
 end

data/lib/decidim/features/base_controller.rb

@@ -9,9 +9,13 @@ module Decidim
       layout "layouts/decidim/participatory_process"
       include NeedsParticipatoryProcess
       include FeatureSettings
+      include ActionAuthorization
+
       helper Decidim::TranslationsHelper
       helper Decidim::ParticipatoryProcessHelper
       helper Decidim::ResourceHelper
+      helper Decidim::ActionAuthorizationHelper
+      helper Decidim::MetaTagsHelper
 
       helper_method :current_feature,
                     :current_manifest
@@ -20,6 +24,7 @@ module Decidim
 
       before_action do
         authorize! :read, current_participatory_process
+        authorize! :read, current_feature
       end
 
       def current_feature
@@ -27,7 +32,7 @@ module Decidim
       end
 
       def current_manifest
-        current_feature.manifest
+        @current_manifest ||= current_feature.manifest
       end
 
       def current_participatory_process

data/lib/decidim/form_builder.rb

@@ -7,6 +7,23 @@ module Decidim
   class FormBuilder < FoundationRailsHelper::FormBuilder
     include ActionView::Context
 
+    # Public: generates a check boxes input from a collection and adds help
+    # text and errors.
+    #
+    # attribute - the name of the field
+    # collection - the collection from which we will render the check boxes
+    # value_attribute - a Symbol or a Proc defining how to find the value
+    #   attribute
+    # text_attribute - a Symbol or a Proc defining how to find the text
+    #   attribute
+    # options - a Hash with options
+    # html_options - a Hash with options
+    #
+    # Renders a collection of check boxes.
+    def collection_check_boxes(attribute, collection, value_attribute, text_attribute, options = {}, html_options = {})
+      super + error_and_help_text(attribute, options)
+    end
+
     # Public: Generates an form field for each locale.
     #
     # type - The form field's type, like `text_area` or `text_input`
@@ -30,7 +47,7 @@ module Decidim
         tabs_panels = content_tag(:ul, class: "tabs", id: "#{name}-tabs", data: { tabs: true }) do
           locales.each_with_index.inject("".html_safe) do |string, (locale, index)|
             string + content_tag(:li, class: tab_element_class_for("title", index)) do
-              title = I18n.t(locale, scope: "locales")
+              title = I18n.with_locale(locale) { I18n.t("name", scope: "locale") }
               element_class = ""
               element_class += "alert" if error?(name_with_locale(name, locale))
               content_tag(:a, title, href: "##{name}-panel-#{index}", class: element_class)
@@ -103,8 +120,156 @@ module Decidim
       select(name, @template.options_for_select(categories, selected: selected, disabled: disabled), options)
     end
 
+    # Public: Override so checkboxes are rendered before the label.
+    def check_box(attribute, options = {}, checked_value = "1", unchecked_value = "0")
+      custom_label(attribute, options[:label], options[:label_options], true) do
+        options.delete(:label)
+        options.delete(:label_options)
+        @template.check_box(@object_name, attribute, objectify_options(options), checked_value, unchecked_value)
+      end + error_and_help_text(attribute, options)
+    end
+
     private
 
+    # Private: Override from FoundationRailsHelper in order to render
+    # inputs inside the label and to automatically inject validations
+    # from the object.
+    #
+    # attribute    - The String name of the attribute to buidl the field.
+    # options      - A Hash with options to build the field.
+    # html_options - An optional Hash with options to pass to the html element.
+    #
+    # Returns a String
+    def field(attribute, options, html_options = nil, &block)
+      label = options.delete(:label)
+      label_options = options.delete(:label_options)
+      custom_label(attribute, label, label_options) do
+        field_with_validations(attribute, options, html_options, &block)
+      end
+    end
+
+    # Private: Builds a form field and detects validations from
+    # the form object.
+    #
+    # attribute    - The String name of the attribute to build the field.
+    # options      - A Hash with options to build the field.
+    # html_options - An optional Hash with options to pass to the html element.
+    #
+    # Returns a String.
+    def field_with_validations(attribute, options, html_options)
+      class_options = html_options || options
+
+      if error?(attribute)
+        class_options[:class] = class_options[:class].to_s
+        class_options[:class] += " is-invalid-input"
+      end
+
+      help_text = options.delete(:help_text)
+      prefix = options.delete(:prefix)
+      postfix = options.delete(:postfix)
+
+      class_options = extract_validations(attribute, options).merge(class_options)
+
+      content = yield(class_options)
+      content += abide_error_element(attribute) if class_options[:pattern] || class_options[:required]
+      content = content.html_safe
+
+      html = wrap_prefix_and_postfix(content, prefix, postfix)
+      html + error_and_help_text(attribute, options.merge(help_text: help_text))
+    end
+
+    # Private: Builds a Hash of options to be injected at the HTML output as
+    # HTML5 validations.
+    #
+    # attribute - The String name of the attribute to extract the validations.
+    # options - A Hash of options to extract validations.
+    #
+    # Returns a Hash.
+    def extract_validations(attribute, options)
+      min_length = options.delete(:minlength) || length_for_attribute(attribute, :minimum) || 0
+      max_length = options.delete(:maxlength) || length_for_attribute(attribute, :maximum)
+
+      validation_options = {}
+      validation_options[:pattern] = "^(.){#{min_length},#{max_length}}$" if min_length.to_i.positive? || max_length.to_i.positive?
+      validation_options[:required] = options[:required] || attribute_required?(attribute)
+      validation_options
+    end
+
+    # Private: Tries to find if an attribute is required in the form object.
+    #
+    # Returns Boolean.
+    def attribute_required?(attribute)
+      validator = find_validator(attribute, ActiveModel::Validations::PresenceValidator)
+
+      validator && validator.options.blank?
+    end
+
+    # Private: Tries to find a length validator in the form object.
+    #
+    # attribute - The attribute to look for the validations.
+    # type      - A Symbol for the type of length to fetch. Currently only :minimum & :maximum are supported.
+    #
+    # Returns an Integer or Nil.
+    def length_for_attribute(attribute, type)
+      length_validator = find_validator(attribute, ActiveModel::Validations::LengthValidator)
+      return unless length_validator
+
+      length_validator.options[type]
+    end
+
+    # Private: Finds a validator.
+    #
+    # attribute - The attribute to validate.
+    # klass     - The Class of the validator to find.
+    #
+    # Returns a klass object.
+    def find_validator(attribute, klass)
+      return unless object.respond_to?(:_validators)
+      object._validators[attribute].find { |validator| validator.class == klass }
+    end
+
+    # Private: Override method from FoundationRailsHelper to render the text of the
+    # label before the input, instead of after.
+    #
+    # attribute - The String name of the attribute we're build the label.
+    # text      - The String text to use as label.
+    # options   - An optional Hash to build the label.
+    #
+    # Returns a String.
+    def custom_label(attribute, text, options, field_before_label = false)
+      return block_given? ? yield.html_safe : "".html_safe if text == false
+
+      text = default_label_text(object, attribute) if text.nil? || text == true
+
+      text = if field_before_label && block_given?
+               safe_join([yield, text.html_safe])
+             elsif block_given?
+               safe_join([text.html_safe, yield])
+             end
+
+      label(attribute, text, options || {})
+    end
+
+    # Private: Builds a span to be shown when there's a validation error in a field.
+    # It looks for the text that will be the content in a similar way `human_attribute_name`
+    # does it.
+    #
+    # attribute - The name of the attribute of the field.
+    #
+    # Returns a String.
+    def abide_error_element(attribute)
+      defaults = []
+      defaults << :"decidim.forms.errors.#{object.class.model_name.i18n_key}.#{attribute}"
+      defaults << :"decidim.forms.errors.#{attribute}"
+      defaults << :"forms.errors.#{attribute}"
+      defaults << :"decidim.forms.errors.error"
+
+      options = { count: 1, default: defaults }
+
+      text = I18n.t(defaults.shift, options)
+      content_tag(:span, text, class: "form-error")
+    end
+
     def categories_for_select(scope)
       sorted_main_categories = scope.first_class.includes(:subcategories).sort_by do |category|
         category.name[I18n.locale.to_s]