solidus_reviews 1.0.0 → 1.1.0

data/lib/generators/solidus_reviews/install/install_generator.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module SolidusReviews
   module Generators
     class InstallGenerator < Rails::Generators::Base
-
-      class_option :auto_run_migrations, :type => :boolean, :default => false
+      class_option :auto_run_migrations, type: :boolean, default: false
 
       def add_javascripts
         append_file "vendor/assets/javascripts/spree/frontend/all.js", "//= require spree/frontend/solidus_reviews\n"
@@ -10,7 +11,7 @@ module SolidusReviews
       end
 
       def add_stylesheets
-        inject_into_file "vendor/assets/stylesheets/spree/frontend/all.css", " *= require spree/frontend/solidus_reviews\n", :before => /\*\//, :verbose => true
+        inject_into_file "vendor/assets/stylesheets/spree/frontend/all.css", " *= require spree/frontend/solidus_reviews\n", before: /\*\//, verbose: true
       end
 
       def add_migrations
@@ -18,7 +19,7 @@ module SolidusReviews
       end
 
       def run_migrations
-        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask 'Would you like to run the migrations now? [Y/n]')
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
         if run_migrations
           run 'bundle exec rake db:migrate'
         else

data/lib/solidus_reviews.rb

@@ -1,5 +1,7 @@
-require 'sass/rails'
+# frozen_string_literal: true
+
 require 'solidus'
+require 'sass/rails'
 require 'deface'
 require 'solidus_auth_devise'
 require 'spree_reviews/engine'

data/lib/solidus_reviews/factories.rb

@@ -1,4 +1,6 @@
-require "factory_girl"
+# frozen_string_literal: true
+
+require "factory_bot"
 
 Dir["#{File.dirname(__FILE__)}/factories/**"].each do |f|
   require File.expand_path(f)

data/lib/solidus_reviews/factories/feedback_review_factory.rb

@@ -1,8 +1,9 @@
-FactoryGirl.define do
-  factory :feedback_review, :class => Spree::FeedbackReview do |f|
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :feedback_review, class: Spree::FeedbackReview do |_f|
     user
     review
-    comment { generate(:random_description) }
-    rating  { rand(1..5) }
+    rating { rand(1..5) }
   end
-end
+end

data/lib/solidus_reviews/factories/review_factory.rb

@@ -1,20 +1,30 @@
-FactoryGirl.define do
-  factory :review, :class => Spree::Review do |f|
-    name   { generate(:random_email) }
-    title  { generate(:random_string) }
-    review { generate(:random_description) }
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :review, class: Spree::Review do |_f|
+    sequence(:name) { |i| "User #{i}" }
+    title { FFaker::Book.title }
+    review { 'This product is ok!' }
     rating { rand(1..5) }
-    approved false
-    show_identifier true
+    approved { false }
+    show_identifier { true }
     user
     product
 
     trait :approved do
-      approved true
+      approved { true }
     end
 
     trait :hide_identifier do
-      show_identifier false
+      show_identifier { false }
+    end
+
+    trait :with_image do
+      images {
+        [
+          FactoryBot.create(:image)
+        ]
+      }
     end
   end
 end

data/lib/spree_reviews/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SpreeReviews
   class Engine < Rails::Engine
     require 'spree/core'
@@ -12,6 +14,11 @@ module SpreeReviews
       end
       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/solidus_reviews.gemspec

@@ -1,15 +1,15 @@
+# frozen_string_literal: true
+
 Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.name        = 'solidus_reviews'
-  s.version     = '1.0.0'
-  s.summary     = 'Basic review and ratings facility for Spree'
-  s.authors 	  = ['Paul Callaghan']
+  s.version     = '1.1.0'
+  s.summary     = 'Basic review and ratings facility for Solidus'
+  s.authors = ['Solidus Contrib']
   s.description = s.summary
   s.required_ruby_version = '>= 1.9.3'
 
