https://github.com/gregmolnar/spree_reviews

https://github.com/gregmolnar/spree_reviews

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/gregmolnar/spree_reviews
• Owner: gregmolnar
• Created: 2014-03-30T18:14:09.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2014-03-30T18:14:16.000Z (about 12 years ago)
• Last Synced: 2025-03-02T01:18:34.947Z (over 1 year ago)
• Language: Ruby
• Size: 344 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
Reviews

=======

Straightforward review/rating facility

Please see TODO file

Installation

------------

To use the last stable gem release of spree_reviews, add the following to your Gemfile:

    gem 'spree_reviews'

    

If you'd rather install the latest version with fixes and improvements that have not yet been published to RubyGems, install from git:

    gem 'spree_reviews', :git => 'git://github.com/spree/spree_reviews.git'

Now bundle up with:

    bundle

    

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

    rails g spree_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/products/_rating.html.erb  -- display number of stars

 - ./app/views/products/_shortrating.html.erb -- shorter version of above

 - ./app/views/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.

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