solidus_reviews 1.2.0 → 1.3.0

data/CHANGELOG.md

@@ -0,0 +1,100 @@
+# Changelog
+
+## [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)
+
+**Closed issues:**
+
+- sass/rails is deprecated. Please update to `require 'sassc/rails'` [\#48](https://github.com/solidusio-contrib/solidus_reviews/issues/48)
+- Class variable access from toplevel [\#47](https://github.com/solidusio-contrib/solidus_reviews/issues/47)
+
+**Merged pull requests:**
+
+- Prepare v1.3.0 [\#68](https://github.com/solidusio-contrib/solidus_reviews/pull/68) ([aldesantis](https://github.com/aldesantis))
+- Adopt solidus\_extension\_dev\_tools [\#66](https://github.com/solidusio-contrib/solidus_reviews/pull/66) ([aldesantis](https://github.com/aldesantis))
+- Switch to sassc/rails [\#65](https://github.com/solidusio-contrib/solidus_reviews/pull/65) ([pelargir](https://github.com/pelargir))
+- Fix flaky specs caused by bad preference stubbing [\#54](https://github.com/solidusio-contrib/solidus_reviews/pull/54) ([aldesantis](https://github.com/aldesantis))
+
+## [v1.2.0](https://github.com/solidusio-contrib/solidus_reviews/tree/v1.2.0) (2019-09-17)
+
+[Full Changelog](https://github.com/solidusio-contrib/solidus_reviews/compare/v1.1.1...v1.2.0)
+
+**Merged pull requests:**
+
+- Remove solidus\_auth\_devise as dependency [\#53](https://github.com/solidusio-contrib/solidus_reviews/pull/53) ([kennyadsl](https://github.com/kennyadsl))
+- Adopt CircleCI instead of Travis [\#51](https://github.com/solidusio-contrib/solidus_reviews/pull/51) ([aldesantis](https://github.com/aldesantis))
+
+## [v1.1.1](https://github.com/solidusio-contrib/solidus_reviews/tree/v1.1.1) (2019-08-15)
+
+[Full Changelog](https://github.com/solidusio-contrib/solidus_reviews/compare/v1.1.0...v1.1.1)
+
+**Closed issues:**
+
+- Rubygems release [\#22](https://github.com/solidusio-contrib/solidus_reviews/issues/22)
+
+**Merged pull requests:**
+
+- Adds missing API features to the index and show endpoints [\#46](https://github.com/solidusio-contrib/solidus_reviews/pull/46) ([ericsaupe](https://github.com/ericsaupe))
+
+## [v1.1.0](https://github.com/solidusio-contrib/solidus_reviews/tree/v1.1.0) (2019-08-14)
+
+[Full Changelog](https://github.com/solidusio-contrib/solidus_reviews/compare/v1.0.0...v1.1.0)
+
+**Closed issues:**
+
+- Support rating only reviews [\#41](https://github.com/solidusio-contrib/solidus_reviews/issues/41)
+- Settings \> Reviews styling is broken [\#35](https://github.com/solidusio-contrib/solidus_reviews/issues/35)
+- Need add key to translate file ru.yml [\#23](https://github.com/solidusio-contrib/solidus_reviews/issues/23)
+- Error in solidus 2.1 due to add\_routes method [\#5](https://github.com/solidusio-contrib/solidus_reviews/issues/5)
+
+**Merged pull requests:**
+
+- General Typos [\#45](https://github.com/solidusio-contrib/solidus_reviews/pull/45) ([ericsaupe](https://github.com/ericsaupe))
+- Updated API to include new fields [\#44](https://github.com/solidusio-contrib/solidus_reviews/pull/44) ([ericsaupe](https://github.com/ericsaupe))
+- Fix specs [\#43](https://github.com/solidusio-contrib/solidus_reviews/pull/43) ([ericsaupe](https://github.com/ericsaupe))
+- Rating only reviews [\#42](https://github.com/solidusio-contrib/solidus_reviews/pull/42) ([ericsaupe](https://github.com/ericsaupe))
+- Adds verified purchaser [\#40](https://github.com/solidusio-contrib/solidus_reviews/pull/40) ([ericsaupe](https://github.com/ericsaupe))
+- Cleanup [\#39](https://github.com/solidusio-contrib/solidus_reviews/pull/39) ([ericsaupe](https://github.com/ericsaupe))
+- Added Images to Reviews [\#38](https://github.com/solidusio-contrib/solidus_reviews/pull/38) ([ericsaupe](https://github.com/ericsaupe))
+- Add missing admin translation [\#37](https://github.com/solidusio-contrib/solidus_reviews/pull/37) ([jtapia](https://github.com/jtapia))
+- Fix wrong locale id for require login in admin [\#36](https://github.com/solidusio-contrib/solidus_reviews/pull/36) ([kevinnio](https://github.com/kevinnio))
+- Gem maintenance [\#34](https://github.com/solidusio-contrib/solidus_reviews/pull/34) ([spaghetticode](https://github.com/spaghetticode))
+- Remove Solidus v2.3 from Travis config \(EOL\) [\#33](https://github.com/solidusio-contrib/solidus_reviews/pull/33) ([aitbw](https://github.com/aitbw))
+- Add Solidus v2.7 and v2.8 to Travis config [\#32](https://github.com/solidusio-contrib/solidus_reviews/pull/32) ([aitbw](https://github.com/aitbw))
+- Fix deprecation warnings [\#31](https://github.com/solidusio-contrib/solidus_reviews/pull/31) ([aitbw](https://github.com/aitbw))
+- Fix Travis build [\#30](https://github.com/solidusio-contrib/solidus_reviews/pull/30) ([aitbw](https://github.com/aitbw))
+- Fix validation i18n [\#29](https://github.com/solidusio-contrib/solidus_reviews/pull/29) ([mamhoff](https://github.com/mamhoff))
+- Avoid conflicts when same rating HTML is repeated on page [\#28](https://github.com/solidusio-contrib/solidus_reviews/pull/28) ([spaghetticode](https://github.com/spaghetticode))
+- Add missing TH tag [\#27](https://github.com/solidusio-contrib/solidus_reviews/pull/27) ([spaghetticode](https://github.com/spaghetticode))
+- Use default translation key structure for validation message [\#26](https://github.com/solidusio-contrib/solidus_reviews/pull/26) ([aldesantis](https://github.com/aldesantis))
+- Remove redundant rescue\_from from api controller [\#24](https://github.com/solidusio-contrib/solidus_reviews/pull/24) ([dgra](https://github.com/dgra))
+- Improve specs [\#21](https://github.com/solidusio-contrib/solidus_reviews/pull/21) ([kennyadsl](https://github.com/kennyadsl))
+- Refactor spec helper to let specs pass [\#20](https://github.com/solidusio-contrib/solidus_reviews/pull/20) ([kennyadsl](https://github.com/kennyadsl))
+- Fix Trevis CI badge to use master branch status [\#19](https://github.com/solidusio-contrib/solidus_reviews/pull/19) ([kennyadsl](https://github.com/kennyadsl))
+- Fix bundle install issue with solidus\_auth\_devise 2.0 [\#18](https://github.com/solidusio-contrib/solidus_reviews/pull/18) ([kennyadsl](https://github.com/kennyadsl))
+- Fix resetting preferences in specs [\#17](https://github.com/solidusio-contrib/solidus_reviews/pull/17) ([kennyadsl](https://github.com/kennyadsl))
+- Add italian translations [\#16](https://github.com/solidusio-contrib/solidus_reviews/pull/16) ([vassalloandrea](https://github.com/vassalloandrea))
+- Add user email to admin review editing page [\#15](https://github.com/solidusio-contrib/solidus_reviews/pull/15) ([pelargir](https://github.com/pelargir))
+- Api interface [\#14](https://github.com/solidusio-contrib/solidus_reviews/pull/14) ([dgra](https://github.com/dgra))
+- General Solidus 2.3 updates [\#13](https://github.com/solidusio-contrib/solidus_reviews/pull/13) ([dgra](https://github.com/dgra))
+- Prefix named route [\#11](https://github.com/solidusio-contrib/solidus_reviews/pull/11) ([pelargir](https://github.com/pelargir))
+- Add the has\_many association for reviews from a user [\#10](https://github.com/solidusio-contrib/solidus_reviews/pull/10) ([dgra](https://github.com/dgra))
+- Updates to Solidus admin UI [\#9](https://github.com/solidusio-contrib/solidus_reviews/pull/9) ([tvdeyen](https://github.com/tvdeyen))
+- Update for Solidus 2.1 [\#6](https://github.com/solidusio-contrib/solidus_reviews/pull/6) ([kennyadsl](https://github.com/kennyadsl))
+
+## [v1.0.0](https://github.com/solidusio-contrib/solidus_reviews/tree/v1.0.0) (2017-02-03)
+
+[Full Changelog](https://github.com/solidusio-contrib/solidus_reviews/compare/8640958dc42f9472cb5cbb85cab981a44f4c45db...v1.0.0)
+
+**Merged pull requests:**
+
+- Allow solidus\_auth\_devise \< 1.5 [\#8](https://github.com/solidusio-contrib/solidus_reviews/pull/8) ([tvdeyen](https://github.com/tvdeyen))
+- Test against multiple Solidus 1.x versions [\#7](https://github.com/solidusio-contrib/solidus_reviews/pull/7) ([tvdeyen](https://github.com/tvdeyen))
+- Fix install generator [\#3](https://github.com/solidusio-contrib/solidus_reviews/pull/3) ([andrewjwu](https://github.com/andrewjwu))
+- Do not add CRUD product routes to frontend [\#2](https://github.com/solidusio-contrib/solidus_reviews/pull/2) ([mamhoff](https://github.com/mamhoff))
+- Move factories into `lib` [\#1](https://github.com/solidusio-contrib/solidus_reviews/pull/1) ([alexblackie](https://github.com/alexblackie))
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -6,26 +6,27 @@ branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
 gem 'solidus', git: 'https://github.com/solidusio/solidus.git', branch: branch
 gem 'solidus_auth_devise'
 
-# Needed to help Bundler figure out how to resolve dependencies, otherwise it takes forever to
-# resolve them
+# 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
 
-gem 'puma'
-gem 'rails-controller-testing', group: :test
-
 case ENV['DB']
 when 'mysql'
-  gem 'mysql2', '~> 0.4.10'
-when 'postgres'
-  gem 'pg', '~> 0.21'
+  gem 'mysql2'
+when 'postgresql'
+  gem 'pg'
+else
+  gem 'sqlite3'
 end
 
-group :development, :test do
-  gem 'factory_bot', '> 4.10.0'
+group :test do
+  gem 'rails-controller-testing'
 end
 
+gem 'solidus_extension_dev_tools', github: 'solidusio-contrib/solidus_extension_dev_tools'
+
 gemspec

data/README.md

@@ -1,12 +1,10 @@
-# Reviews
+# Solidus Reviews
 
 [![CircleCI](https://circleci.com/gh/solidusio-contrib/solidus_reviews.svg?style=svg)](https://circleci.com/gh/solidusio-contrib/solidus_reviews)
 
-Straightforward review/rating functionality, updated for
-[Solidus](https://solidus.io). While the Gem name has changed, the module
-namespace and commands are still `spree` for now.
+Straightforward review/rating functionality, updated for [Solidus](https://solidus.io).
 
----
+While the gem's name has changed, the module namespace and commands are still `spree` for now.
 
 ## Installation
 
@@ -17,75 +15,62 @@ gem 'solidus_reviews', github: 'solidusio-contrib/solidus_reviews'
 ```
 Now bundle up with:
 
-    bundle
+```console
+$ bundle
+```
 
 Next, run the rake task that copies the necessary migrations and assets to your project:
 
-    rails g solidus_reviews:install
+```console
+$ rails g solidus_reviews:install
+```
+
 
 And finish with a migrate:
 
-    rake db:migrate
+```console
+$ rake db:migrate
+```
 
 Now you should be able to boot up your server with:
 
-    rails s
+```console
+$ rails s
+```
 
 That's all!
 
----
-
 ## Usage
 
-Action "submit" in "reviews" controller - goes to review entry form
-
-Users must be logged in to submit a review
+The `Spree::ReviewsController` controller provides all the CRUD functionality for product reviews.
 
-Three partials:
- - `app/views/spree/products/_rating.html.erb` -- display number of stars
- - `app/views/spree/products/_shortrating.html.erb` -- shorter version of above
- - `app/views/spree/products/_review.html.erb` -- display a single review
+The `Spree::FeedbackReviewsController` allows user to express their feedback on a specific review.
+You can think of these as meta-reviews (e.g. the classic "Was this useful?" modal).
 
-Administrator can edit and/or approve and/or delete reviews.
+You can approve, edit and delete reviews and feedback reviews from the backend.
 
 ## Factories
 
-If you want factories for our models available in your application, simply
-require our factories in your `spec_helper.rb`:
+If you want factories for our models available in your application, simply require our factories in
+your `spec_helper.rb`:
 
 ```ruby
-require "solidus_reviews/factories"
+require 'solidus_reviews/factories'
 ```
 
-## Implementation
-
-Reviews table is quite obvious - and note the "approved" flag which is for the
-administrator to update.
-
-Ratings table holds current fractional value - avoids frequent recalc...
-
----
-
 ## Testing
 
-Just run the following to automatically build a dummy app if necessary and
-run the tests:
+Just run the following to automatically build a dummy app if necessary and run the tests:
 
 ```shell
-bundle exec rake
+$ bundle exec rake
 ```
 
----
-
 ## Contributing
 
-See corresponding [contributing guidelines][1].
-
----
+Bug reports and pull requests are welcome on GitHub at <https://github.com/solidusio-contrib/solidus_reviews>.
 
-Copyright (c) 2009-2019 [Solidus][2] and [contributors][3], released under the [New BSD License][4]
+## License
 
-[1]: ./CONTRIBUTING.md
-[2]: https://github.com/solidusio
-[3]: https://github.com/solidusio-contrib/solidus_reviews/graphs/contributors
-[4]: ./LICENSE.md
+Copyright (c) 2009-2019 [Solidus](https://github.com/solidusio) and [contributors](https://github.com/solidusio-contrib/solidus_reviews/graphs/contributors),
+released under the [New BSD License](https://github.com/solidusio-contrib/solidus_reviews/blob/master/LICENSE.md).

data/app/controllers/spree/feedback_reviews_controller.rb

@@ -16,13 +16,7 @@ class Spree::FeedbackReviewsController < Spree::StoreController
     end
 
     respond_to do |format|
-      format.html {
-        if SolidusSupport.solidus_gem_version < Gem::Version.new('2.0')
-          redirect_to(:back)
-        else
-          redirect_back(fallback_location: root_path)
-        end
-      }
+      format.html { redirect_back(fallback_location: root_path) }
       format.js { render action: :create }
     end
   end
@@ -30,7 +24,7 @@ class Spree::FeedbackReviewsController < Spree::StoreController
   protected
 
   def load_review
-    @review ||= Spree::Review.find_by_id!(params[:review_id])
+    @review ||= Spree::Review.find_by!(id: params[:review_id])
   end
 
   def permitted_feedback_review_attributes

data/app/controllers/spree/reviews_controller.rb

@@ -15,7 +15,7 @@ class Spree::ReviewsController < Spree::StoreController
 
   # 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/, '') if params[:review][:rating].present?
 
     @review = Spree::Review.new(review_params)
     @review.product = @product

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module SolidusReviews
   module Spree
     module ProductDecorator
@@ -16,11 +17,11 @@ module SolidusReviews
         reviews_count = reviews.reload.default_approval_filter.count
 
         self.reviews_count = reviews_count
-        if reviews_count > 0
-          self.avg_rating = '%.1f' % (reviews.default_approval_filter.sum(:rating).to_f / reviews_count)
-        else
-          self.avg_rating = 0
-        end
+        self.avg_rating = if reviews_count > 0
+                            '%.1f' % (reviews.default_approval_filter.sum(:rating).to_f / reviews_count)
+                          else
+                            0
+                          end
         save
       end
 

data/app/helpers/spree/reviews_helper.rb

@@ -18,10 +18,10 @@ module Spree::ReviewsHelper
   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?
+                   .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,6 +1,6 @@
 # frozen_string_literal: true
 
-class Spree::FeedbackReview < ActiveRecord::Base
+class Spree::FeedbackReview < ApplicationRecord
   belongs_to :user, class_name: Spree.user_class.to_s, optional: true
 
   belongs_to :review, dependent: :destroy

data/app/models/spree/review.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-class Spree::Review < ActiveRecord::Base
+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   :images, -> { order(:position) }, as: :viewable,
-    dependent: :destroy, class_name: "Spree::Image"
+                                               dependent: :destroy, class_name: "Spree::Image"
 
   before_create :verify_purchaser
   after_save :recalculate_product_rating, if: :approved?
@@ -28,6 +28,7 @@ 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
 
@@ -36,18 +37,18 @@ class Spree::Review < ActiveRecord::Base
   end
 
   def email
-    user.try!(: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?
+                                       .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

data/app/models/spree/reviews_ability.rb

@@ -7,11 +7,11 @@ 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 read your own reviews, and everyone can read approved ones

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

data/lib/controllers/spree/api/reviews_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   module Api
     class ReviewsController < Spree::Api::BaseController
@@ -9,11 +11,11 @@ module Spree
       before_action :prevent_multiple_reviews, only: [:create]
 
       def index
-        if @product
-          @reviews = Spree::Review.default_approval_filter.where(product: @product)
-        else
-          @reviews = Spree::Review.where(user: @current_api_user)
-        end
+        @reviews = if @product
+                     Spree::Review.default_approval_filter.where(product: @product)
+                   else
+                     Spree::Review.where(user: @current_api_user)
+                   end
 
         respond_with(@reviews)
       end
@@ -34,7 +36,7 @@ module Spree
 
         authorize! :create, @review
         if @review.save
-          render json: @review, include: [:images, :feedback_reviews], status: 201
+          render json: @review, include: [:images, :feedback_reviews], status: :created
         else
           invalid_resource!(@review)
         end
@@ -46,7 +48,7 @@ module Spree
         attributes = review_params.merge(ip_address: request.remote_ip, approved: false)
 
         if @review.update(attributes)
-          render json: @review, include: [:images, :feedback_reviews], status: 200
+          render json: @review, include: [:images, :feedback_reviews], status: :ok
         else
           invalid_resource!(@review)
         end
@@ -56,7 +58,7 @@ module Spree
         authorize! :destroy, @review
 
         if @review.destroy
-          render json: @review, status: 200
+          render json: @review, status: :ok
         else
           invalid_resource!(@review)
         end
@@ -74,11 +76,11 @@ module Spree
 
       # Loads product from product id.
       def load_product
-        if params[:product_id]
-          @product = Spree::Product.friendly.find(params[:product_id])
-        else
-          @product = @review&.product
-        end
+        @product = if params[:product_id]
+                     Spree::Product.friendly.find(params[:product_id])
+                   else
+                     @review&.product
+                   end
       end
 
       # Finds user based on api_key or by user_id if api_key belongs to an admin.
@@ -104,7 +106,7 @@ module Spree
       # Converts rating strings like "5 units" to "5"
       # Operates on params
       def sanitize_rating
-        params[:rating].sub!(/\s*[^0-9]*\z/, '') unless params[:rating].blank?
+        params[:rating].sub!(/\s*[^0-9]*\z/, '') if params[:rating].present?
       end
     end
   end