decidim-time_tracker 0.3

data/db/migrate/20200302115708_create_decidim_time_tracker_milestones.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class CreateDecidimTimeTrackerMilestones < ActiveRecord::Migration[5.2]
+  def change
+    create_table :decidim_time_tracker_milestones do |t|
+      t.references :decidim_user, null: false, index: true
+      t.references :activity, foreign_key: { to_table: :decidim_time_tracker_activities }, null: false
+      t.string :title
+      t.string :description
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200302115831_create_decidim_time_tracker_assignations.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class CreateDecidimTimeTrackerAssignations < ActiveRecord::Migration[5.2]
+  def change
+    create_table :decidim_time_tracker_assignations do |t|
+      t.references :decidim_user, null: false, index: true
+      t.references :activity, foreign_key: { to_table: :decidim_time_tracker_activities }, null: false
+      t.integer :status, default: 0
+      t.datetime :invited_at
+      t.references :invited_by_user, foreign_key: { to_table: :decidim_users }
+      t.datetime :requested_at
+      t.datetime :tos_accepted_at
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200302115840_create_decidim_time_tracker_time_events.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class CreateDecidimTimeTrackerTimeEvents < ActiveRecord::Migration[5.2]
+  def change
+    create_table :decidim_time_tracker_time_events do |t|
+      t.references :decidim_user, foreign_key: { to_table: :decidim_users }
+      t.references :assignation, foreign_key: { to_table: :decidim_time_tracker_assignations }
+      t.references :activity, foreign_key: { to_table: :decidim_time_tracker_activities }
+      t.integer :start # timestamp (seconds)
+      t.integer :stop # timestamp (seconds)
+      t.integer :total_seconds, null: false, default: 0
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20201118153327_create_decidim_time_tracker_assignee_data.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class CreateDecidimTimeTrackerAssigneeData < ActiveRecord::Migration[5.2]
+  def change
+    create_table :decidim_time_tracker_assignee_data do |t|
+      t.references :time_tracker, foreign_key: { to_table: :decidim_time_trackers }
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20201223115130_create_decidim_time_tracker_tos_acceptances.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class CreateDecidimTimeTrackerTosAcceptances < ActiveRecord::Migration[5.2]
+  def up
+    create_table :decidim_time_tracker_tos_acceptances do |t|
+      t.references :assignee, foreign_key: { to_table: :decidim_time_tracker_assignees }
+      t.references :time_tracker, foreign_key: { to_table: :decidim_time_trackers }
+      t.timestamps
+    end
+
+    remove_column :decidim_time_tracker_assignations, :tos_accepted_at
+  end
+
+  def down
+    drop_table :decidim_time_tracker_tos_acceptances
+    add_column :decidim_time_tracker_assignations, :tos_accepted_at
+  end
+end

data/lib/decidim/time_tracker.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "decidim/time_tracker/admin"
+require "decidim/time_tracker/engine"
+require "decidim/time_tracker/admin_engine"
+require "decidim/time_tracker/reports"
+require "decidim/time_tracker/reports_engine"
+require "decidim/time_tracker/component"
+module Decidim
+  # This namespace holds the logic of the `TimeTracker` component. This component
+  # allows users to create time_tracker in a participatory space.
+  module TimeTracker
+    include ActiveSupport::Configurable
+
+    autoload :TimeTrackerActivityQuestionnaireAnswersSerializer, "decidim/time_tracker/time_tracker_activity_questionnaire_answers_serializer"
+
+    # Returns a YAML with default seeds for activities questionnaire
+    config_accessor :default_activity_questionnaire_seeds do
+      YAML.load_file File.join(::Decidim::TimeTracker::Engine.root, "config", "activity_questionnaire.yml")
+    end
+
+    def self.default_activity_questionnaire
+      return unless config[:default_activity_questionnaire_seeds]
+
+      config.default_activity_questionnaire_seeds.deep_symbolize_keys
+    end
+
+    # Returns a YAML with default seeds for assignee data questionnaire
+    config_accessor :default_assignee_questionnaire_seeds do
+      YAML.load_file File.join(::Decidim::TimeTracker::Engine.root, "config", "assignee_questionnaire.yml")
+    end
+
+    def self.default_assignee_questionnaire
+      return unless config[:default_assignee_questionnaire_seeds]
+
+      config.default_assignee_questionnaire_seeds.deep_symbolize_keys
+    end
+  end
+end
+
+Decidim.register_global_engine(
+  :decidim_time_tracker, # this is the name of the global method to access engine routes
+  ::Decidim::TimeTracker::ReportsEngine,
+  at: "/timetracker"
+)

