solidus_reviews 1.0.0 → 1.4.0

data/app/decorators/models/solidus_reviews/spree/product_decorator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module SolidusReviews
+  module Spree
+    module ProductDecorator
+      def self.prepended(base)
+        base.class_eval do
+          has_many :reviews
+        end
+      end
+
+      def stars
+        avg_rating.try(:round) || 0
+      end
+
+      def recalculate_rating
+        reviews_count = reviews.reload.default_approval_filter.count
+
+        self.reviews_count = reviews_count
+        self.avg_rating = if reviews_count > 0
+                            '%.1f' % (reviews.default_approval_filter.sum(:rating).to_f / reviews_count)
+                          else
+                            0
+                          end
+        save
+      end
+
+      ::Spree::Product.prepend self
+    end
+  end
+end

data/app/decorators/models/solidus_reviews/spree/user_decorator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SolidusReviews
+  module Spree
+    module UserDecorator
+      def self.prepended(base)
+        base.class_eval do
+          has_many :reviews, class_name: 'Spree::Review'
+        end
+      end
+
+      ::Spree.user_class.prepend self
+    end
+  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 @@
-class Spree::FeedbackReview < ActiveRecord::Base
-  belongs_to :user, :class_name => Spree.user_class.to_s
+# frozen_string_literal: true
 
-  belongs_to :review, dependent: :destroy
+class Spree::FeedbackReview < ApplicationRecord
+  belongs_to :user, class_name: Spree.user_class.to_s, optional: true
+
+  belongs_to :review, touch: 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 }
 
   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/permission_sets/review_display.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Spree
+  module PermissionSets
+    class ReviewDisplay < PermissionSets::Base
+      def activate!
+        can [:display, :admin], Spree::Review
+      end
+    end
+  end
+end

data/app/models/spree/permission_sets/review_management.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Spree
+  module PermissionSets
+    class ReviewManagement < PermissionSets::Base
+      def activate!
+        can :manage, Spree::Review
+      end
+    end
+  end
+end

data/app/models/spree/review.rb

@@ -1,22 +1,24 @@
-class Spree::Review < ActiveRecord::Base
-  belongs_to :product, touch: true
-  belongs_to :user, :class_name => Spree.user_class.to_s
-  has_many   :feedback_reviews
+# frozen_string_literal: true
 
-  after_save :recalculate_product_rating, :if => :approved?
-  after_destroy :recalculate_product_rating
+class Spree::Review < ApplicationRecord
+  belongs_to :product, touch: true, optional: true
+  belongs_to :user, class_name: Spree.user_class.to_s, optional: true
+  has_many   :feedback_reviews, dependent: :destroy
+  has_many   :images, -> { order(:position) }, as: :viewable,
+                                               dependent: :destroy, class_name: "Spree::Image"
 
-  validates :name, presence: true
-  validates :review, presence: true
+  before_save :verify_purchaser
+  before_save :approve_review, unless: :approved?
+  after_save :recalculate_product_rating, if: :approved?
+  after_destroy :recalculate_product_rating
 
   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') }
@@ -27,10 +29,41 @@ class Spree::Review < ActiveRecord::Base
 
   def feedback_stars
     return 0 if feedback_reviews.size <= 0
+
     ((feedback_reviews.sum(:rating) / feedback_reviews.size) + 0.5).floor
   end
 
   def recalculate_product_rating
-    self.product.recalculate_rating if product.present?
+    product.recalculate_rating if product.present?
+  end
+
+  def email
+    user&.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
+
+  def star_only?
+    [title, review].all?(&:blank?) && rating.present?
+  end
+
+  def approve_review
+    # Checks if we should auto approve the review.
+    if Spree::Reviews::Config[:approve_star_only]
+      self.approved = true if star_only?
+    elsif Spree::Reviews::Config[:approve_star_only_for_verified_purchaser]
+      self.approved = true if star_only? && verified_purchaser?
+    end
   end
 end

data/app/models/spree/reviews_ability.rb

@@ -1,13 +1,32 @@
+# 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|
-      review_ability_class.allow_anonymous_reviews? || !user.email.blank?
+
+    can :create, Spree::Review do |_review|
+      review_ability_class.allow_anonymous_reviews? || user.email.present?
     end
-    can :create, Spree::FeedbackReview do |review|
-      review_ability_class.allow_anonymous_reviews? || !user.email.blank?
+
+    can :create, Spree::FeedbackReview do |_review|
+      review_ability_class.allow_anonymous_reviews? || user.email.present?
+    end
+
+    # You can only change your own feedback_review
+    can [:update, :destroy], Spree::FeedbackReview do |feedback_review|
+      feedback_review.user == user
+    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
 

data/app/models/spree/reviews_configuration.rb

