jiffyshirts_spree_reviews 2.3.1.1

data/db/migrate/20110406083603_add_rating_to_products.rb

@@ -0,0 +1,21 @@
+class AddRatingToProducts < ActiveRecord::Migration
+  def self.up
+    if table_exists?('products')
+      add_column :products, :avg_rating, :decimal, :default => 0.0, :null => false, :precision => 7, :scale => 5
+      add_column :products, :reviews_count, :integer, :default => 0, :null => false
+    elsif table_exists?('spree_products')
+      add_column :spree_products, :avg_rating, :decimal, :default => 0.0, :null => false, :precision => 7, :scale => 5
+      add_column :spree_products, :reviews_count, :integer, :default => 0, :null => false
+    end
+  end
+
+  def self.down
+    if table_exists?('products')
+      remove_column :products, :reviews_count
+      remove_column :products, :avg_rating
+    elsif table_exists?('spree_products')
+      remove_column :spree_products, :reviews_count
+      remove_column :spree_products, :avg_rating
+    end
+  end
+end

data/db/migrate/20110606150524_add_user_to_reviews.rb

@@ -0,0 +1,9 @@
+class AddUserToReviews < ActiveRecord::Migration
+  def self.up
+    add_column :reviews, :user_id, :integer, :null => true
+  end
+
+  def self.down
+    remove_column :reviews, :user_id
+  end
+end

data/db/migrate/20110806093221_add_ip_address_to_reviews.rb

@@ -0,0 +1,9 @@
+class AddIpAddressToReviews < ActiveRecord::Migration
+  def self.up
+    add_column :reviews, :ip_address, :string
+  end
+
+  def self.down
+    remove_column :reviews, :ip_address
+  end
+end

data/db/migrate/20120110172331_namespace_tables.rb

@@ -0,0 +1,6 @@
+class NamespaceTables < ActiveRecord::Migration
+  def change
+    rename_table :reviews, :spree_reviews
+    rename_table :feedback_reviews, :spree_feedback_reviews
+  end
+end

data/db/migrate/20120123141326_recalculate_ratings.rb

@@ -0,0 +1,20 @@
+class RecalculateRatings < ActiveRecord::Migration
+  def up
+    Spree::Product.reset_column_information
+
+    Spree::Product.update_all :reviews_count => 0
+    
+    Spree::Product.joins(:reviews).where("spree_reviews.id IS NOT NULL").find_each do |p|
+      Spree::Product.update_counters p.id, :reviews_count => p.reviews.approved.length
+
+      # recalculate_product_rating exists on the review, not the product
+      if p.reviews.approved.count > 0
+        p.reviews.approved.first.recalculate_product_rating
+      end
+
+    end
+  end
+
+  def down
+  end
+end

data/db/migrate/20120712182514_add_locale_to_reviews.rb

@@ -0,0 +1,9 @@
+class AddLocaleToReviews < ActiveRecord::Migration
+  def self.up
+    add_column :spree_reviews, :locale, :string, :default => 'en'
+  end
+
+  def self.down
+    remove_column :spree_reviews, :locale
+  end
+end

data/db/migrate/20120712182627_add_locale_to_feedback_reviews.rb

@@ -0,0 +1,9 @@
+class AddLocaleToFeedbackReviews < ActiveRecord::Migration
+  def self.up
+    add_column :spree_feedback_reviews, :locale, :string, :default => 'en'
+  end
+
+  def self.down
+    remove_column :spree_feedback_reviews, :locale
+  end
+end

data/db/sample/ratings.yml

@@ -0,0 +1,16 @@
+t1:
+  product: ror_jr_spaghetti
+  value: 3.56
+  count: 20
+t2:
+  product: ror_bag
+  value: 2.56
+  count: 30
+t3:
+  product: ror_tote
+  value: 3.94
+  count: 10
+t4:
+  product: apache_baseball_jersey
+  value: 1.49
+  count: 6

data/db/sample/reviews.yml

@@ -0,0 +1,59 @@
+<% 
+require 'faker'
+%>
+r1: 
+  product: ror_tote
+  name: <%= Faker::Name.first_name %>  <%= Faker::Name.last_name %>
+  location: here
+  rating: 4
+  title: "more uses for this item"
+  review: <%= Faker::Lorem.paragraph %>
+  approved: true
+r2: 
+  product: ror_tote
+  name: <%= Faker::Name.first_name %>  <%= Faker::Name.last_name %>
+  location: here
+  rating: 3
+  title: "further comments"
+  review: <%= Faker::Lorem.paragraph %>
+  approved: false
+r3: 
+  product: ror_ringer
+  name: <%= Faker::Name.first_name %>  <%= Faker::Name.last_name %>
+  location: here
+  rating: 4
+  title: "essential wear"
+  review: <%= Faker::Lorem.paragraph %>
+  approved: false
+r4: 
+  product: apache_baseball_jersey
+  name: <%= Faker::Name.first_name %>  <%= Faker::Name.last_name %>
+  location: here
+  rating: 2
+  title: "not impressed"
+  review: <%= Faker::Lorem.paragraph %>
+  approved: true
+r5: 
+  product: ror_ringer
+  name: <%= Faker::Name.first_name %>  <%= Faker::Name.last_name %>
+  location: an office
+  rating: 5
+  title: "I have one for every day of the week"
+  review: <%= Faker::Lorem.paragraph %>
+  approved: true
+r6: 
+  product: ror_ringer
+  name: <%= Faker::Name.first_name %>  <%= Faker::Name.last_name %>
+  location: here
+  rating: 4
+  title: "cooler than my toga"
+  review: <%= Faker::Lorem.paragraph %>
+  approved: true
+r7: 
+  product: ror_ringer
+  name: <%= Faker::Name.first_name %>  <%= Faker::Name.last_name %>
+  location: emerald city
+  rating: 2
+  title: "my other half didn't like it"
+  review: <%= Faker::Lorem.paragraph %>
+  approved: false

