/solidus_reviews

:star: Basic review/rating functionality

Primary LanguageRubyBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Reviews

Build Status

Straightforward review/rating functionality, updated for Solidus. While the Gem name has changed, the module namespace and commands are still spree for now.


Installation

Add the following to your Gemfile to install from git:

gem 'solidus_reviews', github: 'solidusio-contrib/solidus_reviews'

Now bundle up with:

bundle

Next, run the rake task that copies the necessary migrations and assets to your project:

rails g solidus_reviews:install

And finish with a migrate:

rake db:migrate

Now you should be able to boot up your server with:

rails s

That's all!


Usage

Action "submit" in "reviews" controller - goes to review entry form

Users must be logged in to submit a review

Three partials:

  • app/views/spree/products/_rating.html.erb -- display number of stars
  • app/views/spree/products/_shortrating.html.erb -- shorter version of above
  • app/views/spree/products/_review.html.erb -- display a single review

Administrator can edit and/or approve and/or delete reviews.

Factories

If you want factories for our models available in your application, simply require our factories in your spec_helper.rb:

require "solidus_reviews/factories"

Implementation

Reviews table is quite obvious - and note the "approved" flag which is for the administrator to update.

Ratings table holds current fractional value - avoids frequent recalc...


Testing

Just run the following to automatically build a dummy app if necessary and run the tests:

bundle exec rake

Contributing

See corresponding contributing guidelines.


Copyright (c) 2009-2019 Solidus and contributors, released under the New BSD License