spree_reviews_rating 0.70.5

data/app/assets/stylesheets/admin/spree_reviews_rating.css

@@ -0,0 +1,3 @@
+/*
+ *= require admin/spree_core
+*/

data/app/assets/stylesheets/store/spree_reviews_rating.css

@@ -0,0 +1,95 @@
+#reviews {
+	padding: 10px;
+}
+
+#reviews h6 {
+	font-size: 16pt;
+	margin: 0px;
+}
+
+#reviews div.header {
+  font-size: 12pt;
+  font-weight: bold;
+  border-bottom: 1px #2222aa dashed;
+  margin-top: 10px;
+  margin-bottom: 10px;
+}
+
+#reviews div.review {
+  border-bottom: 1px #2222aa dashed;
+  margin-bottom: 10px;
+}
+
+#reviews div.review span.title {
+  font-size: 11pt;
+  font-weight: bold;
+}
+
+#reviews div.review span.attribution {
+  font-size: 8pt;
+}
+.ratings p {
+	font-size: 12px;
+	margin: 5px;
+}
+.button-review, .cancel-review {
+	color: #C2C2C2;
+	text-decoration: none;
+}
+.button-review:hover, .cancel-review:hover {
+	text-decoration: underline;
+}
+
+#new_review h6 {
+	font-size: 10pt;
+	margin: 0px;
+	padding: 5px 3px;
+}
+
+#new_review .review_name_field {
+	font-size: 12px;
+	margin-top: 5px;
+}
+#new_review p {
+	margin-top: 5px;
+	margin-bottom: 0px;
+}
+
+#new_review .review_name_field input {
+	width: 200px;
+	height: 28px;
+	padding: 1px;
+	margin-bottom: 14px;
+}
+
+#new_review .review_review_field textarea {
+	width: 200px;
+	height: 80px;
+	padding: 1px;
+}
+
+.lit {
+  background-color: #aaaaaa;
+  color: #0000bb;
+  margin-right: 1px;
+  padding-left: 1px;
+}
+
+.unlit {
+  background-color: #aaaaaa;
+  color: #000000;
+  margin-right: 1px;
+  padding-left: 1px;
+}
+
+.star-rating-control {
+  display: inline-block;
+  height: 15px;
+}
+
+.review_hr {
+  size: 1px;
+  background: silver;
+  border: none;
+  margin: 1em 0;
+}

data/app/controllers/admin/feedback_reviews_controller.rb

@@ -0,0 +1,6 @@
+class Admin::FeedbackReviewsController <  Admin::ResourceController
+  def index
+    @review = Review.find(params[:review_id])
+    @collection = @review.feedback_reviews
+  end
+end

data/app/controllers/admin/review_settings_controller.rb

@@ -0,0 +1,16 @@
+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?
+    params[:preferences][:feedback_rating] = false            if params[:preferences][:feedback_rating].blank?
+    params[:preferences][:show_email] = false                 if params[:preferences][:show_email].blank?
+    params[:preferences][:require_login] = false              if params[:preferences][:require_login].blank?
+    Spree::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,20 @@
+class Admin::ReviewsController < Admin::ResourceController
+  helper ReviewsHelper
+
+  def index
+    @unapproved_reviews = Review.not_approved.find(:all, :order => "created_at DESC")
+    @approved_reviews   = Review.approved.find(:all, :order => "created_at DESC")
+  end
+
+  def approve
+    r = Review.find(params[:id])
+
+    if r.update_attribute(:approved, true)
+       r.product.recalculate_rating
+       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,20 @@
+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])
+    if @review && @feedback_review = @review.feedback_reviews.new(params[:feedback_review])
+      authorize! :create, @feedback_review
+      @feedback_review.save
+    end
+
+    respond_to do |format|
+      format.html { redirect_to :back  }
+      format.js   { render :action => :create }
+    end
+
+  end
+end
+

data/app/controllers/products_controller_decorator.rb

@@ -0,0 +1,3 @@
+ProductsController.class_eval do
+  helper ReviewsHelper
+end

data/app/controllers/reviews_controller.rb

