decidim-core 0.0.1 → 0.0.2

data/lib/decidim/core.rb

@@ -7,6 +7,7 @@ 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 :Features, "decidim/features"
@@ -15,6 +16,11 @@ module Decidim
 
   # 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)
+
     railties = Rails.application.railties.to_a.uniq.select do |railtie|
       railtie.respond_to?(:load_seed) && railtie.class.name.include?("Decidim::")
     end
@@ -28,6 +34,8 @@ module Decidim
       puts "Creating Feature (#{feature.name}) seeds..."
       feature.seed!
     end
+
+    I18n.available_locales = original_locale
   end
 
   # Exposes a configuration option: The application name String.

data/lib/decidim/core/engine.rb

@@ -24,6 +24,10 @@ require "sprockets/es6"
 require "cancancan"
 require "truncato"
 require "file_validators"
+require "omniauth"
+require "omniauth-facebook"
+require "omniauth-twitter"
+require "omniauth-google-oauth2"
 
 require "decidim/api"
 
@@ -48,6 +52,10 @@ module Decidim
 
       initializer "decidim.assets" do |app|
         app.config.assets.precompile += %w(decidim_core_manifest.js)
+
+        Decidim.feature_manifests.each do |feature|
+          app.config.assets.precompile += [feature.icon]
+        end
       end
 
       initializer "decidim.high_voltage" do |_app|

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

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+require "decidim/faker/localized"
+require "decidim/dev"
+
+FactoryGirl.define do
+  sequence :name do |n|
+    "#{Faker::Name.name} #{n}"
+  end
+
+  sequence(:email) do |n|
+    "user#{n}@decidim.org"
+  end
+
+  sequence(:slug) do |n|
+    "#{Faker::Internet.slug(nil, "-")}-#{n}"
+  end
+
+  factory :category, class: Decidim::Category do
+    name { Decidim::Faker::Localized.sentence(3) }
+    description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(2) } }
+    participatory_process
+  end
+
+  factory :subcategory, parent: :category do
+    parent { build(:category) }
+
+    before(:create) do |object|
+      object.parent.save unless object.parent.persisted?
+    end
+  end
+
+  factory :organization, class: Decidim::Organization do
+    name { Faker::Company.name }
+    twitter_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") }
+    default_locale I18n.default_locale
+    available_locales Decidim.available_locales
+  end
+
+  factory :participatory_process, class: Decidim::ParticipatoryProcess do
+    title { Decidim::Faker::Localized.sentence(3) }
+    slug { generate(:slug) }
+    subtitle { Decidim::Faker::Localized.sentence(1) }
+    short_description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(2) } }
+    description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(4) } }
+    hero_image { test_file("city.jpeg", "image/jpeg") }
+    banner_image { test_file("city2.jpeg", "image/jpeg") }
+    published_at { Time.current }
+    organization
+
+    trait :promoted do
+      promoted true
+    end
+
+    trait :unpublished do
+      published_at nil
+    end
+
+    trait :published do
+      published_at { Time.current }
+    end
+
+    trait :with_steps do
+      after(:create) do |participatory_process, _evaluator|
+        create(:participatory_process_step,
+               active: true,
+               participatory_process: participatory_process)
+      end
+    end
+  end
+
+  factory :participatory_process_step, class: Decidim::ParticipatoryProcessStep do
+    title { Decidim::Faker::Localized.sentence(3) }
+    short_description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(2) } }
+    description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(4) } }
+    start_date 1.month.ago.at_midnight
+    end_date 2.month.from_now.at_midnight
+    position nil
+    participatory_process
+
+    trait :active do
+      active true
+    end
+  end
+
+  factory :user, class: Decidim::User do
+    email                 { generate(:email) }
+    password              "password1234"
+    password_confirmation "password1234"
+    name                  { generate(:name) }
+    organization
+    locale                { organization.default_locale }
+    tos_agreement         "1"
+    avatar                { test_file("avatar.svg", "image/svg+xml") }
+
+    trait :confirmed do
+      confirmed_at { Time.current }
+    end
+
+    trait :admin do
+      roles ["admin"]
+    end
+
+    trait :moderator do
+      roles ["moderator"]
+    end
+
+    trait :official do
+      roles ["official"]
+    end
+  end
+
+  factory :user_group, class: Decidim::UserGroup do
+    name { Faker::Educator.course }
+    document_number { Faker::Number.number(8) + "X" }
+    phone { Faker::PhoneNumber.phone_number }
+  end
+
+  factory :user_group_membership, class: Decidim::UserGroupMembership do
+    user
+    user_group
+  end
+
+  factory :identity, class: Decidim::Identity do
+    provider "facebook"
+    sequence(:uid)
+    user
+  end
+
+  factory :authorization, class: Decidim::Authorization do
+    name "decidim/dummy_authorization_handler"
+    user
+    metadata { {} }
+  end
+
+  factory :static_page, class: Decidim::StaticPage do
+    slug { generate(:slug) }
+    title { Decidim::Faker::Localized.sentence(3) }
+    content { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(4) } }
+    organization
+
+    trait :default do
+      slug { Decidim::StaticPage::DEFAULT_PAGES.sample }
+    end
+  end
+
+  factory :participatory_process_attachment, class: Decidim::ParticipatoryProcessAttachment do
+    title { Decidim::Faker::Localized.sentence(3) }
+    description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(4) } }
+    file { test_file("city.jpeg", "image/jpeg") }
+    participatory_process
+
+    trait :with_image do
+      file { test_file("city.jpeg", "image/jpeg") }
+    end
+
+    trait :with_pdf do
+      file { test_file("Exampledocument.pdf", "application/pdf") }
+    end
+
+    trait :with_doc do
+      file { test_file("Exampledocument.doc", "application/msword") }
+    end
+
+    trait :with_odt do
+      file { test_file("Exampledocument.odt", "application/vnd.oasis.opendocument") }
+    end
+  end
+
+  factory :feature, class: Decidim::Feature do
+    name { Decidim::Faker::Localized.sentence(3) }
+    participatory_process
+    manifest_name "dummy"
+  end
+
+  factory :scope, class: Decidim::Scope do
+    name { generate(:name) }
+    organization
+  end
+end
+
+def test_file(filename, content_type)
+  asset = Decidim::Dev.asset(filename)
+  Rack::Test::UploadedFile.new(asset, content_type)
+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.1"
+    "0.0.2"
   end
 
   def self.rails_version

