decidim 0.2.0 → 0.3.0

data/decidim-surveys/config/locales/es.yml

@@ -0,0 +1,69 @@
+es:
+  activemodel:
+    attributes:
+      survey_answer:
+        body: Respuesta
+      survey_question:
+        mandatory: Obligatorio
+        question_type: Tipo
+  decidim:
+    features:
+      surveys:
+        actions:
+          answer: Respuesta
+        name: Encuesta
+        settings:
+          step:
+            allow_answers: Permitir respuestas
+    surveys:
+      admin:
+        application_helper:
+          label_for_question:
+            question: Pregunta
+        exports:
+          survey_user_answers: Respuestas de los usuarios de la encuesta
+        models:
+          components:
+            description: Descripción
+            tos: Términos de servicio
+        surveys:
+          answer_option:
+            answer_option: Opción de respuesta
+            remove_answer_option: Eliminar opción de respuesta
+            statement: Enunciado
+          edit:
+            save: Guardar
+            title: Título
+          form:
+            add_question: Añadir pregunta
+            already_answered_warning: La encuesta ya está contestada por algunos usuarios, así que no puedes modificar sus preguntas.
+          question:
+            add_answer_option: Agregar opción de respuesta
+            question: Pregunta
+            remove_question: Eliminar pregunta
+            statement: Enunciado
+          update:
+            invalid: Se han producido errores al guardar la encuesta.
+            success: Encuesta guardada correctamente.
+      question_types:
+        long_answer: Respuesta larga
+        multiple_option: Opción múltiple
+        short_answer: Respuesta corta
+        single_option: Opción individual
+      surveys:
+        answer:
+          invalid: Se han producido errores al responder a la encuesta.
+          success: La encuesta ha sido respondida con éxito.
+        show:
+          answer_survey:
+            anonymous_user_message: <a href="%{sign_in_link}">Inicia sesión con tu cuenta</a> o <a href="%{sign_up_link}">regístrate</a> para responder a la encuesta.
+            title: Contestar a la encuesta
+          are_you_sure: Esta acción no se puede deshacer y no podrás editar tus respuestas. ¿Estás seguro?
+          submit: Enviar
+          survey_answered:
+            body: Ya has respondido a esta encuesta.
+            title: Encuesta respondida
+          survey_closed:
+            body: La encuesta está cerrada y no se puede responder.
+            title: Encuesta cerrada
+          tos_agreement: Al participar en esta encuesta, aceptas sus términos de servicio

data/decidim-surveys/config/locales/eu.yml

@@ -0,0 +1,5 @@
+eu:
+  activemodel:
+    attributes:
+      survey_answer:
+        body: Erantzuna

data/decidim-surveys/config/locales/fi.yml

@@ -0,0 +1,5 @@
+fi:
+  decidim:
+    features:
+      surveys:
+        name: Tutkimus

data/decidim-surveys/config/locales/fr.yml

@@ -0,0 +1,5 @@
+fr:
+  decidim:
+    features:
+      surveys:
+        name: Enquête

data/decidim-surveys/config/locales/it.yml

@@ -0,0 +1,5 @@
+it:
+  activemodel:
+    attributes:
+      survey_answer:
+        body: Risposta

data/decidim-surveys/config/locales/nl.yml

@@ -0,0 +1,5 @@
+nl:
+  activemodel:
+    attributes:
+      survey_answer:
+        body: Antwoord

data/decidim-surveys/db/migrate/20170511092231_create_decidim_surveys.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class CreateDecidimSurveys < ActiveRecord::Migration[5.0]
+  def change
+    create_table :decidim_surveys_surveys do |t|
+      t.jsonb :title
+      t.jsonb :description
+      t.jsonb :tos
+      t.references :decidim_feature, index: true
+      t.datetime :published_at
+
+      t.timestamps
+    end
+  end
+end

data/decidim-surveys/db/migrate/20170515090916_create_decidim_survey_questions.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class CreateDecidimSurveyQuestions < ActiveRecord::Migration[5.0]
+  def change
+    create_table :decidim_surveys_survey_questions do |t|
+      t.jsonb :body
+      t.references :decidim_survey, index: true
+
+      t.timestamps
+    end
+  end
+end

data/decidim-surveys/db/migrate/20170515144119_create_decidim_survey_answers.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class CreateDecidimSurveyAnswers < ActiveRecord::Migration[5.0]
+  def change
+    create_table :decidim_surveys_survey_answers do |t|
+      t.jsonb :body, default: []
+      t.references :decidim_user, index: true
+      t.references :decidim_survey, index: true
+      t.references :decidim_survey_question, index: { name: "index_decidim_surveys_answers_question_id" }
+
+      t.timestamps
+    end
+  end
+end

