Decidim::Favorites

The gem has been developed by Mainio Tech.

A Decidim module that provides the possibility to add any objects (proposals, plans, projects, results, etc.) to user's personal favorites.

This is a technical module that adds this ability to Decidim but the favorites functionality needs to be manually added to the individual models and the favorite buttons need to be added to the views.

Development of this gem has been sponsored by the City of Helsinki.

Installation

Add this line to your application's Gemfile:

gem "decidim-favorites"

And then execute:

$ bundle
$ bundle exec rails decidim_favorites:install:migrations

Usage

Add this to the model you want to make favoritable:

class YourModel < ApplicationRecord
  include Decidim::Favorites::Favoritable
  # ...
end

And then include the following cell to display the add to favorites button:

<%== cell("decidim/favorites/favorite_button", model, hide_text: true) %>

Or alternatively with text:

<%== cell("decidim/favorites/favorite_button", model, disable_tooltip: true) %>

You can also include the following cell in order to show the number of times someone has added the record to their favorites (funny name, couldn't think of a better one):

<%== cell("decidim/favorites/favorites_count", model) %>

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.

License

See LICENSE-AGPLv3.txt.