solidus_reviews 1.2.0 → 1.5.0

data/app/models/spree/reviews_ability.rb

@@ -7,11 +7,16 @@ class Spree::ReviewsAbility
     review_ability_class = self.class
 
     can :create, Spree::Review do |_review|
-      review_ability_class.allow_anonymous_reviews? || !user.email.blank?
+      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?
+      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

data/app/models/spree/reviews_configuration.rb

@@ -2,7 +2,7 @@
 
 class Spree::ReviewsConfiguration < Spree::Preferences::Configuration
   def self.boolean_preferences
-    %w(display_unapproved_reviews 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
@@ -31,4 +31,13 @@ class Spree::ReviewsConfiguration < Spree::Preferences::Configuration
 
   # 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
+
+  # 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_tab_to_admin.rb

@@ -6,7 +6,15 @@ Spree::Backend::Config.configure do |config|
   }.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') %>")
+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

@@ -6,8 +6,15 @@ Spree::Backend::Config.configure do |config|
   }.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']",
-                     text: "<%= tab :reviews, url: spree.edit_admin_review_settings_path, match_path: /review_settings/ %>",
-                     disabled: false)
+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/review_settings/edit.html.erb

@@ -56,6 +56,13 @@
         <%= 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) %>

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

@@ -1,5 +1,5 @@
 <% content_for :page_title do %>
-	<%= I18n.t("spree.editing_review_for_html", link: link_to(@review.product.name, product_path(@review.product))) %>
+	<%= I18n.t("spree.editing_review_for_html", product_name: @review.product.name) %>
 <% end %>
 
 <% render 'spree/admin/shared/product_sub_menu' %>
@@ -21,6 +21,8 @@
 	<div class="clear"></div>
 
 	<fieldset class="no-border-top">
-		<%= render 'spree/admin/shared/edit_resource_links' %>
+		<% if can? :manage, Spree::Review %>
+			<%= render 'spree/admin/shared/edit_resource_links' %>
+		<% end %>
 	</fieldset>
 <% end %>

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

@@ -5,7 +5,9 @@
 <% end %>
 
 <% content_for :table_filter_title do %>
-  <%= I18n.t("spree.search") %>
+  <% if can? :display, Spree::Review %>
+    <%= I18n.t("spree.search") %>
+  <% end %>
 <% end %>
 
 <% content_for :table_filter do %>
@@ -94,7 +96,7 @@
             <% end %>
           </td>
           <td class="align-center">
-            <%= review.user_id ? link_to(review.user.try(:email), [:admin, review.user]) : I18n.t("spree.anonymous") %></p>
+            <p><%= review.user_id ? link_to(review.user.try(:email), [:admin, review.user]) : I18n.t("spree.anonymous") %></p>
             <p><%= Spree::Review.human_attribute_name(:ip_address) %>: <%= review.ip_address ? link_to(review.ip_address, "http://whois.domaintools.com/#{review.ip_address}") : '-' %></p>
           </td>
           <td class="align-center">
@@ -106,9 +108,11 @@
             <% end %>
           </td>
           <td class="actions">
-            <%= link_to_with_icon 'ok', I18n.t("spree.approve"), approve_admin_review_url(review), no_text: true, class: 'approve' unless review.approved %>
-            <%= link_to_edit review, no_text: true, class: 'edit' %>
-            <%= link_to_delete review, no_text: true %>
+            <% if can? :manage, Spree::Review %>
+              <%= link_to_with_icon 'ok', I18n.t("spree.approve"), approve_admin_review_url(review), no_text: true, class: 'approve' unless review.approved %>
+              <%= link_to_edit review, no_text: true, class: 'edit' %>
+              <%= link_to_delete review, no_text: true %>
+            <% end %>
           </td>
         </tr>
       <% end %>