data/lib/decidim/time_tracker/admin.rb

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

data/lib/decidim/time_tracker/admin_engine.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TimeTracker
+    # This is the engine that runs on the public interface of `TimeTracker`.
+    class AdminEngine < ::Rails::Engine
+      isolate_namespace Decidim::TimeTracker::Admin
+
+      paths["db/migrate"] = nil
+      paths["lib/tasks"] = nil
+
+      routes do
+        # Add admin engine routes here
+        get :stats, to: "stats#index"
+
+        resources :tasks do
+          resources :activities do
+            resources :assignations
+          end
+          post "accept_all_pending_assignations", on: :collection
+        end
+
+        [:activity_questionnaire, :assignee_questionnaire].each do |questionnaire|
+          resource questionnaire, controller: questionnaire, only: [:edit, :update] do
+            get "/answer/:session_token", to: "#{questionnaire}#show", as: :show
+            get "/answer/:session_token/export", to: "#{questionnaire}#export_response", as: :export_response
+            get "/answers", to: "#{questionnaire}#index", as: :index
+            get "/answer_options", to: "#{questionnaire}#answer_options", as: :answer_options
+          end
+        end
+
+        get :time_tracker_exports, to: "time_tracker_exports#export"
+        # resource :time_tracker_exports, shallow: false do
+        #   collection do
+        #     get :export
+        #   end
+        # end
+
+        root to: "tasks#index"
+      end
+
+      initializer "decidim_time_tracker.admin_assets" do |app|
+        app.config.assets.precompile += %w(admin/decidim_time_tracker_manifest.js admin/decidim_time_tracker_manifest.css)
+      end
+
+      def load_seed
+        nil
+      end
+    end
+  end
+end

data/lib/decidim/time_tracker/component.rb