@@ -1,26 +1,43 @@
+# 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 allow_image_upload)
   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
+
+  # Approves star only reviews automatically (Reviews without a Title/Review)
+  preference :approve_star_only, :boolean, default: false
+
+  # Approves star only reviews for verified purchasers only.
+  preference :approve_star_only_for_verified_purchaser, :boolean, default: false
+
+  # allow customer to update image with the review
+  preference :allow_image_upload, :boolean, default: true
 end

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,20 @@
-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']",
+  disabled: false
+) do
+  <<-HTML
+    <% if can? :admin, Spree::Review %>
+      <%= tab(:reviews, label: 'review_management') %>
+    <% end %>
+  HTML
+end

data/app/overrides/add_reviews_to_admin_configuration_sidebar.rb

@@ -1,5 +1,20 @@
-Deface::Override.new(:virtual_path => "spree/admin/shared/_configuration_menu",
-                     :name => "converted_admin_configurations_menu",
-                     :insert_bottom => "[data-hook='admin_configurations_sidebar_menu'], #admin_configurations_sidebar_menu[data-hook]",
-                     :text => "<%= configurations_sidebar_menu_item Spree.t('spree_reviews.review_settings'), edit_admin_review_settings_path %>",
-                     :disabled => false)
+# frozen_string_literal: true
+
+Spree::Backend::Config.configure do |config|
+  config.menu_items.detect { |menu_item|
+    menu_item.label == :settings
+  }.sections << :review_settings
+end
+
+Deface::Override.new(
+  virtual_path: "spree/admin/shared/_settings_sub_menu",
+  name: "converted_admin_configurations_menu",
+  insert_bottom: "[data-hook='admin_settings_sub_tabs']",
+  disabled: false
+) do
+  <<-HTML
+    <% if can? :admin, Spree::ReviewsConfiguration %>
+      <%= tab :reviews, url: spree.edit_admin_review_settings_path, match_path: /review_settings/ %>
+    <% end %>
+  HTML
+end

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

@@ -1,9 +1,9 @@
 <% content_for :page_title do %>
-	<%= Spree.t('feedback_review_for', :review => @review.title) %>
+	<%= I18n.t("spree.feedback_review_for", review: @review.title) %>
 <% end %>
 
 <% content_for :page_actions do %>
-	<li><%= button_link_to Spree.t(:back_to_reviews), admin_reviews_path, { :icon => 'icon-arrow-left' } %></li>
+	<li><%= link_to I18n.t("spree.back_to_reviews"), admin_reviews_path %></li>
 <% end %>
 
 <% render 'spree/admin/shared/product_sub_menu' %>
@@ -18,20 +18,20 @@
 		</colgroup>
 		<thead>
 			<tr>
-				<th><%= Spree.t('user') %></th>
-				<th><%= Spree.t('stars') %></th>
-				<th><%= Spree.t('date') %></th>
-				<th></th>
+				<th><%= I18n.t("spree.user") %></th>
+				<th><%= I18n.t("spree.stars") %></th>
+				<th><%= I18n.t("spree.date") %></th>
+				<th class="actions"></th>
 			</tr>
 		</thead>
 		<tbody>
 		<%- @collection.each do |feedback| -%>
 			<tr id="<%= dom_id(feedback) %>">
 			  <td><%= l feedback.created_at %></td>
-			  <td><%= feedback.user.try(:login) || Spree.t(:anonymous) %></td>
+			  <td><%= feedback.user.try(:login) || I18n.t("spree.anonymous") %></td>
 			  <td><%= feedback.rating %></td>
 			  <td class="actions">
-				  <%= link_to_delete feedback, :no_text => true  %>
+				  <%= link_to_delete feedback, no_text: true  %>
 			  </td>
 			</tr>
 		<% end %>
@@ -39,6 +39,6 @@
 	</table>
 <% else %>
 	<div class="no-objects-found">
-		<%= Spree.t(:no_results) %>
+		<%= I18n.t("spree.no_results") %>
 	</div>
 <% end %>

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

@@ -1,40 +1,76 @@
-<%= render 'spree/admin/shared/configuration_menu' %>
-
 <% content_for :page_title do %>
-	<%= Spree.t("spree_reviews.review_settings") %>
+  <%= I18n.t("spree.spree_reviews.review_settings") %>
 <% end %>
 