data/app/views/spree/api/reviews/_feedback_review.json.jbuilder

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 json.cache! [I18n.locale, feedback_review] do
-  json.(feedback_review, *feedback_review_attributes)
+  json.call(feedback_review, *feedback_review_attributes)
 end

data/app/views/spree/api/reviews/_review.json.jbuilder

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 json.cache! [I18n.locale, review] do
-  json.(review, *review_attributes)
+  json.call(review, *review_attributes)
   json.images(review.images) do |image|
     json.partial!("spree/api/images/image", image: image)
   end

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

@@ -21,10 +21,12 @@
     <%= f.text_area :review, wrap: "virtual", rows: "10", cols: "50" %>
   </p>
 
-  <p class="review_images_field">
-    <%= f.label :images %><br>
-    <%= f.file_field :images, :accept => "image/*", multiple: true %>
-  </p>
+  <% if Spree::Reviews::Config[:allow_image_upload] %>
+    <p class="review_images_field">
+      <%= f.label :images %><br>
+      <%= f.file_field :images, :accept => "image/*", multiple: true %>
+    </p>
+  <% end %>
 
   <% if Spree::Reviews::Config[:render_show_identifier_checkbox] %>
     <p class="review_show_identifier_field">

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

@@ -0,0 +1,3 @@
+<%= content_tag :h2, I18n.t("spree.leave_us_a_review_for", name: @product.name), class: 'new-review-title' %>
+
+<%= render 'form', review: @review, product: @product %>

data/app/views/spree/shared/_review.html.erb

@@ -24,10 +24,12 @@
     <div itemprop="reviewBody">
       <%= simple_format(review.review) %>
     </div>
-    <% review.images.each do |image| %>
-      <div itemprop="image">
-        <%= link_to image_tag(image.url(:product)), image.url(:original) %>
-      </div>
+    <% if Spree::Reviews::Config[:allow_image_upload] %>
+      <% review.images.each do |image| %>
+        <div itemprop="image">
+          <%= link_to image_tag(image.url(:product)), image.url(:original) %>
+        </div>
+      <% end %>
     <% end %>
     <% if Spree::Reviews::Config[:feedback_rating] && (!Spree::Reviews::Config[:require_login] || spree_current_user) %>
       <div class="feedback_review" id="feedback_review_<%= review.id %>">

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "solidus_reviews"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+$LOAD_PATH.unshift(*Dir["#{__dir__}/../app/*"])
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rails

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
-# frozen_string_literal: true
 
-# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
-
-ENGINE_PATH = File.expand_path('..', __dir__)
-load File.expand_path('../spec/dummy/script/rails', __dir__)
+if %w[g generate].include? ARGV.first
+  exec "#{__dir__}/rails-engine", *ARGV
+else
+  exec "#{__dir__}/rails-sandbox", *ARGV
+end

data/bin/rails-engine

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/solidus_reviews/engine', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/rails-sandbox

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+app_root = 'sandbox'
+
+unless File.exist? "#{app_root}/bin/rails"
+  warn 'Creating the sandbox app...'
+  Dir.chdir "#{__dir__}/.." do
+    system "#{__dir__}/sandbox" or begin
+      warn 'Automatic creation of the sandbox app failed'
+      exit 1
+    end
+  end
+end
+
+Dir.chdir app_root
+exec 'bin/rails', *ARGV

data/bin/rake

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/sandbox