@@ -0,0 +1,248 @@
+# frozen_string_literal: true
+
+require_dependency "decidim/components/namer"
+
+Decidim.register_component(:time_tracker) do |component|
+  component.engine = Decidim::TimeTracker::Engine
+  component.admin_engine = Decidim::TimeTracker::AdminEngine
+  component.admin_stylesheet = "decidim/time_tracker/admin/time_tracker"
+  component.icon = "decidim/time_tracker/icon.svg"
+  component.permissions_class_name = "Decidim::TimeTracker::Permissions"
+
+  component.data_portable_entities = ["Decidim::TimeTracker::Milestone"]
+
+  component.newsletter_participant_entities = ["Decidim::TimeTracker::Milestone"]
+
+  component.on(:copy) do |context|
+    Decidim::TimeTracker::Admin::CreateTimeTracker.call(context[:new_component]) do
+      on(:invalid) { raise "Can't create Time Tracker" }
+    end
+  end
+
+  component.on(:create) do |instance|
+    Decidim::TimeTracker::Admin::CreateTimeTracker.call(instance) do
+      on(:invalid) { raise "Can't create Time Tracker" }
+    end
+  end
+
+  component.on(:before_destroy) do |instance|
+    # Code executed before removing the component
+    time_tracker = Decidim::TimeTracker::TimeTracker.find_by(decidim_component_id: instance.id)
+
+    answers = Decidim::Forms::Answer.where(questionnaire: time_tracker.questionnaire)
+    tasks = Decidim::TimeTracker::Task.where(time_tracker: time_tracker)
+
+    raise StandardError, "Can't remove this component, there are resources associated" if [answers, assignation_answers, tasks].any?(&:any?)
+  end
+
+  # These actions permissions can be configured in the admin panel
+  # component.actions = %w()
+
+  component.settings(:global) do |settings|
+    # Add your global settings
+    # Available types: :integer, :boolean
+    settings.attribute :announcement, type: :text, translated: true, editor: true
+    settings.attribute :tasks_label, type: :string, translated: true, editor: true
+    settings.attribute :activities_label, type: :string, translated: true, editor: true
+    settings.attribute :assignations_label, type: :string, translated: true, editor: true
+    settings.attribute :time_events_label, type: :string, translated: true, editor: true
+    settings.attribute :milestones_label, type: :string, translated: true, editor: true
+  end
+
+  component.settings(:step) do |settings|
+    # Add your settings per step
+    settings.attribute :announcement, type: :text, translated: true, editor: true
+  end
+
+  component.register_resource(:milestone) do |resource|
+    # Register a optional resource that can be references from other resources.
+    resource.model_class_name = "Decidim::TimeTracker::Milestone"
+    # TODO!:
+    # resource.template = "decidim/time_tracker/time_tracker/linked_tasks"
+    resource.card = "decidim/time_tracker/milestone"
+    # resource.actions = %w(create)
+    # resource.searchable = true
+  end
+
+  component.register_stat :activities_count, primary: true, priority: Decidim::StatsRegistry::MEDIUM_PRIORITY do |components, start_at, end_at|
+    tasks = Decidim::TimeTracker::Task.joins(:time_tracker).where(decidim_time_trackers: { decidim_component_id: components })
+    activities = Decidim::TimeTracker::Activity.where(task: tasks).active
+    activities = activities.where("start_date >= ?", start_at) if start_at.present?
+    activities = activities.where("start_date <= ?", end_at) if end_at.present?
+    activities.count
+  end
+
+  component.register_stat :tasks_count, tag: :tasks, priority: Decidim::StatsRegistry::MEDIUM_PRIORITY do |components, _start_at, _end_at|
+    tasks = Decidim::TimeTracker::Task.joins(:time_tracker).where(decidim_time_trackers: { decidim_component_id: components })
+    tasks.count
+  end
+
+  component.register_stat :assignees_count, tag: :assignees, priority: Decidim::StatsRegistry::HIGH_PRIORITY do |components, start_at, end_at|
+    tasks = Decidim::TimeTracker::Task.joins(:time_tracker).where(decidim_time_trackers: { decidim_component_id: components })
+    assignations = Decidim::TimeTracker::Assignation.joins(:activity).where(decidim_time_tracker_activities: { task_id: tasks })
+    assignations = assignations.where("created_at >= ?", start_at) if start_at.present?
+    assignations = assignations.where("created_at <= ?", end_at) if end_at.present?
+    assignations.count
+  end
+
+  component.exports :time_tracker_activity_questionnaire_answers do |exports|
+    exports.collection do |f|
+      time_tracker = Decidim::TimeTracker::TimeTracker.find_by(component: f)
+
+      Decidim::Forms::Answer.joins(:questionnaire).where(questionnaire: time_tracker.activity_questionnaire)
+                            .group_by do |answer|
+        answer.session_token.split("-").first
+      end.values
+    end
+
+    exports.serializer Decidim::TimeTracker::TimeTrackerActivityQuestionnaireAnswersSerializer
+
+    exports.formats %w(CSV JSON Excel FormPDF)
+  end
+
+  component.exports :time_tracker_assignee_questionnaire_answers do |exports|
+    exports.collection do |f|
+      time_tracker = Decidim::TimeTracker::TimeTracker.find_by(component: f)
+      Decidim::Forms::QuestionnaireUserAnswers.for(time_tracker.assignee_questionnaire)
+    end
+
+    exports.serializer Decidim::Forms::UserAnswersSerializer
+
+    exports.formats %w(CSV JSON Excel FormPDF)
+  end
+
+  component.seeds do |participatory_space|
+    # Add some seeds for this component
+    admin_user = Decidim::User.find_by(
+      organization: participatory_space.organization,
+      email: "admin@example.org"
+    )
+
+    params = {
+      name: Decidim::Components::Namer.new(participatory_space.organization.available_locales, :time_tracker).i18n_name,
+      manifest_name: :time_tracker,
+      published_at: Time.current,
+      participatory_space: participatory_space
+    }
+
+    component = Decidim.traceability.perform_action!(
+      "publish",
+      Decidim::Component,
+      admin_user,
+      visibility: "all"
+    ) do
+      Decidim::Component.create!(params)
+    end
+
+    time_tracker = Decidim::TimeTracker::TimeTracker.create!(
+      component: component,
+      questionnaire: Decidim::Forms::Questionnaire.new(
+        tos: Decidim::Faker::Localized.sentence(10),
+        title: Decidim::Faker::Localized.sentence(4),
+        description: Decidim::Faker::Localized.sentence(10)
+      )
+    )
+
+    assignee_data = Decidim::TimeTracker::AssigneeData.create!(
+      time_tracker: time_tracker,
+      questionnaire: Decidim::Forms::Questionnaire.new(
+        tos: Decidim::Faker::Localized.sentence(10),
+        title: Decidim::Faker::Localized.sentence(4),
+        description: Decidim::Faker::Localized.sentence(10)
+      )
+    )
+
+    questionnaire_parents = [time_tracker, assignee_data]
+
+    questionnaire_parents.each do |resource|
+      Decidim::Forms::Question.create!([
+                                         {
+                                           questionnaire: resource.questionnaire,
+                                           question_type: "short_answer",
+                                           body: Decidim::Faker::Localized.sentence(5),
+                                           position: 1
+                                         },
+                                         {
+                                           questionnaire: resource.questionnaire,
+                                           question_type: "single_option",
+                                           body: Decidim::Faker::Localized.sentence(5),
+                                           position: 2,
+                                           answer_options: 3.times.to_a.map { Decidim::Forms::AnswerOption.new(body: Decidim::Faker::Localized.sentence(5)) }
+                                         }
+                                       ])
+    end
+
+    # Create some tasks
+    3.times do
+      task = Decidim.traceability.create!(
+        Decidim::TimeTracker::Task,
+        admin_user,
+        name: Decidim::Faker::Localized.sentence(2),
+        time_tracker: time_tracker
+      )
+
+      # Create activites for these tasks
+      5.times do |index|
+        activity = Decidim.traceability.create!(
+          Decidim::TimeTracker::Activity,
+          admin_user,
+          description: Decidim::Faker::Localized.sentence(4),
+          active: [true, false].sample,
+          start_date: 1.week.ago + (index * 1.week),
+          end_date: 1.week.from_now + (index * 1.week),
+          max_minutes_per_day: [15, 30, 45, 60].sample,
+          requests_start_at: 1.week.ago + (index * 3.days),
+          task: task
+        )
+
+        # Add assignations
+        Decidim::User.confirmed.not_deleted.not_managed.where(admin: false).sample(10).each do |user|
+          assignee = Decidim.traceability.create!(
+            Decidim::TimeTracker::Assignee,
+            admin_user,
+            user: user
+          )
+
+          Decidim.traceability.create!(
+            Decidim::TimeTracker::TosAcceptance,
+            admin_user,
+            assignee: assignee,
+            time_tracker: time_tracker
+          )
+
+          Decidim.traceability.create!(
+            Decidim::TimeTracker::Assignation,
+            admin_user,
+            activity: activity,
+            user: user,
+            status: [:accepted, :rejected, :pending].sample,
+            invited_at: 1.week.ago,
+            invited_by_user: admin_user
+          )
+
+          questionnaire_parents.each do |resource|
+            resource.questionnaire.questions.each do |question|
+              answer = Decidim::Forms::Answer.new(
+                questionnaire: resource.questionnaire,
+                question: question,
+                session_token: activity.session_token(user)
+              )
+
+              answer.body = "My name is #{user.nickname}" if question.question_type == "short_answer"
+
+              answer.save!
+
+              next unless question.question_type == "single_option"
+
+              Decidim::Forms::AnswerChoice.create(
+                answer: answer,
+                answer_option: question.answer_options.sample,
+                body: question.body["en"]
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/decidim/time_tracker/engine.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "rails"
+require "decidim/core"
+
+module Decidim
+  module TimeTracker
+    # This is the engine that runs on the public interface of time_tracker.
+    class Engine < ::Rails::Engine
+      isolate_namespace Decidim::TimeTracker
+
+      routes do
+        # Add engine routes here
+        # resources :time_tracker
+        resources :tasks do
+          resources :activities do
+            post :start, controller: "time_events"
+            post :stop, controller: "time_events"
+
+            resources :form, controller: "activity_questionnaire", only: [:show] do
+              member do
+                post :answer
+                # for admin preview actions
+                get :preview
+                post :preview
+              end
+            end
+          end
+        end
+
+        resource :assignee_questionnaire, controller: "assignee_questionnaire", only: [:show] do
+          member do
+            post :answer
+            # for admin preview actions
+            get :preview
+            post :preview
+          end
+        end
+
+        resources :milestones, only: [:create] do
+          get :index, on: :collection, path: "(:nickname)"
+        end
+
+        resources :assignations, only: [:create]
+
+        root to: "time_tracker#index"
+      end
+
+      initializer "decidim_time_tracker.assets" do |app|
+        app.config.assets.precompile += %w(decidim_time_tracker_manifest.js decidim_time_tracker_manifest.css)
+      end
+
+      initializer "decidim.time_tracker.add_cells_view_paths" do
+        Cell::ViewModel.view_paths << File.expand_path("#{Decidim::TimeTracker::Engine.root}/app/cells")
+        Cell::ViewModel.view_paths << File.expand_path("#{Decidim::TimeTracker::Engine.root}/app/views") # for partials
+      end
+    end
+  end
+end