-  s.authors 	   = ['Paul Callaghan', 'Alex Blackie']
-  s.email        = 'paulcc.two@gmail.com'
-  s.homepage     = 'https://github.com/solidusio-contrib/solidus-reviews/'
+  s.homepage     = 'https://github.com/solidusio-contrib/solidus_reviews/'
   s.license      = 'BSD-3'
 
   s.files        = `git ls-files`.split("\n")
@@ -17,19 +17,21 @@ Gem::Specification.new do |s|
   s.require_path = 'lib'
   s.requirements << 'none'
 
-  s.add_dependency 'solidus', '~> 1.0'
-  s.add_dependency 'deface', '~> 1.0'
-  s.add_dependency 'solidus_auth_devise', '~> 1.0'
+  s.add_dependency 'deface', '~> 1'
+  s.add_dependency 'solidus', ['>= 1.4', '< 3']
+  s.add_dependency 'solidus_auth_devise', ['>= 1.0', '< 3']
+  s.add_dependency 'solidus_support', '~> 0.1'
 
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'capybara-screenshot'
+  s.add_development_dependency 'coffee-rails'
+  s.add_development_dependency 'database_cleaner'
   s.add_development_dependency 'ffaker'
-  s.add_development_dependency 'capybara', '~> 2.7'
-  s.add_development_dependency 'database_cleaner', '1.2.0'
-  s.add_development_dependency 'poltergeist', '~> 1.10.0'
-  s.add_development_dependency 'rspec-rails', '~> 3'
-  s.add_development_dependency 'factory_girl', '~> 4.4'
-  s.add_development_dependency 'sqlite3'
-  s.add_development_dependency 'simplecov', '~> 0.7.1'
-  s.add_development_dependency 'coffee-rails', '~> 4.0.0'
-  s.add_development_dependency 'sass-rails', '~> 5.0'
+  s.add_development_dependency 'poltergeist'
   s.add_development_dependency 'pry'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'rubocop', '~> 0.53.0'
+  s.add_development_dependency 'sass-rails'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'sqlite3', '~> 1.3.6'
 end

data/spec/controllers/admin/feedback_reviews_controller_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Spree::Admin::FeedbackReviewsController do
@@ -5,11 +7,11 @@ describe Spree::Admin::FeedbackReviewsController do
 
   before do
     user = create(:admin_user)
-    controller.stub(:try_spree_current_user => user)
+    allow(controller).to receive(:spree_current_user).and_return(user)
   end
 
   context '#index' do
-    let!(:review) { create(:review)}
+    let!(:review) { create(:review) }
     let!(:other_review) { create(:review) }
 
     let!(:feedback_review_1) { create(:feedback_review, created_at: 10.days.ago, review: review) }
@@ -20,10 +22,10 @@ describe Spree::Admin::FeedbackReviewsController do
     let!(:other_feedback_review_2) { create(:feedback_review, created_at: 2.days.ago, review: other_review) }
 
     it 'looks up feedback reviews for the specified review and renders the template' do
-      spree_get :index, review_id: review.id
-      response.status.should eq(200)
-      response.should render_template(:index)
-      assigns(:collection).should eq([feedback_review_2, feedback_review_3, feedback_review_1])
+      get :index, params: { review_id: review.id }
+      expect(response.status).to eq(200)
+      expect(response).to render_template(:index)
+      expect(assigns(:collection)).to eq([feedback_review_2, feedback_review_3, feedback_review_1])
     end
   end
-end
+end

data/spec/controllers/admin/review_settings_controller_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Spree::Admin::ReviewSettingsController do
@@ -5,13 +7,13 @@ describe Spree::Admin::ReviewSettingsController do
 
   before do
     user = create(:admin_user)
-    controller.stub(:try_spree_current_user => user)
+    allow(controller).to receive(:spree_current_user).and_return(user)
   end
 
   context '#update' do
     it 'redirects to edit-review-settings page' do