@@ -0,0 +1,52 @@
+class ReviewsController < Spree::BaseController
+  helper Spree::BaseHelper
+  
+  before_filter :load_product, :only => [:index, :new, :create]
+  rescue_from ActiveRecord::RecordNotFound, :with => :render_404
+
+  def index
+    @approved_reviews = Review.approved.find_all_by_product_id(@product.id)
+  end
+  
+  def all_list
+    @approved_reviews = Review.approved.order("created_at DESC")
+    respond_to do |f|
+      f.html
+    end
+  end
+
+  def new
+    @review = Review.new(:product => @product)
+    authorize! :new, @review
+    render :layout => false
+  end
+
+  # save if all ok
+  def create
+    #params[:review][:rating].sub!(/\s*stars/,'') unless params[:review][:rating].blank?
+
+    @review = Review.new(params[:review])
+    @review.product = @product
+    @review.user = current_user if user_signed_in?
+    @review.location = request.remote_ip
+
+    authorize! :create, @review
+
+    if @review.save
+      flash[:notice] = t('review_successfully_submitted')
+      redirect_to (product_path(@product))
+    else
+      render :action => "new"
+    end
+  end
+
+  def terms
+  end
+
+  private
+
+    def load_product
+      @product = Product.find_by_permalink!(params[:product_id])
+    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,11 @@
+module ReviewsHelper
+  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/app_configuration_decorator.rb

@@ -0,0 +1,16 @@
+AppConfiguration.class_eval do
+  # 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
+
+  # show a reviewer's email address
+  preference :show_email, :boolean, :default => false
+
+  # show helpfullness rating form elements
+  preference :feedback_rating, :boolean, :default => false
+
+  # require login to post reviews
+  preference :require_login, :boolean, :default => true
+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("created_at DESC")
+
+end

data/app/models/product_decorator.rb

@@ -0,0 +1,16 @@
+Product.class_eval do
+  has_many :reviews
+
+  def get_stars
+    {:star => avg_rating.round, :rcount => reviews_count}
+  end
+
+  def recalculate_rating
+    reviews_count = reviews.reload.approved.count
+    if reviews_count > 0
+      self.update_attributes(:avg_rating => self.reviews.approved.sum(:rating).to_f / reviews_count, :reviews_count => reviews_count)
+    else
+      self.update_attribute :avg_rating, 0
+    end
+  end
+end

data/app/models/review.rb

@@ -0,0 +1,21 @@
+class Review < ActiveRecord::Base
+  belongs_to :product
+  belongs_to :user
+  has_many   :feedback_reviews
+
+  validates_presence_of :name, :review
+  validates_numericality_of :rating, :only_integer => true
+  default_scope order("created_at DESC")
+  scope :not_approved, where("approved = ?", false)
+
+  scope :approved, lambda {|*args| {:conditions => ["(? = ?) or (approved = ?)", Spree::Config[:include_unapproved_reviews], true, true ]}}
+
+  scope :oldest_first, :order => "created_at asc"
+  scope :preview,      :limit => Spree::Config[:preview_size], :order => "created_at desc"
+  attr_protected :user_id, :product_id, :location
+
+  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/review_sweeper.rb

@@ -0,0 +1,21 @@
+class ReviewSweeper < ActionController::Caching::Sweeper
+  observe Review
+
+  def after_create(review)
+    expire_cache_for(review)
+  end
+
+  def after_update(review)
+    expire_cache_for(review)
+  end
+
+  def after_destroy(review)
+    expire_cache_for(review)
+  end
+
+  private
+
+  def expire_cache_for(review)
+    review.product.recalculate_rating
+  end
+end

data/app/models/reviews_ability.rb

@@ -0,0 +1,12 @@
+class ReviewsAbility
+  include CanCan::Ability
+
+  def initialize(user)
+    can :create, Review do |review|
+      user.has_role?(:user) || !Spree::Config[:require_login]
+    end
+    can :create, FeedbackReview do |review|
+      user.has_role?(:user) || !Spree::Config[:require_login]
+    end
+  end
+end

data/app/overrides/add_review_bottom_sidebar.rb