@@ -0,0 +1,86 @@
+#!/usr/bin/env bash
+
+set -e
+
+case "$DB" in
+postgres|postgresql)
+  RAILSDB="postgresql"
+  ;;
+mysql)
+  RAILSDB="mysql"
+  ;;
+sqlite|'')
+  RAILSDB="sqlite3"
+  ;;
+*)
+  echo "Invalid DB specified: $DB"
+  exit 1
+  ;;
+esac
+
+if [ ! -z $SOLIDUS_BRANCH ]
+then
+  BRANCH=$SOLIDUS_BRANCH
+else
+  BRANCH="master"
+fi
+
+extension_name="solidus_reviews"
+
+# Stay away from the bundler env of the containing extension.
+function unbundled {
+  ruby -rbundler -e'b = proc {system *ARGV}; Bundler.respond_to?(:with_unbundled_env) ? Bundler.with_unbundled_env(&b) : Bundler.with_clean_env(&b)' -- $@
+}
+
+rm -rf ./sandbox
+unbundled bundle exec rails new sandbox --database="$RAILSDB" \
+  --skip-bundle \
+  --skip-git \
+  --skip-keeps \
+  --skip-rc \
+  --skip-spring \
+  --skip-test \
+  --skip-javascript
+
+if [ ! -d "sandbox" ]; then
+  echo 'sandbox rails application failed'
+  exit 1
+fi
+
+cd ./sandbox
+cat <<RUBY >> Gemfile
+gem 'solidus', github: 'solidusio/solidus', branch: '$BRANCH'
+gem 'solidus_auth_devise', '>= 2.1.0'
+gem 'rails-i18n'
+gem 'solidus_i18n'
+
+gem '$extension_name', path: '..'
+
+group :test, :development do
+  platforms :mri do
+    gem 'pry-byebug'
+  end
+end
+RUBY
+
+unbundled bundle install --gemfile Gemfile
+
+unbundled bundle exec rake db:drop db:create
+
+unbundled bundle exec rails generate spree:install \
+  --auto-accept \
+  --user_class=Spree::User \
+  --enforce_available_locales=true \
+  --with-authentication=false \
+  --payment-method=none
+  $@
+
+unbundled bundle exec rails generate solidus:auth:install
+unbundled bundle exec rails generate ${extension_name}:install
+
+echo
+echo "🚀 Sandbox app successfully created for $extension_name!"
+echo "🚀 Using $RAILSDB and Solidus $BRANCH"
+echo "🚀 Use 'export DB=[postgres|mysql|sqlite]' to control the DB adapter"
+echo "🚀 Use 'export SOLIDUS_BRANCH=<BRANCH-NAME>' to control the Solidus version"
+echo "🚀 This app is intended for test purposes."

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+gem install bundler --conservative
+bundle update
+bin/rake clobber

data/config/locales/de-CH.yml

@@ -36,7 +36,7 @@ de-CH:
       one: basiert auf einer Rezension
       other: "basiert auf %{count} Rezensionen"
     by: Von
-    editing_review_for_html: 'Rezension über %{link} bearbeiten'
+    editing_review_for_html: 'Rezension über %{product_name} bearbeiten'
     error_approve_review: Fehler bei der Freischaltung
     error_no_product: Das rezensierte Produkt existiert nicht mehr.
     feedback: Feedback

data/config/locales/de.yml

@@ -36,7 +36,7 @@ de:
       one: basiert auf einer Rezension
       other: "basiert auf %{count} Rezensionen"
     by: Von
-    editing_review_for_html: 'Rezension über %{link} bearbeiten'
+    editing_review_for_html: 'Rezension über %{product_name} bearbeiten'
     error_approve_review: Fehler bei der Freischaltung
     error_no_product: Das rezensierte Produkt existiert nicht mehr.
     feedback: Feedback

data/config/locales/en-GB.yml

@@ -35,7 +35,7 @@ en-GB:
       one: based upon one review
       other: "based upon %{count} reviews"
     by: by
-    editing_review_for_html: 'Editing review for %{link}'
+    editing_review_for_html: 'Editing review for %{product_name}'
     error_approve_review: Error approving review
     error_no_product: The reviewed product doesn't exist anymore
     feedback: Feedback
@@ -64,6 +64,7 @@ en-GB:
       show_email: Show email addresses
       show_verified_purchaser: Show verified purchaser
       track_locale: Track user's locale
+      allow_image_upload: Allow images to be attached to reviews
     star:
       one: "1"
       other: "%{count}"

data/config/locales/en.yml