-      spree_put :update, preferences: { preview_size: 4 }
-      response.should redirect_to spree.edit_admin_review_settings_path
+      put :update, params: { preferences: { preview_size: 4 } }
+      expect(response).to redirect_to spree.edit_admin_review_settings_path
     end
 
     context 'For parameters:
@@ -22,36 +24,36 @@ describe Spree::Admin::ReviewSettingsController do
             track_locale: true' do
 
       it 'sets preferred_preview_size to 4' do
-        spree_put :update, preferences: { preview_size: 4 }
-        Spree::Reviews::Config.preferred_preview_size.should eq 4
+        put :update, params: { preferences: { preview_size: 4 } }
+        expect(Spree::Reviews::Config.preferred_preview_size).to eq 4
       end
 
       it 'sets preferred_show_email to false' do
-        spree_put :update, preferences: { show_email: false }
-        Spree::Reviews::Config.preferred_show_email.should be false
+        put :update, params: { preferences: { show_email: false } }
+        expect(Spree::Reviews::Config.preferred_show_email).to be false
       end
 
       it 'sets preferred_feedback_rating to false' do
-        spree_put :update, preferences: { feedback_rating: false }
-        Spree::Reviews::Config.preferred_feedback_rating.should be false
+        put :update, params: { preferences: { feedback_rating: false } }
+        expect(Spree::Reviews::Config.preferred_feedback_rating).to be false
       end
 
       it 'sets preferred_require_login to true' do
-        spree_put :update, preferences: { require_login: true }
-        Spree::Reviews::Config.preferred_require_login.should be true
+        put :update, params: { preferences: { require_login: true } }
+        expect(Spree::Reviews::Config.preferred_require_login).to be true
       end
 
       it 'sets preferred_track_locale to true' do
-        spree_put :update, preferences: { track_locale: true }
-        Spree::Reviews::Config.preferred_track_locale.should be true
+        put :update, params: { preferences: { track_locale: true } }
+        expect(Spree::Reviews::Config.preferred_track_locale).to be true
       end
     end
   end
 
   context '#edit' do
     it 'should render the edit template' do
-      spree_get :edit
-      response.should render_template(:edit)
+      get :edit
+      expect(response).to render_template(:edit)
     end
   end
-end
+end

data/spec/controllers/admin/reviews_controller_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Spree::Admin::ReviewsController do
@@ -8,7 +10,7 @@ describe Spree::Admin::ReviewsController do
 
   before do
     user = create(:admin_user)
-    controller.stub(try_spree_current_user: user)
+    allow(controller).to receive(:spree_current_user).and_return(user)
   end
 
   context '#index' do
@@ -17,30 +19,30 @@ describe Spree::Admin::ReviewsController do
         create(:review, product: product),
         create(:review, product: product)
       ]
-      spree_get :index, product_id: product.slug
-      assigns[:reviews].should =~ reviews
+      get :index, params: { product_id: product.slug }
+      expect(assigns[:reviews]).to match_array reviews
     end
   end
 
   context '#approve' do
     it 'show notice message when approved' do
       review.update_attribute(:approved, true)
-      spree_get :approve, id: review.id
-      response.should redirect_to spree.admin_reviews_path
-      flash[:notice].should eq Spree.t(:info_approve_review)
+      get :approve, params: { id: review.id }
+      expect(response).to redirect_to spree.admin_reviews_path
+      expect(flash[:success]).to eq I18n.t('spree.info_approve_review')
     end
 
     it 'show error message when not approved' do
-      Spree::Review.any_instance.stub(:update_attribute).and_return(false)
-      spree_get :approve, id: review.id
-      flash[:error].should eq Spree.t(:error_approve_review)
+      expect_any_instance_of(Spree::Review).to receive(:save).and_return(false)
+      get :approve, params: { id: review.id }
+      expect(flash[:error]).to eq I18n.t('spree.error_approve_review')
     end
   end
 
   context '#edit' do
     specify do
-      spree_get :edit, id: review.id
-      response.status.should eq(200)
+      get :edit, params: { id: review.id }
+      expect(response.status).to eq(200)
     end
 
     context 'when product is nil' do