data/decidim-surveys/db/migrate/20170518085302_add_position_to_surveys_questions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddPositionToSurveysQuestions < ActiveRecord::Migration[5.0]
+  def change
+    add_column :decidim_surveys_survey_questions, :position, :integer, index: true
+  end
+end

data/decidim-surveys/db/migrate/20170522075938_add_mandatory_to_surveys_questions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddMandatoryToSurveysQuestions < ActiveRecord::Migration[5.0]
+  def change
+    add_column :decidim_surveys_survey_questions, :mandatory, :boolean
+  end
+end

data/decidim-surveys/db/migrate/20170524122229_add_question_type_to_surveys_questions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddQuestionTypeToSurveysQuestions < ActiveRecord::Migration[5.0]
+  def change
+    add_column :decidim_surveys_survey_questions, :question_type, :string
+  end
+end

data/decidim-surveys/db/migrate/20170525132233_add_answer_options_to_surveys_questions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddAnswerOptionsToSurveysQuestions < ActiveRecord::Migration[5.0]
+  def change
+    add_column :decidim_surveys_survey_questions, :answer_options, :jsonb, default: []
+  end
+end

data/decidim-surveys/decidim-surveys.gemspec

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path("lib", __dir__)
+
+# Maintain your gem's version:
+require_relative "../decidim-core/lib/decidim/core/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  Decidim.add_default_gemspec_properties(s)
+
+  s.name        = "decidim-surveys"
+  s.summary     = "A component for decidim's participatory processes."
+  s.description = s.summary
+
+  s.files = Dir["{app,config,db,lib}/**/*", "Rakefile", "README.md"]
+
+  s.add_dependency "decidim-core", Decidim.version
+  s.add_dependency "jquery-tmpl-rails", "~> 1.1.0"
+
+  s.add_development_dependency "decidim-dev", Decidim.version
+end

data/decidim-surveys/lib/decidim/surveys.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "decidim/surveys/admin"
+require "decidim/surveys/engine"
+require "decidim/surveys/admin_engine"
+require "decidim/surveys/feature"
+
+module Decidim
+  # This namespace holds the logic of the `Surveys` component. This component
+  # allows users to create surveys in a participatory process.
+  module Surveys
+    autoload :SurveyUserAnswersSerializer, "decidim/surveys/survey_user_answers_serializer"
+  end
+end

data/decidim-surveys/lib/decidim/surveys/admin.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # This module contains all the domain logic associated to Decidim's Surveys
+    # component admin panel.
+    module Admin
+    end
+  end
+end

data/decidim-surveys/lib/decidim/surveys/admin_engine.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "jquery-tmpl-rails"
+
+module Decidim
+  module Surveys
+    # This is the engine that runs on the public interface of `Surveys`.
+    class AdminEngine < ::Rails::Engine
+      isolate_namespace Decidim::Surveys::Admin
+
+      paths["db/migrate"] = nil
+
+      routes do
+        post "/", to: "surveys#update", as: :survey
+        root to: "surveys#edit"
+      end
+
+      initializer "decidim_surveys.assets" do |app|
+        app.config.assets.precompile += %w(admin/decidim_surveys_manifest.js)
+      end
+
+      initializer "decidim_surveys.inject_abilities_to_user" do |_app|
+        Decidim.configure do |config|
+          config.admin_abilities += ["Decidim::Surveys::Abilities::AdminUser"]
+          config.admin_abilities += ["Decidim::Surveys::Abilities::ProcessAdminUser"]
+        end
+      end
+
+      def load_seed
+        nil
+      end
+    end
+  end
+end

data/decidim-surveys/lib/decidim/surveys/engine.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # This is the engine that runs on the public interface of `decidim-surveys`.
+    class Engine < ::Rails::Engine
+      isolate_namespace Decidim::Surveys
+
+      routes do
+        resources :surveys, only: [:show] do
+          member do
+            post :answer
+          end
+        end
+        root to: "surveys#show"
+      end
+
+      initializer "decidim_surveys.inject_abilities_to_user" do |_app|
+        Decidim.configure do |config|
+          config.abilities += ["Decidim::Surveys::Abilities::CurrentUser"]
+        end
+      end
+    end
+  end
+end