-<%= form_tag(admin_review_settings_path, :method => :put) do %>
-	<fieldset class="no-border-top">
-		<div class="field">
-			<%= check_box_tag('preferences[include_unapproved_reviews]', "1", Spree::Reviews::Config[:include_unapproved_reviews]) %>
-			<label><%= Spree.t("spree_reviews.include_unapproved") %></label>
-		</div>
-		<div class="field">
-			<%= check_box_tag('preferences[feedback_rating]', "1", Spree::Reviews::Config[:feedback_rating]) %>
-			<label><%= Spree.t("spree_reviews.feedback_rating") %></label>
-		</div>
-		<div class="field">
-			<%= check_box_tag('preferences[show_email]', "1", Spree::Reviews::Config[:show_email]) %>
-			<label><%= Spree.t("spree_reviews.show_email") %></label>
-		</div>
-		<div class="field">
-			<%= check_box_tag('preferences[require_login]', "1", Spree::Reviews::Config[:require_login]) %>
-			<label><%= Spree.t("spree_reviews.require_login") %></label>
-		</div>
-		<div class="field">
-			<%= check_box_tag('preferences[track_locale]', "1", Spree::Reviews::Config[:track_locale]) %>
-			<label><%= Spree.t("spree_reviews.track_locale") %></label>
-		</div>
-		<div class="field">
-			<label><%= Spree.t('spree_reviews.preview_size') %></label><br>
-			<%= text_field_tag('preferences[preview_size]', Spree::Reviews::Config[:preview_size], :size => 3) %>
-		</div>
+<% admin_breadcrumb(I18n.t("spree.settings")) %>
+
+<% content_for :tabs do %>
+  <nav>
+    <ul class="tabs">
+      <%= settings_tab_item I18n.t("spree.spree_reviews.review_settings"), spree.admin_review_settings_path %>
+    </ul>
+  </nav>
+<% end %>
+
+<%= form_tag(admin_review_settings_path, method: :put) do %>
+  <fieldset class="no-border-top">
+    <div class="field">
+      <label>
+        <%= check_box_tag('preferences[include_unapproved_reviews]', "1", Spree::Reviews::Config[:include_unapproved_reviews]) %>
+        <%= I18n.t("spree.spree_reviews.include_unapproved") %>
+      </label>
+    </div>
+    <div class="field">
+      <label>
+        <%= check_box_tag('preferences[display_unapproved_reviews]', "1", Spree::Reviews::Config[:display_unapproved_reviews]) %>
+        <%= I18n.t("spree.spree_reviews.display_unapproved") %>
+      </label>
+    </div>
+    <div class="field">
+      <label>
+        <%= check_box_tag('preferences[feedback_rating]', "1", Spree::Reviews::Config[:feedback_rating]) %>
+        <%= I18n.t("spree.spree_reviews.feedback_rating") %>
+      </label>
+    </div>
+    <div class="field">
+      <label>
+        <%= check_box_tag('preferences[show_email]', "1", Spree::Reviews::Config[:show_email]) %>
+        <%= I18n.t("spree.spree_reviews.show_email") %>
+      </label>
+    </div>
+    <div class="field">
+      <label>
+        <%= check_box_tag('preferences[show_verified_purchaser]', "1", Spree::Reviews::Config[:show_verified_purchaser]) %>
+        <%= I18n.t("spree.spree_reviews.show_verified_purchaser") %>
+      </label>
+    </div>
+    <div class="field">
+      <label>
+        <%= check_box_tag('preferences[require_login]', "1", Spree::Reviews::Config[:require_login]) %>
+        <%= I18n.t("spree.spree_reviews.require_login") %>
+      </label>
+    </div>
+    <div class="field">
+      <label>
+        <%= check_box_tag('preferences[track_locale]', "1", Spree::Reviews::Config[:track_locale]) %>
+        <%= I18n.t("spree.spree_reviews.track_locale") %>
+      </label>
+    </div>
+    <div class="field">
+      <label>
+        <%= check_box_tag('preferences[allow_image_upload]', "1", Spree::Reviews::Config[:allow_image_upload]) %>
+        <%= I18n.t("spree.spree_reviews.allow_image_upload") %>
+      </label>
+    </div>
+
+    <div class="field">
+      <label><%= I18n.t("spree.spree_reviews.preview_size") %></label><br>
+      <%= text_field_tag('preferences[preview_size]', Spree::Reviews::Config[:preview_size], size: 3) %>
+    </div>
 
-		<div class="form-buttons filter-actions actions" data-hook="buttons">
-			<%= button Spree.t('actions.update'), 'icon-refresh' %>
-			<span class="or"><%= Spree.t(:or) %></span>
-			<%= link_to_with_icon 'icon-remove', Spree.t('actions.cancel'), edit_admin_general_settings_url, :class => 'button' %>
-		</div>
-	</fieldset>
+    <div class="form-buttons filter-actions actions" data-hook="buttons">
+      <%= button_tag I18n.t("spree.actions.update") %>
+      <%= link_to I18n.t("spree.actions.cancel"), edit_admin_general_settings_url, class: 'button' %>
+    </div>
+  </fieldset>
 <% end %>