@@ -50,14 +52,14 @@ describe Spree::Admin::ReviewsController do
       end
 
       it 'flash error' do
-        spree_get :edit, id: review.id
-        flash[:error].should eq Spree.t(:error_no_product)
+        get :edit, params: { id: review.id }
+        expect(flash[:error]).to eq I18n.t('spree.error_no_product')
       end
 
       it 'redirect to admin-reviews page' do
-        spree_get :edit, id: review.id
-        response.should redirect_to spree.admin_reviews_path
+        get :edit, params: { id: review.id }
+        expect(response).to redirect_to spree.admin_reviews_path
       end
     end
   end
-end
+end

data/spec/controllers/feedback_reviews_controller_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Spree::FeedbackReviewsController do
@@ -10,62 +12,64 @@ describe Spree::FeedbackReviewsController do
       feedback_review: {
         rating: '4 stars',
         comment: 'some comment'
-      }}
+      } }
   end
 
   before do
-    controller.stub spree_current_user: user
-    controller.stub spree_user_signed_in?: true
+    allow(controller).to receive(:spree_current_user).and_return(user)
+    allow(controller).to receive(:spree_user_signed_in?).and_return(true)
     request.env['HTTP_REFERER'] = '/'
   end
 
   describe '#create' do
     it 'creates a new feedback review' do
       rating = 4
-      comment = FFaker::Lorem.paragraphs(3).join("\n")
+      comment = ['Thanks for your review!', 'Cheers'].join("\n")
       expect {
-        spree_post :create, { review_id: review.id,
-                              feedback_review: { comment: comment,
-                                                 rating: rating },
-                              format: :js }
-        response.status.should eq(200)
-        response.should render_template(:create)
+        post :create, params: { review_id: review.id,
+                        feedback_review: {
+                          comment: comment,
+                          rating: rating
+},
+                        format: :js }
+        expect(response.status).to eq(200)
+        expect(response).to render_template(:create)
       }.to change(Spree::Review, :count).by(1)
       feedback_review = Spree::FeedbackReview.last
-      feedback_review.comment.should eq(comment)
-      feedback_review.review.should eq(review)
-      feedback_review.rating.should eq(rating)
-      feedback_review.user.should eq(user)
-
+      expect(feedback_review.comment).to eq(comment)
+      expect(feedback_review.review).to eq(review)
+      expect(feedback_review.rating).to eq(rating)
+      expect(feedback_review.user).to eq(user)
     end
 
     it 'redirects back to the calling page' do
-      spree_post :create, valid_attributes
-      response.should redirect_to '/'
+      post :create, params: valid_attributes
+      expect(response).to redirect_to '/'
     end
 
     it 'sets locale on feedback-review if required by config' do
       Spree::Reviews::Config.preferred_track_locale = true
-      spree_post :create, valid_attributes
-      assigns[:review].locale.should eq I18n.locale.to_s
+      post :create, params: valid_attributes
+      expect(assigns[:review].locale).to eq I18n.locale.to_s
     end
 
     it 'fails when user is not authorized' do
-      controller.stub(:authorize!) { raise }
+      allow(controller).to receive(:authorize!).and_raise(RuntimeError)
+
       expect {
-        spree_post :create, valid_attributes
+        post :create, params: valid_attributes
       }.to raise_error
     end
 
     it 'removes all non-numbers from ratings parameter' do
-      spree_post :create, valid_attributes
-      controller.params[:feedback_review][:rating].should eq '4'
+      post :create, params: valid_attributes
+      expect(controller.params[:feedback_review][:rating]).to eq '4'
     end
 
     it 'do not create feedback-review if review doesnt exist' do
       expect {
-        spree_post :create, valid_attributes.merge!({review_id: nil})
-      }.to raise_error
+        post :create, params: valid_attributes.merge!({ review_id: nil })
+      }.to raise_error ActionController::UrlGenerationError
     end
   end
 end