Skip to content
Straightforward review/rating functionality.
Ruby HTML Other
Find file
Latest commit b26145a @futhr futhr Fixes most cop offenses.
Failed to load latest commit information.
app Fixes most cop offenses.
bin Fixes Rails bin stub command.
config Add dutch locales
db Fixes Rails 5 timestamp deprecation warnings.
lib Fixes most cop offenses.
spec Fixes most cop offenses.
vendor/assets/javascripts
.gitignore tmp folder to .gitignore.
.hound.yml Fixes most cop offenses.
.rspec Refactor specs for RSpec 3.1.x
.rubocop.yml Add support for Hound CI.
.travis.yml Cache dependencies on Travis and test ruby 2.2.x
CHANGELOG.md Add CHANGELOG.md and bump version.
CONTRIBUTING.md Better contributors guidelines.
Gemfile Change all common cop offenses.
Guardfile
LICENSE.md Update (c) year to 2015.
README.md Update (c) year to 2015.
Rakefile Bye bye hash rockets and overflow newlines.
spree_reviews.gemspec Remove unnecessary selenium driver.

README.md

Reviews

Build Status Code Climate

Straightforward review/rating functionality.


Installation

Add the following to your Gemfile to install from git:

gem 'spree_reviews', github: 'spree-contrib/spree_reviews', branch: 'master'

Now bundle up with:

bundle

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

bundle exec rails g spree_reviews:install

And finish with a migrate:

bundle exec rake db:migrate

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

bundle exec 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.

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...


Discussion

Some points which might need modification in future:

  • I don't track the actual user on a review (just their "screen name" at the time), but we may want to use this information to avoid duplicate reviews etc. See https://github.com/spree/spree_reviews/issues/18
  • Rating votes are tied to a review, to avoid spam. However: ratings are accepted whether or not the review is accepted. Perhaps they should only be counted when the review is approved.

Contributing

See corresponding contributing guidelines.


Copyright (c) 2009-2015 Spree Commerce and contributors, released under the New BSD License

Something went wrong with that request. Please try again.