Decidim::TimeTracker

WARNING This is not ready for production usage yet (though soon will be).

A tool for Decidim that allows to track time dedicated by volunteers doing any arbitrary task.

Usage

TimeTracker will be available as a Component for a Participatory Space.

Installation

Add this line to your application's Gemfile:

gem "decidim-time_tracker", git: "https://github.com/Platoniq/decidim-module-time_tracker"

And then execute:

bundle
bundle exec rails decidim_time_tracker:install:migrations
bundle exec rails db:migrate

About Time tracker and attached questionnaires

By default, every time tracker component has an attached questionnaire for the volunteer to fill with their personal data and to give their consent to the T&C (further referenced as questionnaire for assignees). Activities have also an attached questionnaire for the volunteer to fill when they request to be assigned to that activity (further referenced as questionnaire for activities). This is a very simple questionnaire with questions about how certain tasks may usually be perceived as related to certain genders. This can be useful to have a better understanding of the perception of tasks and their real gender assignation.

Both questionnaires are enabled by default and can be customized. You may also disable the questionnaire shown for activities. However, take into account that administrators can always modify or create custom questionnaires.

If you want to customize the default questionnaires or disable the questionnaire for activities, just create a new initializer in config/initializers/time_tracker.rb with the following content:

To use your own questionnaire for assignees (use config/default_assignee_questionnaire.yml as an example guide):

# config/initializers/time_tracker.rb

# Initialize my custom questionnaire placed in config/my_questionnaire.yml
Decidim::TimeTracker.configure do |config|
  config.default_assignee_questionnaire_seeds = YAML.load_file File.join(Rails.root, 'config', 'my_assignee_questionnaire.yml')
end

To use your own questionnaire for activities (use config/default_activity_questionnaire.yml as an example guide):

# config/initializers/time_tracker.rb

# Initialize my custom questionnaire placed in config/my_questionnaire.yml
Decidim::TimeTracker.configure do |config|
  config.default_activity_questionnaire_seeds = YAML.load_file File.join(Rails.root, 'config', 'my_activities_questionnaire.yml')
end

To completely disable the default questionnaire for activities:

# config/initializers/time_tracker.rb

# Disable the default questionnaire for time tracker
Decidim::TimeTracker.configure do |config|
  config.default_activity_questionnaire_seeds = nil
end

NOTE: If you customize your questionnaires, you can use any I18n key to translate it. Just add it to your locales. You also can just put a direct text with no translations, then it will be used for all languages.

Contributing

See Decidim.

Developing

To start contributing to this project, first:

Install the basic dependencies (such as Ruby and PostgreSQL)
Clone this repository

Decidim's main repository also provides a Docker configuration file if you prefer to use Docker instead of installing the dependencies locally on your machine.

You can create the development app by running the following commands after cloning this project:

bundle
DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rake development_app

Note that the database user has to have rights to create and drop a database in order to create the dummy test app database.

Then to test how the module works in Decidim, start the development server:

cd development_app
DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rails s

In case you are using rbenv and have the rbenv-vars plugin installed for it, you can add the environment variables to the root directory of the project in a file named .rbenv-vars. If these are defined for the environment, you can omit defining these in the commands shown above.

Code Styling

Please follow the code styling defined by the different linters that ensure we are all talking with the same language collaborating on the same project. This project is set to follow the same rules that Decidim itself follows.

Rubocop linter is used for the Ruby language.

You can run the code styling checks by running the following commands from the console:

bundle exec rubocop

To ease up following the style guide, you should install the plugin to your favorite editor, such as:

Atom - linter-rubocop
Sublime Text - Sublime RuboCop
Visual Studio Code - Rubocop for Visual Studio Code

Testing

To run the tests run the following in the gem development path:

bundle
DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rake test_app
DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rspec

Note that the database user has to have rights to create and drop a database in order to create the dummy test app database.

In case you are using rbenv and have the rbenv-vars plugin installed for it, you can add these environment variables to the root directory of the project in a file named .rbenv-vars. In this case, you can omit defining these in the commands shown above.

Test code coverage

If you want to generate the code coverage report for the tests, you can use the SIMPLECOV=1 environment variable in the rspec command as follows:

SIMPLECOV=1 bundle exec rspec

This will generate a folder named coverage in the project root which contains the code coverage report.

Localization

If you would like to see this module in your own language, you can help with its translation at Crowdin:

https://crowdin.com/project/decidim-module-time_tracker

License

This engine is distributed under the GNU AFFERO GENERAL PUBLIC LICENSE.

octree-gva/decidim-module-time_tracker