solidus_reviews 1.0.0 → 1.1.0

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
 

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

@@ -1,4 +1,6 @@
-class Spree::Admin::FeedbackReviewsController <  Spree::Admin::ResourceController
+# frozen_string_literal: true
+
+class Spree::Admin::FeedbackReviewsController < Spree::Admin::ResourceController
   belongs_to 'spree/review'
   def index
     @collection = parent.feedback_reviews

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

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 class Spree::Admin::ReviewSettingsController < Spree::Admin::BaseController
-  before_filter :process_unset_checkboxes, only: [:update]
+  before_action :process_unset_checkboxes, only: [:update]
 
   def update
     Spree::Reviews::Config.set(params[:preferences])

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Spree::Admin::ReviewsController < Spree::Admin::ResourceController
   helper Spree::ReviewsHelper
 
@@ -6,20 +8,21 @@ class Spree::Admin::ReviewsController < Spree::Admin::ResourceController
   end
 
   def approve
-    r = Spree::Review.find(params[:id])
+    review = Spree::Review.find(params[:id])
 
-    if r.update_attribute(:approved, true)
-       flash[:notice] = Spree.t("info_approve_review")
+    if review.update_attribute(:approved, true)
+      flash[:success] = I18n.t('spree.info_approve_review')
     else
-       flash[:error] = Spree.t("error_approve_review")
+      flash[:error] = I18n.t('spree.error_approve_review')
     end
+
     redirect_to admin_reviews_path
   end
 
   def edit
     if @review.product.nil?
-      flash[:error] = Spree.t("error_no_product")
-      redirect_to admin_reviews_path and return
+      flash[:error] = I18n.t('spree.error_no_product')
+      redirect_to admin_reviews_path
     end
   end
 

data/app/controllers/spree/feedback_reviews_controller.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
+
 class Spree::FeedbackReviewsController < Spree::StoreController
   helper Spree::BaseHelper
 
-  before_filter :sanitize_rating, only: [:create]
-  before_filter :load_review, only: [:create]
+  before_action :sanitize_rating, only: [:create]
+  before_action :load_review, only: [:create]
 
   def create
-
     if @review.present?
       @feedback_review = @review.feedback_reviews.new(feedback_review_params)
       @feedback_review.user = spree_current_user
@@ -15,27 +16,32 @@ class Spree::FeedbackReviewsController < Spree::StoreController
     end
 
     respond_to do |format|
-      format.html { redirect_to :back  }
-      format.js   { render :action => :create }
+      format.html {
+        if SolidusSupport.solidus_gem_version < Gem::Version.new('2.0')
+          redirect_to(:back)
+        else
+          redirect_back(fallback_location: root_path)
+        end
+      }
+      format.js { render action: :create }
     end
-
   end
 
   protected
-    def load_review
-      @review ||= Spree::Review.find_by_id!(params[:review_id])
-    end
 
-    def permitted_feedback_review_attributes
-      [:rating, :comment]
-    end
+  def load_review
+    @review ||= Spree::Review.find_by_id!(params[:review_id])
+  end
 
-    def feedback_review_params
-      params.require(:feedback_review).permit(permitted_feedback_review_attributes)
-    end
+  def permitted_feedback_review_attributes
+    [:rating, :comment]
+  end
 
-    def sanitize_rating
-      params[:feedback_review][:rating].to_s.sub!(/\s*[^0-9]*\z/,'') unless (params[:feedback_review] && params[:feedback_review][:rating].blank?)
-    end
-end
+  def feedback_review_params
+    params.require(:feedback_review).permit(permitted_feedback_review_attributes)
+  end
 
+  def sanitize_rating
+    params[:feedback_review][:rating].to_s.sub!(/\s*[^0-9]*\z/, '') unless params[:feedback_review] && params[:feedback_review][:rating].blank?
+  end
+end

data/app/controllers/spree/products_controller_decorator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Spree::ProductsController.class_eval do
   helper Spree::ReviewsHelper
 

data/app/controllers/spree/reviews_controller.rb

@@ -1,30 +1,35 @@
+# frozen_string_literal: true
+
 class Spree::ReviewsController < Spree::StoreController
   helper Spree::BaseHelper
-  before_filter :load_product, :only => [:index, :new, :create]
-  rescue_from ActiveRecord::RecordNotFound, :with => :render_404
+  before_action :load_product, only: [:index, :new, :create]
 
   def index
     @approved_reviews = Spree::Review.approved.where(product: @product)
   end
 
   def new
-    @review = Spree::Review.new(:product => @product)
+    @review = Spree::Review.new(product: @product)
     authorize! :create, @review
   end
 
   # save if all ok
   def create
-    params[:review][:rating].sub!(/\s*[^0-9]*\z/,'') unless params[:review][:rating].blank?
+    params[:review][:rating].sub!(/\s*[^0-9]*\z/, '') unless params[:review][:rating].blank?
 
     @review = Spree::Review.new(review_params)
     @review.product = @product
     @review.user = spree_current_user if spree_user_signed_in?
     @review.ip_address = request.remote_ip
     @review.locale = I18n.locale.to_s if Spree::Reviews::Config[:track_locale]
