spree_reviews 0.30.0

data/README.markdown

@@ -0,0 +1,43 @@
+Reviews
+=======
+
+Straightforward review/rating facility
+
+Please see TODO file
+
+
+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.

data/Rakefile

@@ -0,0 +1,120 @@
+# I think this is the one that should be moved to the extension Rakefile template
+
+# In rails 1.2, plugins aren't available in the path until they're loaded.
+# Check to see if the rspec plugin is installed first and require
+# it if it is.  If not, use the gem version.
+
+# Determine where the RSpec plugin is by loading the boot
+unless defined? SPREE_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["SPREE_ENV_FILE"]
+    require File.dirname(ENV["SPREE_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/SPREE/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+rspec_base = File.expand_path(SPREE_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+# require 'spec/translator'
+
+# Cleanup the SPREE_ROOT constant so specs will load the environment
+Object.send(:remove_const, :SPREE_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => :spec
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  
+  # Hopefully no one has written their extensions in pre-0.9 style
+  # desc "Translate specs from pre-0.9 to 0.9 style"
+  # task :translate do
+  #   translator = ::Spec::Translator.new
+  #   dir = RAILS_ROOT + '/spec'
+  #   translator.translate(dir, dir)
+  # end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the reviews extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ReviewsExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# For extensions that are in transition
+desc 'Test the reviews extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/TODO

@@ -0,0 +1,8 @@
+
+0. partial(s) for selecting _approved_ reviews to read
+
+1. REST routes needed in some places?
+
+2. only accept ratings for approved reviews?
+
+3. allow stand alone rating values?

data/app/controllers/admin/feedback_reviews_controller.rb

@@ -0,0 +1,16 @@
+class Admin::FeedbackReviewsController <  Admin::BaseController
+  resource_controller
+  belongs_to :review
+
+  create.response do |wants|
+    wants.html { redirect_to collection_path }
+  end
+
+  update.response do |wants|
+    wants.html { redirect_to collection_path }
+  end
+
+  destroy.response do |wants|
+    wants.html { redirect_to collection_path }
+  end
+end

data/app/controllers/admin/review_settings_controller.rb

@@ -0,0 +1,13 @@
+class Admin::ReviewSettingsController < Admin::BaseController
+  def update
+    # workaround for unset checkbox behaviour
+    params[:preferences][:include_unapproved_reviews] = false if params[:preferences][:include_unapproved_reviews].blank?
+    Spree::Reviews::Config.set(params[:preferences])
+
+    respond_to do |format|
+      format.html {
+        redirect_to admin_review_settings_path
+      }
+    end
+  end
+end

data/app/controllers/admin/reviews_controller.rb

@@ -0,0 +1,36 @@
+class Admin::ReviewsController < Admin::BaseController
+   
+  layout 'admin'
+
+  resource_controller
+
+  index.before do 
+    @unapproved_reviews = Review.not_approved.find(:all, :order => "created_at DESC")
+    @approved_reviews   = Review.approved.find(:all, :order => "created_at DESC")
+  end
+
+  create.response do |wants|
+    wants.html { redirect_to admin_reviews_path }
+  end
+
+  update.response do |wants|
+    wants.html { redirect_to admin_reviews_path }
+  end
+
+  def approve
+    r = Review.find(params[:id])
+
+    r.approved = true
+    if r.product.rating.nil? 
+      r.product.rating = Rating.create :value => 0, :count => 0
+    end
+    r.product.rating.add_rating(r.rating)
+
+    if r.save
+       flash[:notice] = t("info_approve_review")
+    else
+       flash[:error] = t("error_approve_review")
+    end
+    redirect_to admin_reviews_path
+  end
+end

data/app/controllers/feedback_reviews_controller.rb

@@ -0,0 +1,17 @@
+class FeedbackReviewsController < Spree::BaseController
+  helper Spree::BaseHelper
+  def create
+    params[:feedback_review][:rating].sub!(/\s*stars/,'') unless params[:feedback_review][:rating].blank?
+
+    @review = Review.find_by_id(params[:review_id])
+    @review &&
+      (@feedback_review = @review.feedback_reviews.new(params[:feedback_review])) && @feedback_review.save
+
+    respond_to do |format|
+      format.html { redirect_to :back  }
+      format.js   { render :action => :create }
+    end
+
+  end
+end
+

data/app/controllers/reviews_controller.rb

@@ -0,0 +1,30 @@
+class ReviewsController < Spree::BaseController
+  helper Spree::BaseHelper
+
+  def index
+    @product = Product.find_by_permalink params[:product_id]
+    @approved_reviews = Review.approved.find_all_by_product_id(@product.id) 
+  end
+
+  def new
+    @product = Product.find_by_permalink params[:product_id] 
+    @review = Review.new :product => @product
+  end
+
+  # save if all ok
+  def create
+    @product = Product.find_by_permalink params[:product_id]
+    params[:review][:rating].sub!(/\s*stars/,'') unless params[:review][:rating].blank?
+
+    @review = Review.new :product => @product
+    if @review.update_attributes(params[:review]) 
+      flash[:notice] = t('review_successfully_submitted')
+      redirect_to (product_path(@product))
+    else
+      # flash[:notice] = 'There was a problem in the submitted review'
+      render :action => "new" 
+    end
+  end
+  def terms
+  end
+end

data/app/helpers/admin/feedback_reviews_helper.rb

@@ -0,0 +1,2 @@
+module Admin::FeedbackReviewsHelper
+end

data/app/helpers/feedback_reviews_helper.rb

@@ -0,0 +1,2 @@
+module FeedbackReviewsHelper
+end

data/app/helpers/reviews_helper.rb

@@ -0,0 +1,17 @@
+module ReviewsHelper
+
+  def star(the_class) 
+    "<span class=\"#{the_class}\"> &#10030; </span>"
+  end
+
+  def mk_stars(m)
+    (1..5).collect {|n| n <= m ? star("lit") : star("unlit") }.join
+  end
+  
+  def txt_stars(n, show_out_of = true)
+    res = I18n.t('star', :count => n)
+    res += ' ' + t('out_of_5') if show_out_of
+    res
+  end
+
+end

data/app/models/feedback_review.rb

@@ -0,0 +1,10 @@
+class FeedbackReview < ActiveRecord::Base
+  belongs_to :review
+  belongs_to :user
+
+  validates_presence_of :review_id
+  validates_numericality_of :rating, :only_integer => true, :greater_than_or_equal_to => 1, :less_than_or_equal_to => 5, :message => I18n.t('you_must_enter_value_for_rating')
+
+  default_scope order("feedback_reviews.created_at DESC")
+
+end

data/app/models/product_decorator.rb

@@ -0,0 +1,14 @@
+# Add access to reviews/ratings to the product model
+Product.class_eval do
+  has_one :rating
+  has_many :reviews
+
+  def get_stars
+    if rating.nil?
+      [0,0]
+    else
+      [rating.get_stars, rating.count]
+    end
+  end
+
+end

data/app/models/rating.rb

@@ -0,0 +1,20 @@
+class Rating < ActiveRecord::Base
+  belongs_to :product
+
+  NB_STARS=5
+  def self.get_nb_stars
+    NB_STARS
+  end
+
+  def add_rating(n)
+    self.value = value * count + n
+    self.count = count + 1
+    self.value = value / count
+    save
+  end
+  
+  def get_stars
+    (self.value + 0.5).floor
+  end
+  
+end

data/app/models/review.rb

@@ -0,0 +1,20 @@
+class Review < ActiveRecord::Base
+  belongs_to :product
+  has_many   :feedback_reviews
+
+  validates_presence_of :title, :review
+  validates_numericality_of :rating, :only_integer => true
+  default_scope order("reviews.created_at DESC")
+  scope :approved,  where("approved = ?", true)
+  scope :not_approved, where("approved = ?", false)
+
+  scope :approval_filter, lambda {|*args| {:conditions => ["(? = ?) or (approved = ?)", Spree::Reviews::Config[:include_unapproved_reviews], true, true ]}}
+
+  scope :oldest_first, :order => "created_at asc"
+  scope :preview,      :limit => Spree::Reviews::Config[:preview_size], :order=>"created_at desc"
+
+  def feedback_stars
+    return 0 if feedback_reviews.count <= 0
+    ((feedback_reviews.sum(:rating)/feedback_reviews.count) + 0.5).floor
+  end
+end

data/app/models/reviews_configuration.rb

@@ -0,0 +1,7 @@
+class ReviewsConfiguration < Configuration
+  # include non-approved reviews in (public) listings 
+  preference :include_unapproved_reviews, :boolean, :default => 'false'
+
+  # control how many reviews are shown in summaries etc.
+  preference :preview_size, :integer, :default => 3
+end

data/app/views/admin/feedback_reviews/index.html.erb

@@ -0,0 +1,21 @@
+<h1><%= link_to t('feedback_review_for', :review => @review.title ), admin_reviews_path %></h1>
+
+
+<table class="index">
+  <tr>
+    <th><%= t('date_') %></th>
+    <th><%= t('user') %></th>
+    <th><%= t('stars') %></th>
+    <th></th>
+  </tr>
+  <% collection.each do |feedback| %>
+    <tr id="<%= dom_id(feedback) %>">
+      <td><%= l feedback.created_at %></td>
+      <td><%= feedback.user.try(:login) || "anonimus" %></td>
+      <td><%= feedback.rating %></td>
+      <td class="actions">
+        <%= link_to_delete feedback  %>
+      </td>
+    </tr>
+  <% end %>
+</table>

data/app/views/admin/review_settings/edit.html.erb

@@ -0,0 +1,18 @@
+<%= render :partial => 'admin/shared/configuration_menu' %>
+
+<h1><%= t("reviews.review_settings") %></h1>
+
+<% form_tag(admin_review_settings_path, :method => :put) do -%>
+  <p>
+    <label><%= t("reviews.include_unapproved") %>:</label>
+    <%= check_box_tag('preferences[include_unapproved_reviews]', "1", Spree::Reviews::Config[:include_unapproved_reviews]) %>
+  </p>
+  <p>
+    <label><%= t('reviews.preview_size') %>:</label>
+    <%= text_field_tag('preferences[preview_size]', Spree::Reviews::Config[:preview_size], :size => 3) %>
+  </p>
+  <p class="form-buttons">
+    <%= button t('update') %>
+    <%= t("or") %> <%= link_to t("cancel"), admin_review_settings_url %>
+  </p>
+<% end -%>