data/lib/decidim/devise_failure_app.rb

@@ -17,6 +17,7 @@ module Decidim
 
       route = route(scope)
 
+      opts[:locale] = params[:locale] if params[:locale]
       opts[:format] = request_format unless skip_format?
 
       opts[:script_name] = relative_url_root if relative_url_root?

data/lib/decidim/feature_manifest.rb

@@ -1,3 +1,5 @@
+require_dependency "decidim/features/settings_manifest"
+
 # frozen_string_literal: true
 module Decidim
   # This class handles all the logic associated to configuring a feature
@@ -15,6 +17,10 @@ module Decidim
     attribute :name, Symbol
     attribute :hooks, Hash[Symbol => Array[Proc]], default: {}
 
+    # A String with the feature's icon. The icon must be stored in the
+    # engine's assets path.
+    attribute :icon, String
+
     validates :name, presence: true
 
     # Public: Registers a hook to this manifest. Hooks get fired when some
@@ -67,5 +73,26 @@ module Decidim
     def seed!
       @seeds&.call
     end
+
+    # Public: Adds configurable attributes for this feature, scoped to a name. It
+    # uses the DSL specified under `Decidim::FeatureSettingsManifest`.
+    #
+    # name - Either `global` or `step`
+    # &block - The DSL present on `Decidim::FeatureSettingsManifest`
+    #
+    # Examples:
+    #
+    #   feature.settings(:global) do |settings|
+    #     settings.attribute :voting_enabled, type: :boolean, default: true
+    #   end
+    #
+    # Returns nothing.
+    def settings(name = :global, &block)
+      @settings ||= {}
+      name = name.to_sym
+      settings = (@settings[name] ||= FeatureSettingsManifest.new)
+      yield(settings) if block
+      settings
+    end
   end
 end

data/lib/decidim/features/base_controller.rb

@@ -8,9 +8,12 @@ module Decidim
     class BaseController < Decidim::ApplicationController
       layout "layouts/decidim/participatory_process"
       include NeedsParticipatoryProcess
+      include FeatureSettings
       helper Decidim::TranslationsHelper
       helper Decidim::ParticipatoryProcessHelper
-      helper_method :current_feature
+
+      helper_method :current_feature,
+                    :current_manifest
 
       skip_authorize_resource
 
@@ -18,12 +21,14 @@ module Decidim
         authorize! :read, current_participatory_process
       end
 
-      private
-
       def current_feature
         request.env["decidim.current_feature"]
       end
 