+    # Handle images
+    params[:review][:images]&.each do |image|
+      @review.images.new(attachment: image)
+    end
 
     authorize! :create, @review
     if @review.save
-      flash[:notice] = Spree.t('review_successfully_submitted')
+      flash[:notice] = I18n.t('spree.review_successfully_submitted')
       redirect_to spree.product_path(@product)
     else
       render :new
@@ -38,11 +43,10 @@ class Spree::ReviewsController < Spree::StoreController
   end
 
   def permitted_review_attributes
-    [:rating, :title, :review, :name, :show_identifier]
+    [:rating, :title, :review, :name, :show_identifier, :images]
   end
 
   def review_params
     params.require(:review).permit(permitted_review_attributes)
   end
-
 end

data/app/helpers/spree/api/api_helpers_decorator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+Spree::Api::ApiHelpers.module_eval do
+  @@review_attributes = [
+    :id, :product_id, :name, :location, :rating, :title, :review, :approved,
+    :created_at, :updated_at, :user_id, :ip_address, :locale, :show_identifier
+  ]
+
+  def review_attributes
+    @@review_attributes
+  end
+end

data/app/helpers/spree/reviews_helper.rb

@@ -1,17 +1,27 @@
-module Spree::ReviewsHelper
+# frozen_string_literal: true
 
+module Spree::ReviewsHelper
   def star(the_class)
-    content_tag(:span, " ✮ ".html_safe, :class => the_class)
+    content_tag(:span, " ✮ ".html_safe, class: the_class)
   end
 
   def mk_stars(m)
-    (1..5).collect {|n| n <= m ? star("lit") : star("unlit") }.join
+    (1..5).collect { |n| n <= m ? star("lit") : star("unlit") }.join
   end
 
   def txt_stars(n, show_out_of = true)
-    res = Spree.t('star', :count => n)
-    res += " #{Spree.t('out_of_5')}" if show_out_of
+    res = I18n.t('spree.star', count: n)
+    res += " #{I18n.t('spree.out_of_5')}" if show_out_of
     res
   end
 
+  def display_verified_purchaser?(review)
+    Spree::Reviews::Config[:show_verified_purchaser] && review.user &&
+    Spree::LineItem.joins(:order, :variant)
+      .where.not(spree_orders: { completed_at: nil })
+      .find_by(
+        spree_variants: { product_id: review.product_id },
+        spree_orders: { user_id: review.user_id }
+      ).present?
+  end
 end

data/app/models/spree/feedback_review.rb

@@ -1,17 +1,18 @@
+# frozen_string_literal: true
+
 class Spree::FeedbackReview < ActiveRecord::Base
-  belongs_to :user, :class_name => Spree.user_class.to_s
+  belongs_to :user, class_name: Spree.user_class.to_s
 
   belongs_to :review, dependent: :destroy
   validates :review, presence: true
 
   validates :rating, numericality: { only_integer: true,
-                                     greater_than_or_equal_to: 1, 
+                                     greater_than_or_equal_to: 1,
                                      less_than_or_equal_to: 5,
-                                     message: Spree.t('you_must_enter_value_for_rating') }
+                                     message: :you_must_enter_value_for_rating }
 
   scope :most_recent_first, -> { order("spree_feedback_reviews.created_at DESC") }
   default_scope { most_recent_first }
 
   scope :localized, lambda { |lc| where('spree_feedback_reviews.locale = ?', lc) }
-
 end

data/app/models/spree/product_decorator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Add access to reviews/ratings to the product model
 Spree::Product.class_eval do
   has_many :reviews
@@ -7,15 +9,14 @@ Spree::Product.class_eval do
   end
 
   def recalculate_rating
-    reviews_count = self.reviews.reload.approved.count
+    reviews_count = reviews.reload.default_approval_filter.count
 
     self.reviews_count = reviews_count
     if reviews_count > 0
-      self.avg_rating = self.reviews.approved.sum(:rating).to_f / reviews_count
+      self.avg_rating = '%.1f' % (reviews.default_approval_filter.sum(:rating).to_f / reviews_count)
     else
       self.avg_rating = 0
     end
-    self.save
+    save
   end
-
 end

data/app/models/spree/review.rb

@@ -1,22 +1,23 @@
+# frozen_string_literal: true
+
 class Spree::Review < ActiveRecord::Base
   belongs_to :product, touch: true
-  belongs_to :user, :class_name => Spree.user_class.to_s
+  belongs_to :user, class_name: Spree.user_class.to_s
   has_many   :feedback_reviews
+  has_many   :images, -> { order(:position) }, as: :viewable,
+    dependent: :destroy, class_name: "Spree::Image"
 
-  after_save :recalculate_product_rating, :if => :approved?
+  before_create :verify_purchaser
+  after_save :recalculate_product_rating, if: :approved?
   after_destroy :recalculate_product_rating
 
