solidus_reviews 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d08b28f0274d8513a1b171c01fb30e52ef1c692e7166e9680cb62d19731605b3
-  data.tar.gz: b091c19c062b9dd3cd98c9726b9aab52371817e901a87e15e812349b9ca1a032
+  metadata.gz: fd38dd224e866160ae90ea04068f08ca4c12d0d32337751ee58676bf8d757a84
+  data.tar.gz: d3d3f890af762394201f11aee1fa3c18fd97755b7c31ac200f04df0eafef5923
 SHA512:
-  metadata.gz: 6d3044e1fa6a0d03491cef8269730d25be40d1ad3e1ebcd32cf81ce71c8dc520a29d8bd8e6415bc738075c11478461cb4be0eb53007d6adb8e613970d835f5e8
-  data.tar.gz: a34b5ea8da48129b82c7063fa9806a635f3d92949fae6a0af0b98c58337480db6dc2e7cfe5f61e8cd1077834e14557ddc72d41127f8664b227fcc62b1fd0791a
+  metadata.gz: bb4483b6bdfbf36e9153ed347c4b6b0fc19c2fabeb3ef55eb3cc48bea3ce7eb0a185f5ef3bcf0b0ebdb317b45dc071beee7961d4883083e0936aed536c079958
+  data.tar.gz: 8a30750194cd8485cf9db0f4920718be0d5f7e71ced59187bba4a8fd43051eca0c5323113c9b3260836e5ef9bcec93fd00458f5e8c08311f889a197eb7150db7

data/.gem_release.yml

@@ -0,0 +1,5 @@
+bump:
+  recurse: false
+  file: 'lib/solidus_reviews/version.rb'
+  message: Bump SolidusReviews to %{version}
+  tag: true

data/.github/stale.yml

@@ -0,0 +1,17 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

data/.gitignore

@@ -1,13 +1,16 @@
 *.gem
-*.swp
-.bundle
-.idea
+\#*
+*~
+.#*
 .DS_Store
+.idea
+.project
+.sass-cache
+coverage
 Gemfile.lock