data/decidim-surveys/lib/decidim/surveys/feature.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_dependency "decidim/features/namer"
+
+Decidim.register_feature(:surveys) do |feature|
+  feature.engine = Decidim::Surveys::Engine
+  feature.admin_engine = Decidim::Surveys::AdminEngine
+  feature.icon = "decidim/surveys/icon.svg"
+  feature.stylesheet = "decidim/surveys/surveys"
+
+  feature.on(:create) do |instance|
+    Decidim::Surveys::CreateSurvey.call(instance) do
+      on(:invalid) { raise "Can't create survey" }
+    end
+  end
+
+  feature.on(:before_destroy) do |instance|
+    if Decidim::Surveys::Survey.where(feature: instance).any?
+      raise "Can't destroy this feature when there are surveys"
+    end
+  end
+
+  # These actions permissions can be configured in the admin panel
+  feature.actions = %w(answer)
+
+  # feature.settings(:global) do |settings|
+  #   # Add your global settings
+  #   # Available types: :integer, :boolean
+  #   # settings.attribute :vote_limit, type: :integer, default: 0
+  # end
+
+  feature.settings(:step) do |settings|
+    settings.attribute :allow_answers, type: :boolean, default: false
+  end
+
+  # feature.register_resource do |resource|
+  #   # Register a optional resource that can be references from other resources.
+  #   resource.model_class_name = "Decidim::Surveys::SomeResource"
+  #   resource.template = "decidim/surveys/some_resources/linked_some_resources"
+  # end
+
+  # feature.register_stat :some_stat do |context, start_at, end_at|
+  #   # Register some stat number to the application
+  # end
+
+  feature.exports :survey_user_answers do |exports|
+    exports.collection do |f|
+      survey = Decidim::Surveys::Survey.where(feature: f).first
+      Decidim::Surveys::SurveyUserAnswers.for(survey)
+    end
+
+    exports.serializer Decidim::Surveys::SurveyUserAnswersSerializer
+  end
+
+  feature.seeds do
+    Decidim::ParticipatoryProcess.all.each do |process|
+      next unless process.steps.any?
+
+      feature = Decidim::Feature.create!(
+        name: Decidim::Features::Namer.new(process.organization.available_locales, :surveys).i18n_name,
+        manifest_name: :surveys,
+        published_at: Time.current,
+        participatory_process: process
+      )
+
+      survey = Decidim::Surveys::Survey.create!(
+        feature: feature,
+        title: Decidim::Faker::Localized.paragraph,
+        description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+          Decidim::Faker::Localized.paragraph(3)
+        end,
+        tos: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+          Decidim::Faker::Localized.paragraph(2)
+        end
+      )
+
+      3.times do
+        Decidim::Surveys::SurveyQuestion.create!(
+          survey: survey,
+          body: Decidim::Faker::Localized.paragraph
+        )
+      end
+    end
+  end
+end

data/decidim-surveys/lib/decidim/surveys/survey_user_answers_serializer.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Surveys
+    # This class serializes the answers given by a User for survey so can be
+    # exported to CSV, JSON or other formats.
+    class SurveyUserAnswersSerializer < Decidim::Exporters::Serializer
+      include Decidim::TranslationsHelper
+
+      # Public: Initializes the serializer with a collection of SurveyAnswers.
+      def initialize(survey_answers)
+        @survey_answers = survey_answers
+      end
+
+      # Public: Exports a hash with the serialized data for the user answers.
+      def serialize
+        @survey_answers.each_with_index.inject({}) do |serialized, (answer, idx)|
+          serialized.update("#{idx + 1}. #{translated_attribute(answer.question.body)}" => answer.body)
+        end
+      end
+    end
+  end
+end

data/decidim-surveys/lib/decidim/surveys/test/factories.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "decidim/core/test/factories"
+require "decidim/admin/test/factories"
+
+FactoryGirl.define do
+  factory :surveys_feature, parent: :feature do
+    name { Decidim::Features::Namer.new(participatory_process.organization.available_locales, :surveys).i18n_name }
+    manifest_name :surveys
+    participatory_process { create(:participatory_process, :with_steps) }
+  end
+
+  factory :survey, class: Decidim::Surveys::Survey do
+    title { Decidim::Faker::Localized.sentence }
+    description do
+      Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+        Decidim::Faker::Localized.sentence(4)
+      end
+    end
+    tos { Decidim::Faker::Localized.sentence(4) }
+    feature { build(:surveys_feature) }
+  end
+
+  factory :survey_question, class: Decidim::Surveys::SurveyQuestion do
+    body { Decidim::Faker::Localized.sentence }
+    mandatory false
+    position 0
+    question_type Decidim::Surveys::SurveyQuestion::TYPES.first
+    answer_options []
+    survey
+  end
+
+  factory :survey_answer, class: Decidim::Surveys::SurveyAnswer do
+    body { Decidim::Faker::Localized.sentence }
+    survey
+    question { create(:survey_question, survey: survey) }
+    user { create(:user, organization: survey.organization) }
+  end
+end