-  validates :name, presence: true
-  validates :review, presence: true
-
   validates :rating, numericality: { only_integer: true,
-                                     greater_than_or_equal_to: 1, 
+                                     greater_than_or_equal_to: 1,
                                      less_than_or_equal_to: 5,
-                                     message: Spree.t('you_must_enter_value_for_rating') }
-
+                                     message: :you_must_enter_value_for_rating }
 
   default_scope { order("spree_reviews.created_at DESC") }
-  
+
   scope :localized, ->(lc) { where('spree_reviews.locale = ?', lc) }
   scope :most_recent_first, -> { order('spree_reviews.created_at DESC') }
   scope :oldest_first, -> { reorder('spree_reviews.created_at ASC') }
@@ -31,6 +32,23 @@ class Spree::Review < ActiveRecord::Base
   end
 
   def recalculate_product_rating
-    self.product.recalculate_rating if product.present?
+    product.recalculate_rating if product.present?
+  end
+
+  def email
+    user.try!(:email)
+  end
+
+  def verify_purchaser
+    return unless user_id && product_id
+
+    verified_purchase = Spree::LineItem.joins(:order, :variant)
+      .where.not(spree_orders: { completed_at: nil })
+      .find_by(
+        spree_variants: { product_id: product_id },
+        spree_orders: { user_id: user_id }
+      ).present?
+
+    self.verified_purchaser = verified_purchase
   end
 end

data/app/models/spree/reviews_ability.rb

@@ -1,14 +1,28 @@
+# frozen_string_literal: true
+
 class Spree::ReviewsAbility
   include CanCan::Ability
 
-  def initialize user
+  def initialize(user)
     review_ability_class = self.class
-    can :create, Spree::Review do |review|
+
+    can :create, Spree::Review do |_review|
       review_ability_class.allow_anonymous_reviews? || !user.email.blank?
     end
-    can :create, Spree::FeedbackReview do |review|
+
+    can :create, Spree::FeedbackReview do |_review|
       review_ability_class.allow_anonymous_reviews? || !user.email.blank?
     end
+
+    # You can read your own reviews, and everyone can read approved ones
+    can :read, Spree::Review do |review|
+      review.user == user || review.approved?
+    end
+
+    # You can only change your own review
+    can [:update, :destroy], Spree::Review do |review|
+      review.user == user
+    end
   end
 
   def self.allow_anonymous_reviews?

data/app/models/spree/reviews_configuration.rb

@@ -1,26 +1,34 @@
+# frozen_string_literal: true
+
 class Spree::ReviewsConfiguration < Spree::Preferences::Configuration
   def self.boolean_preferences
-    %w(include_unapproved_reviews feedback_rating show_email require_login track_locale)
+    %w(display_unapproved_reviews include_unapproved_reviews feedback_rating show_email require_login track_locale)
   end
 
   # include non-approved reviews in (public) listings
-  preference :include_unapproved_reviews, :boolean, :default => false
+  preference :include_unapproved_reviews, :boolean, default: false
+
+  # displays non-approved reviews in (public) listings
+  preference :display_unapproved_reviews, :boolean, default: false
 
   # control how many reviews are shown in summaries etc.
-  preference :preview_size, :integer, :default => 3
+  preference :preview_size, :integer, default: 3
 
   # show a reviewer's email address
-  preference :show_email, :boolean, :default => false
+  preference :show_email, :boolean, default: false
+
+  # show if a reviewer actually purchased the product
+  preference :show_verified_purchaser, :boolean, default: false
 
   # show helpfullness rating form elements
-  preference :feedback_rating, :boolean, :default => false
+  preference :feedback_rating, :boolean, default: false
 
   # require login to post reviews
-  preference :require_login, :boolean, :default => true
+  preference :require_login, :boolean, default: true
 
   # whether to keep track of the reviewer's locale
-  preference :track_locale, :boolean, :default => false
+  preference :track_locale, :boolean, default: false
 
   # render checkbox for a user to approve to show their identifier (name or email) on their review
-  preference :render_show_identifier_checkbox, :boolean, :default => false
+  preference :render_show_identifier_checkbox, :boolean, default: false
 end

data/app/models/spree/user_decorator.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+Spree.user_class.has_many :reviews, class_name: 'Spree::Review'

data/app/overrides/add_reviews_after_product_properties.rb

@@ -1,5 +1,7 @@
-Deface::Override.new(:virtual_path => "spree/products/show",
-                     :name => "converted_product_properties_767643482",
-                     :insert_after => "[data-hook='product_properties']",
-                     :partial => "spree/shared/reviews",
-                     :disabled => false)
+# frozen_string_literal: true
+
+Deface::Override.new(virtual_path: "spree/products/show",
+                     name: "converted_product_properties_767643482",
+                     insert_after: "[data-hook='product_properties']",
+                     partial: "spree/shared/reviews",
+                     disabled: false)

data/app/overrides/add_reviews_tab_to_admin.rb

@@ -1,4 +1,12 @@
-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') %>")
+# frozen_string_literal: true
+
+Spree::Backend::Config.configure do |config|
+  config.menu_items.detect { |menu_item|
+    menu_item.label == :products
+  }.sections << :reviews
+end
+
+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') %>")