+      def current_manifest
+        current_feature.manifest
+      end
+
       def current_participatory_process
         request.env["decidim.current_participatory_process"]
       end

data/lib/decidim/features/settings_manifest.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+module Decidim
+  # This class serves as a DSL that enables specifying an arbitrary settings
+  # to a feature, so the admin panel can show a standarized UI to configure them.
+  #
+  class FeatureSettingsManifest
+    attr_reader :attributes
+
+    # Initializes a FeatureSettingsManifest.
+    def initialize
+      @attributes = {}
+    end
+
+    # Public: Adds a new attribute field to the FeatureSettingsManifest.
+    #
+    # name - The name of the attribute to inject.
+    # options - A set of options to configure the attribute.
+    #           :type - The type of the attribute as found in Attribute::TYPES
+    #           :default - The default value of this settings field.
+    #
+    # Returns nothing.
+    def attribute(name, options = {})
+      attribute = Attribute.new(options)
+      attribute.validate!
+      @attributes[name.to_sym] = attribute
+
+      @schema = nil
+    end
+
+    # Public: Creates a model Class that sanitizes, coerces and filters data to
+    # the right types given a hash of serialized information.
+    #
+    # Returns a Class.
+    def schema
+      return @schema if @schema
+
+      manifest = self
+
+      @schema = Class.new do
+        include Virtus.model
+        include ActiveModel::Validations
+
+        cattr_accessor :manifest
+
+        def self.model_name
+          ActiveModel::Name.new(self, nil, "FeatureSettings")
+        end
+
+        def manifest
+          self.class.manifest
+        end
+
+        def ==(other)
+          other.attributes == attributes
+        end
+
+        manifest.attributes.each do |name, attribute|
+          attribute name, attribute.type_class, default: attribute.default_value
+          validates name, presence: true
+        end
+      end
+
+      @schema.manifest = self
+      @schema
+    end
+
+    # Semi-private: Attributes are an abstraction used by FeatureSettingsManifest
+    # to encapsulate behavior related to each individual settings field. Shouldn't
+    # be used from the outside.
+    class Attribute
+      include Virtus.model
+      include ActiveModel::Validations
+
+      TYPES = {
+        boolean: { klass: Boolean, default: false },
+        string: { klass: String, default: nil },
+        text: { klass: String, default: nil }
+      }.freeze
+
+      attribute :type, Symbol, default: :boolean
+      attribute :default
+
+      validates :type, inclusion: { in: TYPES.keys }
+
+      def type_class
+        TYPES[type][:klass]
+      end
+
+      def default_value
+        default || TYPES[type][:default]
+      end
+    end
+  end
+end

data/lib/decidim/filter_form_builder.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+# rubocop:disable Metrics/ParameterLists
+require "decidim/form_builder"
+
+module Decidim
+  # This custom FormBuilder is used to create resource filter forms
+  class FilterFormBuilder < FormBuilder
+    # Wrap the radio buttons collection in a custom fieldset.
+    # It also renders the inputs inside its labels.
+    def collection_radio_buttons(method, collection, value_method, label_method, options = {}, html_options = {})
+      fieldset_wrapper options[:legend_title] do
+        super(method, collection, value_method, label_method, options, html_options) do |builder|
+          if block_given?
+            yield builder
+          else
+            builder.label { builder.radio_button + builder.text }
+          end
+        end
+      end
+    end
+
+    # Wrap the check_boxes collection in a custom fieldset.
+    # It also renders the inputs inside its labels.
+    def collection_check_boxes(method, collection, value_method, label_method, options = {}, html_options = {})
+      fieldset_wrapper options[:legend_title] do
+        super(method, collection, value_method, label_method, options, html_options) do |builder|
+          if block_given?
+            yield builder
+          else
+            builder.label { builder.check_box + builder.text }
+          end
+        end
+      end
+    end
+
+    # Wrap the category select in a custom fieldset.
+    def categories_select(method, collection, options = {})
+      fieldset_wrapper options[:legend_title] do
+        super(method, collection, options)
+      end
+    end
+
+    private
+
+    # Private: Renders a custom fieldset and execute the given block.
+    def fieldset_wrapper(legend_title)
+      @template.content_tag(:div, "", class: "filters__section") do
+        @template.content_tag(:fieldset) do
+          @template.content_tag(:legend) do
+            @template.content_tag(:h6, legend_title, class: "heading6")
+          end + yield
+        end
+      end
+    end
+  end
+end