@@ -0,0 +1,4 @@
+Deface::Override.new(:virtual_path => "layouts/spree_application",
+                     :name => "review_sidebar",
+                     :insert_bottom => "div#sidebar",
+                     :partial => "shared/review_link")

data/app/overrides/add_reviews_after_product_properties.rb

@@ -0,0 +1,4 @@
+Deface::Override.new(:virtual_path => "products/show",
+                     :name => "converted_product_properties_767643482",
+                     :insert_after => "[data-hook='product_properties']",
+                     :partial => "shared/reviews")

data/app/overrides/add_reviews_tab_to_admin.rb

@@ -0,0 +1,4 @@
+Deface::Override.new(:virtual_path => "admin/shared/_product_sub_menu",
+                     :name => "reviews_admin_tab",
+                     :insert_bottom => "[data-hook='admin_product_sub_tabs']",
+                     :text => "<%= tab(:reviews, :label => 'review_management') %>")

data/app/overrides/add_reviews_to_admin_configuration_menu.rb

@@ -0,0 +1,4 @@
+Deface::Override.new(:virtual_path => "admin/configurations/index",
+                     :name => "converted_admin_configurations_menu_286465532",
+                     :insert_after => "[data-hook='admin_configurations_menu']",
+                     :text => "<%= configurations_menu_item(t('spree_reviews.review_settings'), admin_review_settings_path, t('spree_reviews.manage_review_settings')) %>")

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,30 @@
+<%= render :partial => 'admin/shared/configuration_menu' %>
+
+<h1><%= t("spree_reviews.review_settings") %></h1>
+
+<%= form_tag(admin_review_settings_path, :method => :put) do %>
+  <p>
+    <label><%= t("spree_reviews.include_unapproved") %>:</label>
+    <%= check_box_tag('preferences[include_unapproved_reviews]', "1", Spree::Config[:include_unapproved_reviews]) %>
+  </p>
+  <p>
+    <label><%= t("spree_reviews.feedback_rating") %>:</label>
+    <%= check_box_tag('preferences[feedback_rating]', "1", Spree::Config[:feedback_rating]) %>
+  </p>
+  <p>
+    <label><%= t("spree_reviews.show_email") %>:</label>
+    <%= check_box_tag('preferences[show_email]', "1", Spree::Config[:show_email]) %>
+  </p>
+  <p>
+    <label><%= t("spree_reviews.require_login") %>:</label>
+    <%= check_box_tag('preferences[require_login]', "1", Spree::Config[:require_login]) %>
+  </p>
+  <p>
+    <label><%= t('spree_reviews.preview_size') %>:</label>
+    <%= text_field_tag('preferences[preview_size]', Spree::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 %>

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

@@ -0,0 +1,30 @@
+<%= render :partial => 'admin/shared/configuration_menu' %>
+
+<h1><%= t("spree_reviews.review_settings") %></h1>
+
+<table>
+  <tr>
+    <th scope="row"><%= t("spree_reviews.include_unapproved") %>:</th>
+    <td><%= Spree::Config[:include_unapproved_reviews] ? t('yes') : t('no') %></td>
+  </tr>
+  <tr>
+    <th scope="row"><%= t("spree_reviews.feedback_rating") %>:</th>
+    <td><%= Spree::Config[:feedback_rating] ? t('yes') : t('no') %></td>
+  </tr>
+  <tr>
+    <th scope="row"><%= t("spree_reviews.show_email") %>:</th>
+    <td><%= Spree::Config[:show_email] ? t('yes') : t('no') %></td>
+  </tr>
+  <tr>
+    <th scope="row"><%= t("spree_reviews.require_login") %>:</th>
+    <td><%= Spree::Config[:require_login] ? t('yes') : t('no') %></td>
+  </tr>
+  <tr>
+    <th scope="row"><%= t("spree_reviews.preview_size") %>:</th>
+    <td><%= Spree::Config[:preview_size] %></td>
+  </tr>
+</table>
+
+<p>
+  <%= link_to_with_icon('edit', t("edit"), edit_admin_review_settings_path) %>
+</p>