data/jiffyshirts_spree_reviews.gemspec

@@ -0,0 +1,31 @@
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'jiffyshirts_spree_reviews'
+  s.version     = '2.3.1.1'
+  s.summary     = 'Basic review and ratings facility for Spree'
+  s.authors 	  = ['CrowdInt']
+  s.description = s.summary
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.homepage     = 'https://github.com/alexesba/spree_reviews.git'
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- spec/*`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.add_dependency 'spree_core', '~> 2.3.0'
+
+  s.add_development_dependency 'ffaker'
+  s.add_development_dependency 'capybara', '~> 2.2.1'
+  s.add_development_dependency 'database_cleaner', '1.2.0'
+  s.add_development_dependency 'poltergeist', '1.5.0'
+  s.add_development_dependency 'rspec-rails', '~> 2.14'
+  s.add_development_dependency 'factory_girl', '~> 4.4'
+  s.add_development_dependency 'pg'
+  s.add_development_dependency 'simplecov', '~> 0.7.1'
+  s.add_development_dependency 'coffee-rails', '~> 4.0.0'
+  s.add_development_dependency 'sass-rails', '~> 4.0.0'
+  s.add_development_dependency 'guard-rspec'
+  s.add_development_dependency 'pry'
+end

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

@@ -0,0 +1,30 @@
+module JiffyshirtsSpreeReviews
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      class_option :auto_run_migrations, :type => :boolean, :default => false
+
+      def add_javascripts
+        append_file "vendor/assets/javascripts/spree/frontend/all.js", "//= require spree/frontend/jiffyshirts_spree_reviews\n"
+        append_file "vendor/assets/javascripts/spree/backend/all.js", "//= require spree/backend/jiffyshirts_spree_reviews\n"
+      end
+
+      def add_stylesheets
+        inject_into_file "vendor/assets/stylesheets/spree/frontend/all.css", " *= require spree/frontend/jiffyshirts_spree_reviews\n", :before => /\*\//, :verbose => true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=jiffy_shirst_spree_reviews'
+      end
+
+      def run_migrations
+        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
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/jiffyshirts_spree_reviews/engine.rb

@@ -0,0 +1,23 @@
+module JiffyshirtsSpreeReviews
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'jiffyshirts_spree_reviews'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+      Spree::Ability.register_ability(Spree::ReviewsAbility)
+    end
+    config.to_prepare &method(:activate).to_proc
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+  end
+end

data/lib/jiffyshirts_spree_reviews.rb

@@ -0,0 +1,4 @@
+require 'sass/rails'
+require 'spree_core'
+require 'jiffyshirts_spree_reviews/engine'
+require 'coffee_script'

data/script/rails

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_PATH = File.expand_path('../..',  __FILE__)
+load File.expand_path('../../spec/dummy/script/rails',  __FILE__)

data/spec/controllers/admin/feedback_reviews_controller_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Spree::Admin::FeedbackReviewsController do
+  stub_authorization!
+
+  before do
+    user = create(:admin_user)
+    controller.stub(:try_spree_current_user => user)
+  end
+
+  context '#index' do
+    let!(:review) { create(:review)}
+    let!(:other_review) { create(:review) }
+
+    let!(:feedback_review_1) { create(:feedback_review, created_at: 10.days.ago, review: review) }
+    let!(:feedback_review_2) { create(:feedback_review, created_at: 2.days.ago, review: review) }
+    let!(:feedback_review_3) { create(:feedback_review, created_at: 5.days.ago, review: review) }
+
+    let!(:other_feedback_review_1) { create(:feedback_review, created_at: 10.days.ago, review: other_review) }
+    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])
+    end
+  end
+end

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 = Faker::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 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[:review].merge!({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/factories/feedback_review_factory.rb

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

data/spec/factories/review_factory.rb

@@ -0,0 +1,15 @@
+FactoryGirl.define do
+  factory :review, :class => Spree::Review do |f|
+    name   { generate(:random_email) }
+    title  { generate(:random_string) }
+    review { generate(:random_description) }
+    rating { rand(1..5) }
+    approved false
+    user
+    product
+
+    trait :approved do
+      approved true
+    end
+  end
+end