solidus_reviews 1.3.0 → 1.4.0

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,15 @@
 #!/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.
+app_root = 'spec/dummy'
+
+unless File.exist? "#{app_root}/bin/rails"
+  system "bin/rake", app_root or begin # rubocop:disable Style/AndOr
+    warn "Automatic creation of the dummy app failed"
+    exit 1
+  end
+end
 
-ENGINE_PATH = File.expand_path('..', __dir__)
-load File.expand_path('../spec/dummy/script/rails', __dir__)
+Dir.chdir app_root
+exec 'bin/rails', *ARGV

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
+bundle exec rake extension:test_app

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/lib/controllers/spree/api/feedback_reviews_controller.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    class FeedbackReviewsController < Spree::Api::BaseController
+      respond_to :json
+
+      before_action :load_review, only: [:create, :update, :destroy]
+      before_action :load_feedback_review, only: [:update, :destroy]
+      before_action :find_review_user
+      before_action :sanitize_rating, only: [:create, :update]
+      before_action :prevent_multiple_feedback_reviews, only: [:create]
+
+      def create
+        if @review.present?
+          @feedback_review = @review.feedback_reviews.new(feedback_review_params)
+          @feedback_review.user = @current_api_user
+          @feedback_review.locale = I18n.locale.to_s if Spree::Reviews::Config[:track_locale]
+        end
+
+        authorize! :create, @feedback_review
+        if @feedback_review.save
+          render json: @feedback_review, status: :created
+        else
+          invalid_resource!(@feedback_review)
+        end
+      end
+
+      def update
+        authorize! :update, @feedback_review
+
+        if @feedback_review.update(feedback_review_params)
+          render json: @feedback_review, status: :ok
+        else
+          invalid_resource!(@feedback_review)
+        end
+      end
+
+      def destroy
+        authorize! :destroy, @feedback_review
+
+        if @feedback_review.destroy
+          render json: @feedback_review, status: :ok
+        else
+          invalid_resource!(@feedback_review)
+        end
+      end
+
+      private
+
+      def permitted_feedback_review_attributes
+        [:rating, :comment]
+      end
+
+      def feedback_review_params
+        params.require(:feedback_review).permit(permitted_feedback_review_attributes)
+      end
+
+      # Finds user based on api_key or by user_id if api_key belongs to an admin.
+      def find_review_user
+        if params[:user_id] && @current_user_roles.include?('admin')
+          @current_api_user = Spree.user_class.find(params[:user_id])
+        end
+      end
+
+      # Loads any review that is shared between the user and product
+      def load_review
+        @review = Spree::Review.find(params[:review_id])
+      end
+
+      # Loads the feedback_review
+      def load_feedback_review
+        @feedback_review = Spree::FeedbackReview.find(params[:id])
+      end
+
+      # Ensures that a user can't leave multiple feedbacks on a single review
+      def prevent_multiple_feedback_reviews
+        @feedback_review = @review.feedback_reviews.find_by(user_id: @current_api_user)
+        if @feedback_review.present?
+          invalid_resource!(@feedback_review)
+        end
+      end
+
+      # Converts rating strings like "5 units" to "5"
+      # Operates on params
+      def sanitize_rating
+        params[:rating].to_s.sub!(/\s*[^0-9]*\z/, '') unless params[:feedback_review] && params[:feedback_review][:rating].blank?
+      end
+    end
+  end
+end

data/lib/solidus_reviews.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require 'solidus'
+require 'solidus_core'
 require 'solidus_support'
-require 'sassc/rails'
 require 'deface'
-require 'coffee_script'
 
-require 'solidus_reviews/engine'
 require 'solidus_reviews/version'
+require 'solidus_reviews/engine'

data/lib/solidus_reviews/engine.rb

@@ -1,22 +1,26 @@
 # frozen_string_literal: true
 
+require 'spree/core'
+
 module SolidusReviews
   class Engine < Rails::Engine
-    require 'spree/core'
-    isolate_namespace ::Spree
+    include SolidusSupport::EngineExtensions
+
+    isolate_namespace Spree
+
     engine_name 'solidus_reviews'
 
-    def self.activate
-      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
-        Rails.configuration.cache_classes ? require(c) : load(c)
-      end
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    config.to_prepare do
       ::Spree::Ability.register_ability(::Spree::ReviewsAbility)
     end
 
     if SolidusSupport.api_available?
       paths["app/controllers"] << "lib/controllers"
     end
-
-    config.to_prepare &method(:activate).to_proc
   end
 end

data/lib/solidus_reviews/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidusReviews
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end

data/solidus_reviews.gemspec

@@ -4,25 +4,32 @@ $:.push File.expand_path('lib', __dir__)
 require 'solidus_reviews/version'
 
 Gem::Specification.new do |s|
-  s.platform = Gem::Platform::RUBY
   s.name = 'solidus_reviews'
   s.version = SolidusReviews::VERSION
   s.summary = 'Review and rating functionality for your Solidus store.'
-  s.authors = ['Solidus Contrib']
-  s.description = s.summary
-  s.required_ruby_version = '>= 1.9.3'
+  s.license = 'BSD-3-Clause'
 
+  s.author = 'Solidus Contrib'
   s.homepage = 'https://github.com/solidusio-contrib/solidus_reviews'
-  s.license = 'BSD-3'
 
-  s.files = `git ls-files`.split("\n")
-  s.test_files = `git ls-files -- spec/*`.split("\n")
-  s.require_path = 'lib'
-  s.requirements << 'none'
+  if s.respond_to?(:metadata)
+    s.metadata["homepage_uri"] = s.homepage if s.homepage
+    s.metadata["source_code_uri"] = s.homepage if s.homepage
+  end
+
+  s.required_ruby_version = '~> 2.4'
+
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  s.test_files = Dir['spec/**/*']
+  s.bindir = "exe"
+  s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
 
   s.add_dependency 'deface', '~> 1.0'
-  s.add_dependency 'solidus', ['>= 1.4', '< 3']
-  s.add_dependency 'solidus_support'
+  s.add_dependency 'solidus_core', ['>= 2.0.0', '< 3']
+  s.add_dependency 'solidus_support', '~> 0.4'
 
-  s.add_development_dependency 'solidus_extension_dev_tools'
+  s.add_development_dependency 'solidus_dev_support'
 end