spree_reviews_rating 0.70.7.1 → 1.0.0

data/README.md

@@ -1,21 +1,22 @@
-Reviews
+SpreeReviewsRating
 =======
 
 Straightforward review/rating facility
 
 
-Installation
-------------
+Basic Installation
+------------------
+
 1. Add the following to your Gemfile
 <pre>
-  gem 'spree_reviews_rating', '~> 0.70.7.1'
+  gem 'spree_reviews_rating', '~> 1.0.0'
 </pre>
 2. Run `bundle install`
 3. To copy and apply migrations run:
 <pre>
 	rails g spree_reviews_rating:install
 </pre>
-
+    
 
 Usage
 -----
@@ -26,5 +27,4 @@ Usage
 
 3. Administrator can edit and/or approve and/or delete reviews.
 
-
-Copyright (c) 2012 [Damiano Giacomello], released under the New BSD License
+Copyright (c) 2012 [Damiano Giacomello], released under the New BSD License

data/app/assets/javascripts/store/review/index.js

@@ -1,15 +1,16 @@
 $(document).ready(function(){
 
-  $('.button-review').click(function (event) {
-    event.preventDefault();
-    $(this).hide();
-	$(".ratings").hide();
-    $.ajax({
-		type: 'GET',
-		url: this.href,
-		data: ({authenticity_token: jQuery('meta[name="csrf-token"]').attr('content')}),
-		beforeSend: function(r){ $('#new_review').html('<p style="padding: 20px">Loading <img src="/assets/ratyloader.gif"/></p>');},
-		success: function(r){ $('#new_review').html(r);} });
-  });
-
+	$('.button-review').click(function (event) {
+		event.preventDefault();
+		$(this).hide();
+		$(".ratings").hide();
+		$.ajax({
+			type: 'GET',
+			url: this.href,
+			data: ({authenticity_token: jQuery('meta[name="csrf-token"]').attr('content')}),
+			beforeSend: function(r){ $('#new_review').html('<p style="padding: 20px">Loading <img src="/assets/ratyloader.gif"/></p>');},
+			success: function(r){ $('#new_review').html(r);}
+		});
+	});
+	
 });

data/app/assets/javascripts/store/spree_reviews_rating.js

@@ -1,3 +1,4 @@
+//= require store/spree_core
 /*
  * jQuery Raty - A Star Rating Plugin - http://wbotelhos.com/raty
  * ---------------------------------------------------------------------
@@ -435,9 +436,9 @@
 		single:			false,
 		size:			16,
 		space:			true,
-		starHalf:		'star-half-big.png',
-		starOff:		'star-off-big.png',
-		starOn:			'star-on-big.png',
+		starHalf:		'star-half.png',
+		starOff:		'star-off.png',
+		starOn:			'star-on.png',
 		start:			0,
 		target:			undefined,
 		targetFormat:	'{score}',
@@ -447,4 +448,14 @@
 		width:			undefined
 	};
 
-})(jQuery);
+})(jQuery);
+
+$(function() {
+	$(".review_submit").live("click", function() {
+		$(this).parents("form:first").validate();
+		$(this).parents("form:first").submit();
+		$(this).parents("form:first").hide();
+		$("#new_review").removeClass().html('<p style="padding: 20px">Loading <img src="/assets/ratyloader.gif"/></p>')
+		return false;
+	});
+});

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

@@ -14,4 +14,4 @@
 }
 .formtastic button:hover {
 	text-shadow: #FFFFFF -1px -1px 0px;
-}
+}

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

@@ -1,3 +1,11 @@
+/*
+ *= require store/spree_core
+*/
+
+#new-star img {
+	float: left;
+}
+
 #reviews {
 	padding: 10px;
 }
@@ -68,6 +76,27 @@
 	padding: 1px;
 }
 
+.review .author {
+	float: left;
+}
+
+.right {
+	float: right !important;
+}
+
+.single_rating {
+	margin-right: 3px;
+}
+
+.single_rating.rate {
+	width: 180px;
+}
+
+.review .single_rating, .review .average {
+	float: left;
+	margin-left: 5px;
+}
+
 .lit {
   background-color: #aaaaaa;
   color: #0000bb;
@@ -92,4 +121,18 @@
   background: silver;
   border: none;
   margin: 1em 0;
+}
+
+.s_bgmsg_red {
+	color: #84290A;
+	background-color: #FFE7DF !important;
+	width: 320px;
+	padding: 5px;
+}
+
+.s_bgmsg_green {
+	color: #468847;
+	background-color: #D6E9C6 !important;
+	width: 320px;
+	padding: 5px;
 }