@@ -35,7 +35,7 @@ en:
       one: based upon one review
       other: "based upon %{count} reviews"
     by: by
-    editing_review_for_html: 'Editing review for %{link}'
+    editing_review_for_html: 'Editing review for %{product_name}'
     error_approve_review: Error approving review
     error_no_product: The reviewed product doesn't exist anymore
     feedback: Feedback
@@ -64,6 +64,7 @@ en:
       show_email: Show email addresses
       show_verified_purchaser: Show verified purchaser
       track_locale: Track user's locale
+      allow_image_upload: Allow images to be attached to reviews
     star:
       one: "1"
       other: "%{count}"

data/config/locales/es.yml

@@ -35,7 +35,7 @@ es:
       one: "basado en una valoración"
       other: "basado en %{count} valoraciones"
     by: por
-    editing_review_for_html: 'Editando la valoración para %{link}'
+    editing_review_for_html: 'Editando la valoración para %{product_name}'
     error_approve_review: "Error aprobando la valoración"
     error_no_product: "El producto valorado ya no existe"
     feedback: Feedback
@@ -64,6 +64,7 @@ es:
       show_email: "Mostrar las direcciones de correo"
       show_verified_purchaser: Mostrar comprador verificado
       track_locale: "Rastrear el locale del usuario"
+      allow_image_upload: "Permitir adjuntar imagenes con el comentario"
     star:
       one: "1"
       other: "%{count}"

data/config/locales/fr.yml

@@ -35,7 +35,7 @@ fr:
       one: basé sur un commentaire
       other: "basé sur %{count} commentaires"
     by: par
-    editing_review_for_html: 'Modification du commentaire pour %{link}'
+    editing_review_for_html: 'Modification du commentaire pour %{product_name}'
     error_approve_review: Erreur en approuvant le commentaire
     error_no_product: Le produit commenté n'existe plus
     feedback: Réaction

data/config/locales/it.yml

@@ -34,7 +34,7 @@ it:
       one: basato su una recensione
       other: "basato su %{count} recensioni"
     by: da
-    editing_review_for_html: 'Modifica la recensione per %{link}'
+    editing_review_for_html: 'Modifica la recensione per %{product_name}'
     error_approve_review: Errore approvazione recensione
     error_no_product: "Il prodotto recensito non esiste più"
     feedback: Feedback

data/config/locales/pl.yml

@@ -37,7 +37,7 @@ pl:
       few: "na podstawie %{count} opinii"
       other: "na podstawie %{count} opinii"
     by: "przez"
-    editing_review_for_html: 'Edycja opinii dla %{link}'
+    editing_review_for_html: 'Edycja opinii dla %{product_name}'
     error_approve_review: Błąd przy zatwierdzaniu opinii
     error_no_product: Oceniamy produkt nie istnieje
     feedback: Komentarz

data/config/locales/pt-BR.yml

@@ -35,7 +35,7 @@ pt-BR:
       one: 'baseado em uma avaliação'
       other: "baseado em %{count} avaliações"
     by: 'por'
-    editing_review_for_html: 'Editando avaliação para %{link}'
+    editing_review_for_html: 'Editando avaliação para %{product_name}'
     error_approve_review: 'Erro aprovando avaliação'
     error_no_product: "O produto avaliado não existe mais"
     feedback: 'Parecer'

data/config/locales/pt.yml

@@ -35,7 +35,7 @@ pt:
       one: baseada numa avaliação
       other: "baseada em %{count} avaliações"
     by: por
-    editing_review_for_html: 'Editando a avaliação para %{link}'
+    editing_review_for_html: 'Editando a avaliação para %{product_name}'
     error_approve_review: Erro aprovando a avaliação
     error_no_product: O produto avaliado já não existe
     feedback: Feedback

data/config/locales/ro.yml

@@ -39,7 +39,7 @@ ro:
       other: "bazată pe %{count} recenzii"
       many: "bazată pe %{count} de recenzii"
     by: de