-pkg/*
+tmp
+nbproject
+pkg
+*.swp
 spec/dummy
-coverage
-.rvmrc
-.ruby-version
-.ruby-gemset
 spec/examples.txt

data/.rspec

@@ -1,2 +1,2 @@
 --color
--f documentation
+--require spec_helper

data/.rubocop.yml

@@ -1,12 +1,2 @@
-inherit_from: .rubocop_todo.yml
-
 require:
-  - solidus_extension_dev_tools/rubocop
-
-inherit_gem:
-  solidus_extension_dev_tools: .rubocop.extension.yml
-
-AllCops:
-  Exclude:
-    - spec/dummy/**/*
-    - vendor/**/*
+  - solidus_dev_support/rubocop

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## [v1.4.0](https://github.com/solidusio-contrib/solidus_reviews/tree/v1.4.0) (2020-08-06)
+
+[Full Changelog](https://github.com/solidusio-contrib/solidus_reviews/compare/v1.3.0...v1.4.0)
+
+**Closed issues:**
+
+- Cannot select star rating when creating or editing a review [\#88](https://github.com/solidusio-contrib/solidus_reviews/issues/88)
+- uninitialized constant SolidusReviews::Spree::Admin \(NameError\) [\#77](https://github.com/solidusio-contrib/solidus_reviews/issues/77)
+- Dependabot can't resolve your Ruby dependency files [\#75](https://github.com/solidusio-contrib/solidus_reviews/issues/75)
+- Dependabot can't resolve your Ruby dependency files [\#74](https://github.com/solidusio-contrib/solidus_reviews/issues/74)
+- Dependabot can't resolve your Ruby dependency files [\#73](https://github.com/solidusio-contrib/solidus_reviews/issues/73)
+- Dependabot can't resolve your Ruby dependency files [\#71](https://github.com/solidusio-contrib/solidus_reviews/issues/71)
+- Dependabot can't resolve your Ruby dependency files [\#70](https://github.com/solidusio-contrib/solidus_reviews/issues/70)
+- Dependabot can't resolve your Ruby dependency files [\#69](https://github.com/solidusio-contrib/solidus_reviews/issues/69)
+- Users should be able to upload images as part of their review [\#67](https://github.com/solidusio-contrib/solidus_reviews/issues/67)
+
+**Merged pull requests:**
+
+- Replace deprected ` SolidusSupport::EngineExtensions::Decorators` with ` SolidusSupport::EngineExtensions` [\#93](https://github.com/solidusio-contrib/solidus_reviews/pull/93) ([marcrohloff](https://github.com/marcrohloff))
+- Allow solidus\_support 0.4 [\#92](https://github.com/solidusio-contrib/solidus_reviews/pull/92) ([mamhoff](https://github.com/mamhoff))
+- Fixes review title [\#91](https://github.com/solidusio-contrib/solidus_reviews/pull/91) ([memotoro](https://github.com/memotoro))
+- remove extraneous .css file [\#90](https://github.com/solidusio-contrib/solidus_reviews/pull/90) ([dhughesbc](https://github.com/dhughesbc))
+- Relax solidus\_support dependency [\#86](https://github.com/solidusio-contrib/solidus_reviews/pull/86) ([kennyadsl](https://github.com/kennyadsl))
+- Adds PermissionSets classes and checks for Reviews [\#85](https://github.com/solidusio-contrib/solidus_reviews/pull/85) ([memotoro](https://github.com/memotoro))
+- Adds controls for image uploads [\#83](https://github.com/solidusio-contrib/solidus_reviews/pull/83) ([memotoro](https://github.com/memotoro))
+- Add option to auto approve star only reviews [\#82](https://github.com/solidusio-contrib/solidus_reviews/pull/82) ([KaemonIsland](https://github.com/KaemonIsland))
+- Add touch to feedback review model [\#81](https://github.com/solidusio-contrib/solidus_reviews/pull/81) ([KaemonIsland](https://github.com/KaemonIsland))
+- Add feedback reviews to api [\#79](https://github.com/solidusio-contrib/solidus_reviews/pull/79) ([KaemonIsland](https://github.com/KaemonIsland))
+- Fix path for Spree::ProductsControllerDecorator [\#78](https://github.com/solidusio-contrib/solidus_reviews/pull/78) ([aldesantis](https://github.com/aldesantis))
+- Add edit and update methods to reviews controller [\#76](https://github.com/solidusio-contrib/solidus_reviews/pull/76) ([KaemonIsland](https://github.com/KaemonIsland))
+- Update to solidus\_dev\_support [\#72](https://github.com/solidusio-contrib/solidus_reviews/pull/72) ([aldesantis](https://github.com/aldesantis))
+
 ## [v1.3.0](https://github.com/solidusio-contrib/solidus_reviews/tree/v1.3.0) (2019-11-27)
 
 [Full Changelog](https://github.com/solidusio-contrib/solidus_reviews/compare/v1.2.0...v1.3.0)

data/Gemfile

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
-gem 'solidus', git: 'https://github.com/solidusio/solidus.git', branch: branch
-gem 'solidus_auth_devise'
+gem 'solidus', github: 'solidusio/solidus', branch: branch
 
 # Needed to help Bundler figure out how to resolve dependencies,
-# otherwise it takes forever to resolve them
-if branch == 'master' || Gem::Version.new(branch[1..-1]) >= Gem::Version.new('2.10.0')
-  gem 'rails', '~> 6.0'
-else
-  gem 'rails', '~> 5.0'
-end
+# otherwise it takes forever to resolve them.
+# See https://github.com/bundler/bundler/issues/6677
+gem 'rails', '>0.a'
+
+# Provides basic authentication functionality for testing parts of your engine
+gem 'solidus_auth_devise'
 
 case ENV['DB']
 when 'mysql'
@@ -23,10 +23,6 @@ else
   gem 'sqlite3'
 end
 
-group :test do
-  gem 'rails-controller-testing'
-end
-
-gem 'solidus_extension_dev_tools', github: 'solidusio-contrib/solidus_extension_dev_tools'
+gem 'rails-controller-testing', group: :test
 
 gemspec

data/{LICENSE.md → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2019 Solidus and contributors.
+Copyright (c) 2020 Solidus and contributors
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

data/Rakefile

@@ -1,23 +1,8 @@
 # frozen_string_literal: true
 
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-require 'rspec/core/rake_task'
-require 'spree/testing_support/extension_rake'
+require 'solidus_dev_support/rake_tasks'
+SolidusDevSupport::RakeTasks.install
 
-RSpec::Core::RakeTask.new
+task default: %w[extension:test_app extension:specs]
 
-task :default do
-  if Dir["spec/dummy"].empty?
-    Rake::Task[:test_app].invoke
-    Dir.chdir("../../")
-  end
-  Rake::Task[:spec].invoke
-end
-
-desc 'Generates a dummy app for testing'
-task :test_app do
-  ENV['LIB_NAME'] = 'solidus_reviews'
-  Rake::Task['extension:test_app'].invoke
-end
+Bundler::GemHelper.install_tasks

data/app/controllers/spree/reviews_controller.rb

@@ -2,7 +2,7 @@
 
 class Spree::ReviewsController < Spree::StoreController
   helper Spree::BaseHelper
-  before_action :load_product, only: [:index, :new, :create]
+  before_action :load_product, only: [:index, :new, :create, :edit, :update]
 
   def index
     @approved_reviews = Spree::Review.approved.where(product: @product)
@@ -13,9 +13,17 @@ class Spree::ReviewsController < Spree::StoreController
     authorize! :create, @review
   end
 
+  def edit
+    @review = Spree::Review.find(params[:id])
+    if @review.product.nil?
+      flash[:error] = I18n.t('spree.error_no_product')
+    end
+    authorize! :update, @review
+  end
+
   # save if all ok
   def create
-    params[:review][:rating].sub!(/\s*[^0-9]*\z/, '') if params[:review][:rating].present?
+    review_params[:rating].sub!(/\s*[^0-9]*\z/, '') if review_params[:rating].present?
 
     @review = Spree::Review.new(review_params)
     @review.product = @product
@@ -36,6 +44,25 @@ class Spree::ReviewsController < Spree::StoreController
     end
   end
 
+  def update
+    review_params[:rating].sub!(/\s*[^0-9]*\z/, '') if params[:review][:rating].present?
+
+    @review = Spree::Review.find(params[:id])
+
+    # Handle images
+    params[:review][:images]&.each do |image|
+      @review.images.new(attachment: image)
+    end
+
+    authorize! :update, @review
+    if @review.update(review_params)
+      flash[:notice] = I18n.t('spree.review_successfully_submitted')
+      redirect_to spree.product_path(@product)
+    else
+      render :edit
+    end
+  end
+
   private
 
   def load_product

data/app/decorators/controllers/solidus_reviews/spree/{admin/products_controller_decorator.rb → products_controller_decorator.rb}

@@ -7,10 +7,6 @@ module SolidusReviews
         base.class_eval do
           helper ::Spree::ReviewsHelper
         end
-
-        [:avg_rating, :reviews_count].each do |attribute|
-          ::Spree::PermittedAttributes.product_attributes << attribute
-        end
       end
 
       ::Spree::ProductsController.prepend self

data/app/models/spree/feedback_review.rb

@@ -3,7 +3,7 @@
 class Spree::FeedbackReview < ApplicationRecord
   belongs_to :user, class_name: Spree.user_class.to_s, optional: true
 
-  belongs_to :review, dependent: :destroy
+  belongs_to :review, touch: true
   validates :review, presence: true
 
   validates :rating, numericality: { only_integer: true,

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

@@ -3,11 +3,12 @@
 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
+  has_many   :feedback_reviews, dependent: :destroy
   has_many   :images, -> { order(:position) }, as: :viewable,
                                                dependent: :destroy, class_name: "Spree::Image"
 
-  before_create :verify_purchaser
+  before_save :verify_purchaser
+  before_save :approve_review, unless: :approved?
   after_save :recalculate_product_rating, if: :approved?
   after_destroy :recalculate_product_rating
 
@@ -52,4 +53,17 @@ class Spree::Review < ApplicationRecord
 
     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

@@ -14,6 +14,11 @@ class Spree::ReviewsAbility
       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?

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 %>