data/app/controllers/spree/admin/review_settings_controller.rb

@@ -0,0 +1,25 @@
+module Spree
+  module Admin
+    class ReviewSettingsController < ResourceController
+      
+      def show
+        @preferences = ['preview_size']
+      end
+
+      def edit
+        @preferences = [:include_unapproved_reviews, :show_email,
+                        :require_login, :form_show, :preview_size, :star_big]
+      end
+      
+      def update
+        params.each do |name, value|
+          next unless Spree::Config.has_preference? name
+          Spree::Config[name] = value
+        end
+        
+        redirect_to admin_review_settings_path
+      end
+    
+    end
+  end
+end

data/app/controllers/spree/admin/reviews_controller.rb

@@ -0,0 +1,30 @@
+module Spree
+  module Admin
+    class ReviewsController < ResourceController
+      
+      helper 'spree/reviews'
+      before_filter :load_data
+      
+      def index
+        @unapproved_reviews = Spree::Review.not_approved.find(:all, :order => "created_at DESC")
+        @approved_reviews   = Spree::Review.approved.find(:all, :order => "created_at DESC")
+      end
+
+      def approve
+        r = Spree::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 spree.admin_reviews_path
+      end
+      
+      def load_data
+        @reviews = Spree::Review.all
+      end
+    end
+  end
+end

data/app/controllers/spree/products_controller_decorator.rb

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

data/app/controllers/spree/reviews_controller.rb

@@ -0,0 +1,55 @@
+module Spree
+  class ReviewsController < BaseController
+    helper Spree::BaseHelper
+
+    before_filter :load_product, :only => [:index, :new, :create]
+    rescue_from ActiveRecord::RecordNotFound, :with => :render_404
+
+    def index
+      @approved_reviews = Spree::Review.approved.find_all_by_product_id(@product.id)
+    end
+
+    def all_list
+      @approved_reviews = Spree::Review.approved.order("created_at DESC")
+      respond_to do |f|
+        f.html
+      end
+    end
+
+    def new
+      @review = Spree::Review.new(:product => @product)
+      authorize! :new, @review
+      render :layout => false
+    end
+    
+    def create
+      #params[:review][:rating].sub!(/\s*stars/,'') unless params[:review][:rating].blank?
+
+      @review = Spree::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')
+        respond_to do |format|
+          format.js { render "success" }
+        end
+      else
+        respond_to do |format|
+          format.js { render "error" }
+        end
+      end
+    end
+
+    def terms
+    end
+
+    private
+    def load_product
+      @product = Spree::Product.find_by_permalink!(params[:product_id])
+    end
+  end
+end

data/app/helpers/spree/reviews_helper.rb

@@ -0,0 +1,14 @@
+module Spree
+  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
+end

data/app/models/spree/ability_decorator.rb

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

data/app/models/{app_configuration_decorator.rb → spree/app_configuration_decorator.rb}

@@ -1,4 +1,4 @@
-AppConfiguration.class_eval do
+Spree::AppConfiguration.class_eval do
   
   # include non-approved reviews in (public) listings
   preference :include_unapproved_reviews, :boolean, :default => false
@@ -6,8 +6,11 @@ AppConfiguration.class_eval do
   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
+  # not view form immediatly
+  preference :form_show, :boolean, :default => true
+  # user star big or normal
+  preference :star_big, :boolean, :default => false
+  
 end

data/app/models/spree/product_decorator.rb

@@ -0,0 +1,17 @@
+Spree::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/spree/review.rb

@@ -0,0 +1,18 @@
+module Spree
+  class Review < ActiveRecord::Base
+    belongs_to :product
+    belongs_to :user
+
+    validates_presence_of :name, :review
+    validates_numericality_of :rating, :if => Proc.new {|r| !r.rating.blank?}
+    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
+    
+  end
+end

data/app/models/spree/review_sweeper.rb