-    editing_review_for_html: 'Editare recenzie pentru %{link}'
+    editing_review_for_html: 'Editare recenzie pentru %{product_name}'
     error_approve_review: Eroare la aprobarea recenziei
     error_no_product: Produsul recenziat nu mai există
     feedback: Feedback

data/config/locales/sv.yml

@@ -35,7 +35,7 @@ sv:
       one: "baserad på en recension"
       other: "baserad på %{count} recensioner"
     by: av
-    editing_review_for_html: "Editerad recension för %{link}"
+    editing_review_for_html: "Editerad recension för %{product_name}"
     error_approve_review: "Problem med att godkänna recension"
     error_no_product: "Den betygsatta produkten finns inte längre"
     feedback: Återkoppling

data/config/locales/tr.yml

@@ -35,7 +35,7 @@ tr:
       one: bir incelemeye göre
       other: "%{count} incelemeye göre"
     by: tarafından
-    editing_review_for_html: 'Yorumu düzenle %{link}'
+    editing_review_for_html: 'Yorumu düzenle %{product_name}'
     error_approve_review: Yorum onaylamada hata
     error_no_product: Yorumlanan ürün artık yok
     feedback: Geri bildirim

data/config/locales/uk.yml

@@ -39,7 +39,7 @@ uk:
       many: "на основі %{count} відгуків"
       other: "на основі %{count} відгуків"
     by: від
-    editing_review_for_html: 'Редагувати відгук на %{link}'
+    editing_review_for_html: 'Редагувати відгук на %{product_name}'
     error_approve_review: Не вдалось схвалити відгук
     error_no_product: Товару, на який писався відгук, більше не існує
     feedback: Корисність

data/config/locales/zh-CN.yml

@@ -33,7 +33,7 @@ zh-CN:
       one: 以评论为基础
       other: "以 %{count} 個评论为基础"
     by: 由
-    editing_review_for_html: '正在修改 %{link} 的评论'
+    editing_review_for_html: '正在修改 %{product_name} 的评论'
     error_approve_review: 出错了，不能核准评论
     error_no_product: 被评论的产品不存在了。
     feedback: 回馈

data/config/locales/zh-TW.yml

@@ -33,7 +33,7 @@ zh-TW:
       one: 以評論為基礎
       other: '以 %{count} 個評論為基礎'
     by: 由
-    editing_review_for_html: '正在修改 %{link} 的評論'
+    editing_review_for_html: '正在修改 %{product_name} 的評論'
     error_approve_review: 出錯了，不能核準評論
     error_no_product: 被評論的產品不存在了。
     feedback: 回饋

data/config/routes.rb

@@ -13,7 +13,7 @@ Spree::Core::Engine.routes.draw do
   end
 
   resources :products, only: [] do
-    resources :reviews, only: [:index, :new, :create] do
+    resources :reviews, only: [:index, :new, :create, :edit, :update] do
     end
   end
   post '/reviews/:review_id/feedback(.:format)' => 'feedback_reviews#create', as: :feedback_reviews
@@ -22,6 +22,8 @@ Spree::Core::Engine.routes.draw do
     namespace :api, defaults: { format: 'json' } do
       resources :reviews, only: [:show, :create, :update, :destroy]
 
+      resources :feedback_reviews, only: [:create, :update, :destroy]
+
       resources :products do
         resources :reviews, only: [:index]
       end

data/db/migrate/20120123141326_recalculate_ratings.rb

@@ -16,6 +16,5 @@ class RecalculateRatings < SolidusSupport::Migration[4.2]
     end
   end
 
-  def down
-  end
+  def down; end
 end

data/db/migrate/20190613165528_add_verified_purchaser_to_reviews.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class AddVerifiedPurchaserToReviews < SolidusSupport::Migration[4.2]
   def change
     add_column :spree_reviews, :verified_purchaser, :boolean, default: false