solidus_reviews 1.0.0

data/spec/controllers/admin/review_settings_controller_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Spree::Admin::ReviewSettingsController do
+  stub_authorization!
+
+  before do
+    user = create(:admin_user)
+    controller.stub(:try_spree_current_user => 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
+    end
+
+    context 'For parameters:
+            preview_size: 4,
+            show_email: false,
+            feedback_rating: false,
+            require_login: true,
+            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
+      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
+      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
+      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
+      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
+      end
+    end
+  end
+
+  context '#edit' do
+    it 'should render the edit template' do
+      spree_get :edit
+      response.should render_template(:edit)
+    end
+  end
+end

data/spec/controllers/admin/reviews_controller_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Spree::Admin::ReviewsController do
+  stub_authorization!
+
+  let(:product) { create(:product) }
+  let(:review) { create(:review, approved: false) }
+
+  before do
+    user = create(:admin_user)
+    controller.stub(try_spree_current_user: user)
+  end
+
+  context '#index' do
+    it 'list reviews' do
+      reviews = [
+        create(:review, product: product),
+        create(:review, product: product)
+      ]
+      spree_get :index, product_id: product.slug
+      assigns[:reviews].should =~ 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)
+    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)
+    end
+  end
+
+  context '#edit' do
+    specify do
+      spree_get :edit, id: review.id
+      response.status.should eq(200)
+    end
+
+    context 'when product is nil' do
+      before do
+        review.product = nil
+        review.save!
+      end
+
+      it 'flash error' do
+        spree_get :edit, id: review.id
+        flash[:error].should eq Spree.t(: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
+      end
+    end
+  end
+end

data/spec/controllers/feedback_reviews_controller_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Spree::FeedbackReviewsController do
+  let(:user) { create(:user) }
+  let(:product) { create(:product) }
+  let(:review) { create(:review, user: user) }
+  let(:valid_attributes) do
+    { review_id: review.id,
+      user_id: user.id,
+      feedback_review: {
+        rating: '4 stars',
+        comment: 'some comment'
+      }}
+  end
+
+  before do
+    controller.stub spree_current_user: user
+    controller.stub spree_user_signed_in?: 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")
+      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)
+      }.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)
+
+    end
+
+    it 'redirects back to the calling page' do
+      spree_post :create, valid_attributes
+      response.should 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
+    end
+
+    it 'fails when user is not authorized' do
+      controller.stub(:authorize!) { raise }
+      expect {
+        spree_post :create, 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'
+    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
+    end
+  end
+end

data/spec/controllers/products_controller_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Spree::ProductsController do
+  [:avg_rating, :reviews_count].each do |attrib|
+    it "should add #{attrib} to the set of allowed attributes" do
+      controller.permitted_product_attributes.should include(attrib)
+    end
+  end
+end

data/spec/controllers/reviews_controller_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+
+describe Spree::ReviewsController, type: :controller do
+  let(:user) { create(:user) }
+  let(:product) { create(:product) }
+  let(:review_params) do
+    { product_id: product.slug,
+      review: { rating: 3,
+                name: 'Ryan Bigg',
+                title: 'Great Product',
+                review: 'Some big review text..' } }
+  end
+
+  before do
+    controller.stub :spree_current_user => user
+    controller.stub :spree_user_signed_in? => true
+  end
+
+  context '#index' do
+    context 'for a product that does not exist' do
+      it 'responds with a 404' do
+        spree_get :index, product_id: 'not_real'
+        response.status.should eq(404)
+      end
+    end
+
+    context 'for a valid product' do
+      it 'list approved reviews' do
+        approved_reviews = [
+          create(:review, :approved, product: product),
+          create(:review, :approved, product: product)
+        ]
+        spree_get :index, product_id: product.slug
+        assigns[:approved_reviews].should =~ approved_reviews
+      end
+    end
+  end
+
+  context '#new' do
+    context 'for a product that does not exist' do
+      it 'responds with a 404' do
+        spree_get :new, product_id: 'not_real'
+        response.status.should eq(404)
+      end
+    end
+
+    it 'fail if the user is not authorized to create a review' do
+      controller.stub(:authorize!) { raise }
+      expect {
+        spree_post :new, product_id: product.slug
+        assert_match 'ryanbig', response.body
+      }.to raise_error
+    end
+
+    it 'render the new template' do
+      spree_get :new, product_id: product.slug
+      response.status.should eq(200)
+      response.should render_template(:new)
+    end
+  end
+
+  context '#create' do
+    before { controller.stub spree_current_user: user }
+
+    context 'for a product that does not exist' do
+      it 'responds with a 404' do
+        spree_post :create, product_id: 'not_real'
+        response.status.should eq(404)
+      end
+    end
+
+    it 'creates a new review' do
+      expect {
+        spree_post :create, review_params
+      }.to change(Spree::Review, :count).by(1)
+    end
+
+    it 'sets the ip-address of the remote' do
+      request.stub(remote_ip: '127.0.0.1')
+      spree_post :create, review_params
+      assigns[:review].ip_address.should eq '127.0.0.1'
+    end
+
+    it 'fails if the user is not authorized to create a review' do
+      controller.stub(:authorize!) { raise }
+      expect{
+        spree_post :create, review_params
+      }.to raise_error
+    end
+
+    it 'flashes the notice' do
+      spree_post :create, review_params
+      flash[:notice].should eq Spree.t(:review_successfully_submitted)
+    end
+
+    it 'redirects to product page' do
+      spree_post :create, review_params
+      response.should redirect_to spree.product_path(product)
+    end
+
+    it 'removes all non-numbers from ratings param' do
+      spree_post :create, review_params
+      controller.params[:review][:rating].should eq '3'
+    end
+
+    it 'sets the current spree user as reviews user' do
+      spree_post :create, review_params
+      review_params[:review].merge!(user_id: user.id)
+      assigns[:review][:user_id] = user.id
+      assigns[:review][:user_id].should eq user.id
+    end
+
+    context 'with invalid params' do
+      it 'renders new when review.save fails' do
+        Spree::Review.any_instance.stub(:save).and_return(false)
+        spree_post :create, review_params
+        response.should render_template :new
+      end
+
+      it 'does not create a review' do
+        expect(Spree::Review.count).to eq 0
+        spree_post :create, review_params.merge({review: {rating: 'not_a_number'}})
+        expect(Spree::Review.count).to eq 0
+      end
+    end
+
+    # It always sets the locale so preference pointless
+    context 'when config requires locale tracking:' do
+      it 'sets the locale' do
+        Spree::Reviews::Config.preferred_track_locale = true
+        spree_post :create, review_params
+        assigns[:review].locale.should eq I18n.locale.to_s
+      end
+    end
+  end
+end

data/spec/features/admin_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+RSpec.feature 'Review Admin' do
+  stub_authorization!
+
+  given!(:review) { create(:review) }
+
+  context 'index' do
+    background do
+      visit spree.admin_reviews_path
+    end
+
+    scenario 'list reviews' do
+      expect(page).to have_text review.product.name
+    end
+
+    scenario 'approve reviews' do
+      expect(review.approved).to be false
+      within("tr#review_#{review.id}") do
+        find('.approve').click
+      end
+      expect(review.reload.approved).to be true
+    end
+
+    scenario 'edit reviews' do
+      expect(page).to have_text review.product.name
+      within("tr#review_#{review.id}") do
+        find('.edit').click
+      end
+
+      expect(page).to have_text 'Editing'
+      expect(page).to have_text review.title
+    end
+  end
+end

data/spec/features/reviews_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+
+feature 'Reviews', js: true do
+  given!(:someone) { create(:user, email: 'ryan@spree.com') }
+  given!(:review) { create(:review, :approved, user: someone) }
+
+  background do
+    Spree::Reviews::Config.include_unapproved_reviews = false
+  end
+
+  context 'product with no review' do
+    given!(:product_no_reviews) { create(:product) }
+    scenario 'informs that no reviews has been written yet' do
+      visit spree.product_path(product_no_reviews)
+      expect(page).to have_text Spree.t(:no_reviews_available)
+    end
+
+    # Regression test for #103
+    context "shows correct number of previews" do
+      background do
+        FactoryGirl.create_list :review, 3, product: product_no_reviews, approved: true
+        Spree::Reviews::Config[:preview_size] = 2
+      end
+
+      scenario "displayed reviews are limited by the set preview size" do
+        visit spree.product_path(product_no_reviews)
+        expect(page.all(".review").count).to eql(2)
+      end
+    end
+  end
+
+  context 'when anonymous user' do
+    background do
+      Spree::Reviews::Config.require_login = true
+    end
+
+    context 'visit product with review' do
+      background do
+        visit spree.product_path(review.product)
+      end
+
+      scenario 'should see review title' do
+        expect(page).to have_text review.title
+      end
+
+      scenario 'can not create review' do
+        expect(page).not_to have_text Spree.t(:write_your_own_review)
+      end
+    end
+  end
+
+  context 'when logged in user' do
+    given!(:user) { create(:user) }
+
+    background do
+      sign_in_as! user
+    end
+
+    context 'visit product with review' do
+      background do
+        visit spree.product_path(review.product)
+      end
+
+      scenario 'can see review title' do
+        expect(page).to have_text review.title
+      end
+
+      scenario 'can see create new review button' do
+        expect(page).to have_text Spree.t(:write_your_own_review)
+      end
+
+      scenario 'can create new review' do
+        click_on Spree.t(:write_your_own_review)
+
+        expect(page).to have_text Spree.t(:leave_us_a_review_for, name: review.product.name)
+        expect(page).not_to have_text 'Show Identifier'
+
+        within '#new_review' do
+          click_star(3)
+
+          fill_in 'review_name', with: user.email
+          fill_in 'review_title', with: 'Great product!'
+          fill_in 'review_review', with: 'Some big review text..'
+          click_on 'Submit your review'
+        end
+        
+        expect(page.find('.flash.notice', text: Spree.t(:review_successfully_submitted))).to be_truthy
+        expect(page).not_to have_text 'Some big review text..'
+      end
+    end
+  end
+
+  context 'visit product with review where show_identifier is false' do
+    given!(:user) { create(:user) }
+    given!(:review) { create(:review, :approved, :hide_identifier, review: 'review text', user: user) }
+    
+    background do
+      visit spree.product_path(review.product)
+    end
+
+    scenario 'show anonymous review' do
+      expect(page).to have_text Spree.t(:anonymous)
+      expect(page).to have_text 'review text'
+    end
+
+  end
+
+  private
+
+  def sign_in_as!(user)
+    visit spree.login_path
+    within '#new_spree_user' do
+      fill_in 'Email', with: user.email
+      fill_in 'Password', with: user.password
+    end
+    click_button 'Login'
+  end
+
+  def click_star(num)
+    page.all(:xpath, "//a[@title='#{num} stars']")[0].click
+  end
+end

data/spec/helpers/review_helper_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Spree::ReviewsHelper do
+  context 'star' do
+    specify do
+      expect(star('a_class')).to eq '<span class="a_class"> &#10030; </span>'
+    end
+  end
+
+  context 'mk_stars' do
+    specify do
+      matches = mk_stars(2).scan(/unlit/)
+      expect(matches.length).to eq 3
+
+    end
+  end
+
+  context 'txt_stars' do
+    specify do
+      expect(txt_stars(2, true)).to eq '2 out of 5'
+    end
+
+    specify do
+      expect(txt_stars(3, false)).to be_a String
+      expect(txt_stars(3, false)).to eq('3')
+    end
+  end
+end

data/spec/models/feedback_review_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Spree::FeedbackReview do
+  context 'validations' do
+    it 'validates by default' do
+      build(:feedback_review).should be_valid
+    end
+
+    it 'validates with a nil user' do
+      build(:feedback_review, user: nil).should be_valid
+    end
+
+    it 'does not validate with a nil review' do
+      build(:feedback_review, review: nil).should_not be_valid
+    end
+
+    context 'rating' do
+      it 'does not validate when no rating is specified' do
+        build(:feedback_review, rating: nil).should_not be_valid
+      end
+
+      it 'does not validate when the rating is not a number' do
+        build(:feedback_review, rating: 'not_a_number').should_not be_valid
+      end
+
+      it 'does not validate when the rating is a float' do
+        build(:feedback_review, rating: 2.718).should_not be_valid
+      end
+
+      it 'does not validate when the rating is less than 1' do
+        build(:feedback_review, rating: 0).should_not be_valid
+        build(:feedback_review, rating: -5).should_not be_valid
+      end
+
+      it 'does not validate when the rating is greater than 5' do
+        build(:feedback_review, rating: 6).should_not be_valid
+        build(:feedback_review, rating: 8).should_not be_valid
+      end
+
+      (1..5).each do |i|
+        it "validates when the rating is #{i}" do
+          build(:feedback_review, rating: i).should be_valid
+        end
+      end
+    end
+  end
+
+  context 'scopes' do
+    context 'most_recent_first' do
+      let!(:feedback_review_1) { create(:feedback_review, created_at: 10.days.ago) }
+      let!(:feedback_review_2) { create(:feedback_review, created_at: 2.days.ago) }
+      let!(:feedback_review_3) { create(:feedback_review, created_at: 5.days.ago) }
+
+      it 'properly runs most_recent_first queries' do
+        Spree::FeedbackReview.most_recent_first.to_a.should eq([feedback_review_2, feedback_review_3, feedback_review_1])
+      end
+
+      it 'defaults to most_recent_first queries' do
+        Spree::FeedbackReview.all.to_a.should eq([feedback_review_2, feedback_review_3, feedback_review_1])
+      end
+    end
+
+    context 'localized' do
+      let!(:en_feedback_review_1) { create(:feedback_review, locale: 'en', created_at: 10.days.ago) }
+      let!(:en_feedback_review_2) { create(:feedback_review, locale: 'en', created_at: 2.days.ago) }
+      let!(:en_feedback_review_3) { create(:feedback_review, locale: 'en', created_at: 5.days.ago) }
+
+      let!(:es_feedback_review_1) { create(:feedback_review, locale: 'es', created_at: 10.days.ago) }
+      let!(:fr_feedback_review_1) { create(:feedback_review, locale: 'fr', created_at: 10.days.ago) }
+
+      it 'properly runs localized queries' do
+        Spree::FeedbackReview.localized('en').to_a.should eq([en_feedback_review_2, en_feedback_review_3, en_feedback_review_1])
+        Spree::FeedbackReview.localized('es').to_a.should eq([es_feedback_review_1])
+        Spree::FeedbackReview.localized('fr').to_a.should eq([fr_feedback_review_1])
+      end
+    end
+  end
+end

data/spec/models/product_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Spree::Product do
+  it { should respond_to(:avg_rating) }
+  it { should respond_to(:reviews) }
+  it { should respond_to(:stars) }
+
+  context '#stars' do
+    let(:product) { build(:product) }
+
+    it 'rounds' do
+      product.stub(:avg_rating).and_return(3.7)
+      expect(product.stars).to eq(4)
+
+      product.stub(:avg_rating).and_return(2.3)
+      expect(product.stars).to eq(2)
+    end
+
+
+    it 'handles a nil value' do
+      product.stub(:avg_rating).and_return(nil)
+      expect {
+        expect(product.stars).to eq(0)
+      }.not_to raise_error
+    end
+  end
+
+  context '#recalculate_rating' do
+    let!(:product) { create(:product) }
+
+    context 'when there are approved reviews' do
+      let!(:approved_review_1) { create(:review, product: product, approved: true, rating: 4) }
+      let!(:approved_review_2) { create(:review, product: product, approved: true, rating: 5) }
+      let!(:unapproved_review_1) { create(:review, product: product, approved: false, rating: 4) }
+
+      it "updates the product average rating and ignores unapproved reviews" do
+        product.avg_rating = 0
+        product.reviews_count = 0
+        product.save!
+
+        product.recalculate_rating
+        product.avg_rating.should eq(4.5)
+        product.reviews_count.should eq(2)
+      end
+    end
+
+    context 'when no approved reviews' do
+      let!(:unapproved_review_1) { create(:review, product: product, approved: false, rating: 4) }
+
+      it "updates the product average rating and ignores unapproved reviews" do
+        product.avg_rating = 3
+        product.reviews_count = 20
+        product.save!
+
+        product.recalculate_rating
+        product.avg_rating.should eq(0)
+        product.reviews_count.should eq(0)
+      end
+    end
+
+  end
+end