@@ -0,0 +1,24 @@
+module Spree
+  class ReviewSweeper < ActionController::Caching::Sweeper
+    observe Spree::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
+end

data/app/models/spree/user_decorator.rb

@@ -0,0 +1,7 @@
+Spree::User.class_eval do
+  before_create :set_role
+  
+  def set_role
+    self.role_ids = Spree::Role.find_by_name("user").id
+  end    
+end

data/app/overrides/add_review_bottom_sidebar.rb

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

data/app/overrides/reviews_admin_configuration_menu.rb

@@ -0,0 +1,11 @@
+Deface::Override.new(:virtual_path => "spree/admin/shared/_configuration_menu",
+                     :name => "add_review_settings_link_configuration_menu",
+                     :insert_bottom => "[data-hook='admin_configurations_sidebar_menu']",
+                     :text => %q{<%= configurations_sidebar_menu_item t("reviews_rating.review_settings"), admin_review_settings_path %>},
+                     :disabled => false)
+
+Deface::Override.new(:virtual_path => "spree/admin/configurations/index",
+                     :name => "add_review_settings_to_configuration_menu",
+                     :insert_after => "[data-hook='admin_configurations_menu']",
+                     :partial => "spree/admin/shared/reviews_setting_configurations_menu",
+                     :disabled => false)

data/app/overrides/{add_reviews_tab_to_admin.rb → reviews_admin_tab.rb}

