decidim-surveys 0.3.0

data/config/locales/eu.yml

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

data/config/locales/fi.yml

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

data/config/locales/fr.yml

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

data/config/locales/it.yml

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

data/config/locales/nl.yml

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

data/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/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/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/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/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/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/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/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/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/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/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/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/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/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

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: decidim-surveys
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Josep Jaume Rey Peroy
+- Marc Riera Casals
+- Oriol Gual Oliva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: decidim-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: jquery-tmpl-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: decidim-dev
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+description: A component for decidim's participatory processes.
+email:
+- josepjaume@gmail.com
+- mrc2407@gmail.com
+- oriolgual@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/config/admin/decidim_surveys_manifest.js
+- app/assets/images/decidim/surveys/icon.svg
+- app/assets/javascripts/decidim/surveys/admin/auto_label_by_position.component.js.es6
+- app/assets/javascripts/decidim/surveys/admin/dynamic_fields.component.js.es6
+- app/assets/javascripts/decidim/surveys/admin/surveys.js.es6
+- app/assets/stylesheets/decidim/surveys/surveys.scss
+- app/commands/decidim/surveys/admin/update_survey.rb
+- app/commands/decidim/surveys/answer_survey.rb
+- app/commands/decidim/surveys/create_survey.rb
+- app/controllers/decidim/surveys/admin/application_controller.rb
+- app/controllers/decidim/surveys/admin/surveys_controller.rb
+- app/controllers/decidim/surveys/application_controller.rb
+- app/controllers/decidim/surveys/surveys_controller.rb
+- app/forms/decidim/surveys/admin/survey_form.rb
+- app/forms/decidim/surveys/admin/survey_question_answer_option_form.rb
+- app/forms/decidim/surveys/admin/survey_question_form.rb
+- app/forms/decidim/surveys/survey_answer_form.rb
+- app/forms/decidim/surveys/survey_form.rb
+- app/helpers/decidim/surveys/admin/application_helper.rb
+- app/models/decidim/surveys/abilities/admin_user.rb
+- app/models/decidim/surveys/abilities/current_user.rb
+- app/models/decidim/surveys/abilities/process_admin_user.rb
+- app/models/decidim/surveys/application_record.rb
+- app/models/decidim/surveys/survey.rb
+- app/models/decidim/surveys/survey_answer.rb
+- app/models/decidim/surveys/survey_question.rb
+- app/queries/decidim/surveys/survey_user_answers.rb
+- app/views/decidim/surveys/admin/surveys/_answer_option.html.erb
+- app/views/decidim/surveys/admin/surveys/_form.html.erb
+- app/views/decidim/surveys/admin/surveys/_question.html.erb
+- app/views/decidim/surveys/admin/surveys/edit.html.erb
+- app/views/decidim/surveys/surveys/show.html.erb
+- config/i18n-tasks.yml
+- config/locales/ca.yml
+- config/locales/en.yml
+- config/locales/es.yml
+- config/locales/eu.yml
+- config/locales/fi.yml
+- config/locales/fr.yml
+- config/locales/it.yml
+- config/locales/nl.yml
+- db/migrate/20170511092231_create_decidim_surveys.rb
+- db/migrate/20170515090916_create_decidim_survey_questions.rb
+- db/migrate/20170515144119_create_decidim_survey_answers.rb
+- db/migrate/20170518085302_add_position_to_surveys_questions.rb
+- db/migrate/20170522075938_add_mandatory_to_surveys_questions.rb
+- db/migrate/20170524122229_add_question_type_to_surveys_questions.rb
+- db/migrate/20170525132233_add_answer_options_to_surveys_questions.rb
+- lib/decidim/surveys.rb
+- lib/decidim/surveys/admin.rb
+- lib/decidim/surveys/admin_engine.rb
+- lib/decidim/surveys/engine.rb
+- lib/decidim/surveys/feature.rb
+- lib/decidim/surveys/survey_user_answers_serializer.rb
+- lib/decidim/surveys/test/factories.rb
+homepage: https://github.com/decidim/decidim
+licenses:
+- AGPLv3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A component for decidim's participatory processes.
+test_files: []