@@ -1,4 +1,4 @@
-Deface::Override.new(:virtual_path => "admin/shared/_product_sub_menu",
+Deface::Override.new(:virtual_path => "spree/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/reviews_global_rating_product.rb

@@ -0,0 +1,4 @@
+Deface::Override.new(:virtual_path => "spree/products/show",
+                     :name => "reviews_global_rating",
+                     :insert_bottom => "dd#global_rating",
+                     :partial => "spree/shared/rating")

data/app/overrides/reviews_product_properties.rb

@@ -0,0 +1,4 @@
+Deface::Override.new(:virtual_path => "spree/products/show",
+                     :name => "converted_product_properties_767643482",
+                     :insert_bottom => "div#product_reviews",
+                     :partial => "spree/shared/reviews")

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

@@ -0,0 +1,18 @@
+<%= render :partial => 'spree/admin/shared/configuration_menu' %>
+
+<h1><%= t("reviews_rating.review_settings") %></h1>
+
+<%= form_tag admin_review_settings_path, :method => :put do %>
+  <fieldset id="preferences" data-hook>
+  <% @preferences.each do |key| 
+      type = Spree::Config.preference_type(key) %>
+      <%= label_tag(key, t("reviews_rating.#{key}") + ': ') + tag(:br) if type != :boolean %>
+      <%= preference_field_tag(key, Spree::Config[key], :type => type) %>
+      <%= label_tag(key, t("reviews_rating.#{key}")) + tag(:br) if type == :boolean %>
+  <% end %>
+  </fieldset>
+  <p class="form-buttons" data-hook="buttons">
+    <%= button t(:update) %>
+    <%= t(:or) %> <%= link_to t(:cancel), admin_review_settings_url %>
+  </p>
+<% end %>

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

@@ -0,0 +1,44 @@
+<%= render :partial => 'spree/admin/shared/configuration_menu' %>
+
+<h1><%= t("reviews_rating.review_settings") %></h1>
+
+<table data-hook="preferences">
+	<% @preferences.each do |key| %>
+	<tr>
+		<th scope="row"><%= t("reviews_rating.#{key}") %>:</th>
+		<td><%= Spree::Config[key] %></td>
+	</tr>
+	<% end %>
+	<tr>
+		<th scope="row"><%= t("reviews_rating.include_unapproved_reviews") %>:</th>
+		<td>
+			<%= (Spree::Config[:include_unapproved_reviews].blank?) ? t(:no) : t(:yes) %>
+		</td>
+	</tr>
+	<tr>
+		<th scope="row"><%= t("reviews_rating.show_email") %>:</th>
+		<td>
+			<%= (Spree::Config[:show_email].blank?) ? t(:no) : t(:yes) %>
+		</td>
+	</tr>
+	<tr>
+		<th scope="row"><%= t("reviews_rating.require_login") %>:</th>
+		<td>
+			<%= (Spree::Config[:require_login].blank?) ? t(:no) : t(:yes) %>
+		</td>
+	</tr>
+	<tr>
+		<th scope="row"><%= t("reviews_rating.form_show") %>:</th>
+		<td>
+			<%= (Spree::Config[:form_show].blank?) ? t(:no) : t(:yes) %>
+		</td>
+	</tr>
+	<tr>
+		<th scope="row"><%= t("reviews_rating.star_big") %>:</th>
+		<td>
+			<%= (Spree::Config[:star_big].blank?) ? t(:no) : t(:yes) %>
+		</td>
+	</tr>
+</table>
+
+<p><%= link_to_with_icon 'edit', t(:edit), edit_admin_review_settings_path, :id => 'admin_store_settings_link' %></p>

data/app/views/spree/admin/reviews/_form.html.erb

@@ -0,0 +1,6 @@
+<%= f.inputs do %>
+	<%= f.input :name, :label => t("reviews_rating.name") %>
+	<%= f.input :user, :label => t("reviews_rating.user")%>
+	<%= f.input :product, :label => t("reviews_rating.product")%>
+	<%= f.input :review, :input_html => { :value => @review.review }, :label => t("reviews_rating.review_content") %>
+<% end %>

data/app/views/spree/admin/reviews/edit.html.erb

@@ -0,0 +1,19 @@
+<h1><%= t("reviews_rating.editing_review_for") %> <%= @review.product.name %></h1>
+<%= link_to t('back_reviews'), admin_reviews_path %><br />
+
+<h2><%= t("reviews_rating.original_verision") %></h2>
+<div style="padding: 15px 5px;">
+	<%= @review.user_id ? link_to(@review.user.try(:email), [:admin, @review.user]) : @review.name %><br />
+	<% if @review.product %>
+		<%= link_to @review.product.name, product_path(@review.product) %><br />
+	<% end %>
+	<%= h @review.review %>
+</div>
+
+<%= render :partial => 'spree/shared/error_messages', :locals => { :target => @review } %>
+<h2><%= t("reviews_rating.edited_version") %></h2>
+
+<%= semantic_form_for([:admin, @review]) do |f| %>
+<%= render :partial => "form", :locals => { :f => f } %>
+<%= render :partial => 'spree/admin/shared/edit_resource_links' %>
+<% end %>

data/app/views/{admin → spree/admin}/reviews/index.html.erb

@@ -1,4 +1,4 @@
-<% render 'admin/shared/product_sub_menu' %>
+<% render 'spree/admin/shared/product_sub_menu' %>
 <h1><%= t('review_management_description') %></h1>
 
 <% for reviews in [["Unapproved", @unapproved_reviews], ["Approved", @approved_reviews]] %>
@@ -6,12 +6,11 @@
 
 <table cellspacing=6 class="index">
 	<tr>
-		<th><%= Review.human_attribute_name(:created_at) %></th>
-		<th><%= Review.human_attribute_name(:user) %></th>
-		<th><%= Review.human_attribute_name(:rating) %></th>
+		<th><%= t(:created_at) %></th>
+		<th><%= t(:user) %></th>
+		<th><%= t(:rating) %></th>
 		<th><%= t('product') %></th>
-		<th><%= t('feedback') %></th>
-		<th><%= Review.human_attribute_name(:review) %></th>
+		<th><%= t(:review) %></th>
 		<th></th>
 	</tr>
 
@@ -27,12 +26,9 @@
 			<%= txt_stars(review.rating) %>
 		</td>
 		<td>
-			<% if review.product %>
+		<% if review.product %>
 			<%= link_to review.product.name, product_path(review.product) %>
-			<% end %>
-		</td>
-		<td>
-			<%= link_to t('feedback'), admin_review_feedback_reviews_path(review) %>(<%= review.feedback_stars %>/<%= review.feedback_reviews.count %>)
+		<% end %>
 		</td>
 		<td width="30%">
 			<%= h review.review %>

data/app/views/spree/admin/shared/_reviews_setting_configurations_menu.html.erb

@@ -0,0 +1,4 @@
+<tr>
+  <td><%= link_to t("reviews_rating.review_settings"), admin_review_settings_path %></td>
+  <td><%= t("reviews_rating.manage_review_settings") %></td>
+</tr>

data/app/views/spree/reviews/_fine_print.html.erb

@@ -0,0 +1,8 @@
+<div class="review_fine_print">
+	<h2><%= t('the_fine_print') %></h2>
+	<ul>
+		<li><%= t('terms_text') %>: <%= link_to t(:terms_and_conditions), url_for(:action => 'terms') %></li>
+		<li><%= t('approved_text') %></li>
+		<li><%= t('guideline_text') %>: <%= link_to t(:review_guidelines), url_for(:action => 'submissionguidelines') %></li>
+	</ul>
+</div>

data/app/views/spree/reviews/_form.html.erb

@@ -0,0 +1,22 @@
+<%= form_for review, :url => product_reviews_path(product), :html => {:id => "reviews_form"}, :remote => true do |f| %>
+	<%= render :partial => "spree/shared/error_messages", :locals => {:target => review} %>
+
+	<div class="review_name_field">
+		<%= f.label :name, t("reviews_rating.name") %> <span class="required">*</span><br />
+		<%= f.text_field :name %>
+	</div>
+	<div class="review_review_field">
+		<%= f.label :review, t("reviews_rating.review") %> <span class="required">*</span><br />
+		<%= f.text_area :review, :wrap => "virtual", :rows => "8", :cols => "50" %>
+		<p class="s_legend">
+			<span style="color: #FF0000;"><%= t("reviews_rating.note_reviews") %></span> <%= t("reviews_rating.note_review_description") %></p>
+	</div>
+	
+	<div class="review_rating_field">
+	    <%= f.label :rating, t("reviews_rating.rating") %> <span class="required">*</span><br />
+		<%= render :partial => "spree/reviews/stars" %>
+		<%= f.hidden_field :rating %>
+	</div>
+	<%= link_to content_tag(:span, t("reviews_rating.continue"), :class => "s_text"), "javascript: void(0)", :class => "s_button_1 s_main_color_bgr review_submit" %>
+	<%#= button_tag t('submit_your_review'), :class => "button-submit" %>
+<% end %>

data/app/views/spree/reviews/_new.html.erb

@@ -0,0 +1,4 @@
+<h2><span><%= t("reviews_rating.write") %></span> <%= t("reviews_rating.a_review") %></h2>
+
+<div id="review_title" class="clear"></div>
+<%= render 'spree/reviews/form', { :review => review, :product => product } %>

data/app/views/{reviews → spree/reviews}/_stars.html.erb

@@ -6,6 +6,9 @@ jQuery(document).ready(function() {
 		cancel: true,
 		half:  true,
 		width: 180,
+		starHalf: 'star-half<%= "-big" if (Spree::Config[:star_big] == true) %>.png',
+		starOff: 'star-off<%= "-big" if (Spree::Config[:star_big] == true) %>.png',
+		starOn:	'star-on<%= "-big" if (Spree::Config[:star_big] == true) %>.png',
 		path: '/assets/',
 		click: function(score, evt) {
 			$("#review_rating").val(score);
@@ -13,4 +16,4 @@ jQuery(document).ready(function() {
 	});
 });
 //-->
-</script>
+</script>

data/app/views/spree/reviews/error.js.erb

@@ -0,0 +1,2 @@
+$("#reviews_form").show();
+$("#new_review").addClass("s_bgmsg_red").html("<%= escape_javascript(t('review_not_submitted')) %>");

data/app/views/spree/reviews/index.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'spree/shared/reviews' %>

data/app/views/{reviews → spree/reviews}/new.html.erb

@@ -1,5 +1,4 @@
-<h6> <%= I18n.t('leave_us_a_review') %> </h6>
+<h2><span><%= t("reviews_rating.write") %></span> <%= t("reviews_rating.a_review") %></h2>
 
 <%= render 'form', { :review => @review, :product => @product } %>
-<%= link_to(t('cancel_your_review'), "#", :class => "cancel-review", :rel => "nofollow,noindex") %>
-<%# render :partial => "reviews/fine_print" %>
+<%= link_to(t('cancel_your_review'), "#", :class => "cancel-review", :rel => "nofollow,noindex") %>