solidus_reviews 1.0.0

data/config/locales/tr.yml

@@ -0,0 +1,68 @@
+---
+tr:
+  activerecord:
+    attributes:
+      spree/review:
+        name: İsminiz
+        title: Başlık
+        review: Konu
+        rating: Değerlendirme
+        created_at: Tarih
+        ip_address: IP
+        user: Kullanıcı
+    models:
+      spree/review:
+        one: bir yorum
+        other: "%{count} yorumlar"
+  spree:
+    approval_status: Onay Durumu
+    approve: Onayla
+    approved_reviews: Onaylı
+    approved_text: Yorum 1-2 iş günü içinde yayımlanacaktır.
+    average_customer_rating: Ortalama Oy
+    back_reviews: Geri değerlendirme
+    based_upon_review_count:
+      one: bir incelemeye göre
+      other: "%{count} incelemeye göre"
+    by: tarafından
+    editing_review_for_html: 'Yorumu düzenle %{link}'
+    error_approve_review: Yorum onaylamada hata
+    error_no_product: Yorumlanan ürün artık yok
+    feedback: Geri bildirim
+    feedback_review_for: "Yorum: '%{review}'"
+    for: için
+    from: itibaren
+    info_approve_review: Onaylanmış yorum
+    leave_us_a_review_for: "%{name}"
+    no_reviews_available: "Bu ürün hakkında henüz herhangi bir yorum bulunmuyor.."
+    out_of_5: "5 üzerinden"
+    rating: değerlendirme
+    reviews: Yorumlar
+    admin:
+      tab:
+        review_management: Yorumlar
+    review_successfully_submitted: Yorumunuz başarıyla iletildi
+    spree_reviews:
+      feedback_rating: Geribildirimi değerlendir
+      include_unapproved: Listede ki onaylanmamış değerlendirmeleri dahil et
+      manage_review_settings: Yorum ekranını kontrol edin
+      preview_size: Yorum büyüklüğü
+      require_login: Yorumları görebilmek için kullanıcı girişi
+      review_settings: Yorum Ayarları
+      show_email: e-posta adresini göster
+      track_locale: Kullanıcının yerel bilgilerini kaydet/takip et
+    star:
+      one: "1"
+      other: "%{count}"
+    stars: Yıldızlar
+    submit_your_review: Gönder
+    submitted_on: "Gönderilme Tarihi:"
+    unapproved_reviews: Onaylanmamış
+    voice:
+      one: "1 değerlendirme"
+      other: "%{count} değerlendirme"
+    was_this_review_helpful: "Bu yorum size yardımcı oldu mu?"
+    write_your_own_review: Yorum Yap
+    you_must_enter_value_for_rating: "Yorum yazmak için giriş yapmalısınız."
+    anonymous: anonim
+

data/config/locales/uk.yml

@@ -0,0 +1,75 @@
+---
+uk:
+  activerecord:
+    attributes:
+      spree/review:
+        name: Ваше ім’я
+        title: Заголовок
+        review: Відгук
+        rating: Оцінка
+        created_at: Дата
+        ip_address: IP
+        user: Користувач
+        show_identifier: Показувати автора
+    models:
+      spree/review:
+        one: один відгук
+        few: '%{count} відгуки'
+        many: '%{count} відгуків'
+        other: '%{count} відгуків'
+  spree:
+    approval_status: Підтвердження
+    approve: Схвалити
+    approved_reviews: Схвалено
+    average_customer_rating: Середня оцінка
+    back_reviews: Назад до відгуків
+    based_upon_review_count:
+      one: на основі одного відгуку
+      few: "на основі %{count} відгуків"
+      many: "на основі %{count} відгуків"
+      other: "на основі %{count} відгуків"
+    by: від
+    editing_review_for_html: 'Редагувати відгук на %{link}'
+    error_approve_review: Не вдалось схвалити відгук
+    error_no_product: Товару, на який писався відгук, більше не існує
+    feedback: Корисність
+    feedback_review_for: "Відгук: '%{review}'"
+    for: для
+    from: від
+    info_approve_review: Відгук схвалено
+    leave_us_a_review_for: "Будь ласка, залиште відгук та оцінку для '%{name}'"
+    no_reviews_available: 'Поки що немає відгуків на цей товар.'
+    out_of_5: 'з 5'
+    rating: оцінка
+    reviews: Відгуки
+    admin:
+      tab:
+        review_management: Відгуки
+    review_successfully_submitted: Відгук надіслано
+    spree_reviews:
+      feedback_rating: Оцінювати корисність
+      include_unapproved: Показувати незатверджені відгуки
+      manage_review_settings: Керувати відображенням відгуків
+      preview_size: Розмір скороченої версії
+      require_login: Тільки для зареєстрованих користувачів
+      review_settings: Налаштування відгуків
+      show_email: Показувати email
+      track_locale: Зберігати мову користувача
+    star:
+      one: '1'
+      few: '%{count}'
+      many: '%{count}'
+      other: '%{count}'
+    stars: Зірочок
+    submit_your_review: Надіслати відгук
+    submitted_on: Написано
+    unapproved_reviews: Непідтверджений
+    voice:
+      one: '1 голос'
+      few: '%{count} голоси'
+      many: '%{count} голосів'
+      other: '%{count} голосів'
+    was_this_review_helpful: 'Цей відгук корисний для вас?'
+    write_your_own_review: Напишіть свій відгук
+    you_must_enter_value_for_rating: 'Потрібно вибрати оцінку.'
+    anonymous: Анонім

data/config/locales/zh-CN.yml

@@ -0,0 +1,65 @@
+---
+zh-CN:
+  activerecord:
+    attributes:
+      spree/review:
+        name: 您的姓名
+        title: 标题
+        review: 內文
+        rating: 评级
+        created_at: 日期
+        ip_address: IP
+        user: 用戶
+    models:
+      spree/review:
+        one: 一个评论
+        other: "%{count}个评论"
+  spree:
+    approve: 核准
+    approved_reviews: 核准
+    average_customer_rating: 平均评级
+    back_reviews: 返回评论
+    based_upon_review_count:
+      one: 以评论为基础
+      other: "以 %{count} 個评论为基础"
+    by: 由
+    editing_review_for_html: '正在修改 %{link} 的评论'
+    error_approve_review: 出错了，不能核准评论
+    error_no_product: 被评论的产品不存在了。
+    feedback: 回馈
+    feedback_review_for: "评论： '%{review}'"
+    for: 給
+    from: 由
+    info_approve_review: 已核准评论
+    leave_us_a_review_for: "请给我们的 '%{name}' 评论和评级"
+    no_reviews_available: "此产品没有评论。"
+    out_of_5: "顶级为 5"
+    rating: 评级
+    reviews: 评论
+    admin:
+      tab:
+        review_management: 评论
+    review_successfully_submitted: 已成功递交评论。
+    spree_reviews:
+      feedback_rating: 评级回馈
+      include_unapproved: 包括未核准评论在列表中
+      manage_review_settings: 控制评论的显示
+      preview_size: 评论片段的大小
+      require_login: 用者必需登入
+      review_settings: 评论设定
+      show_email: 显示电邮地址
+      track_locale: 追踪用户地域
+    star:
+      one: "1"
+      other: "%{count}"
+    stars: 星
+    submit_your_review: 递交你的评论
+    submitted_on: 递交日期
+    unapproved_reviews: 沒核准
+    voice:
+      one: "1 聲音"
+      other: "%{count} 聲音"
+    was_this_review_helpful: "此评论对你是否有帮助？"
+    write_your_own_review: 写下您的评论
+    you_must_enter_value_for_rating: "您必需输入评级"
+    anonymous: 匿名者

data/config/locales/zh-TW.yml

@@ -0,0 +1,65 @@
+---
+zh-TW:
+  activerecord:
+    attributes:
+      spree/review:
+        name: 您的姓名
+        title: 標題
+        review: 內文
+        rating: 評級
+        created_at: 日期
+        ip_address: IP
+        user: 用戶
+    models:
+      spree/review:
+        one: 一個評論
+        other: '%{count}個評論'
+  spree:
+    approve: 核準
+    approved_reviews: 核準
+    average_customer_rating: 平均評級
+    back_reviews: 返回評論
+    based_upon_review_count:
+      one: 以評論為基礎
+      other: '以 %{count} 個評論為基礎'
+    by: 由
+    editing_review_for_html: '正在修改 %{link} 的評論'
+    error_approve_review: 出錯了，不能核準評論
+    error_no_product: 被評論的產品不存在了。
+    feedback: 回饋
+    feedback_review_for: "評論： '%{review}'"
+    for: 給
+    from: 由
+    info_approve_review: 已核準評論
+    leave_us_a_review_for: "請給我們的 '%{name}' 評論和評級"
+    no_reviews_available: '此產品沒有評論。'
+    out_of_5: '頂級為 5'
+    rating: 評級
+    reviews: 評論
+    admin:
+      tab:
+        review_management: 評論
+    review_successfully_submitted: 已成功遞交評論。
+    spree_reviews:
+      feedback_rating: 評級回饋
+      include_unapproved: 包括未核準評論在列表中
+      manage_review_settings: 控制評論的顯示
+      preview_size: 評論片段的大小
+      require_login: 用者必需登入
+      review_settings: 評論設定
+      show_email: 顯示電郵地址
+      track_locale: 追蹤用戶地域
+    star:
+      one: "1"
+      other: "%{count}"
+    stars: 星
+    submit_your_review: 遞交你的評論
+    submitted_on: 遞交日期
+    unapproved_reviews: 沒核準
+    voice:
+      one: "1 聲音"
+      other: "%{count} 聲音"
+    was_this_review_helpful: 此評論對你是否有幫助？
+    write_your_own_review: 寫下您的評論
+    you_must_enter_value_for_rating: 您必需輸入評級
+    anonymous: 匿名者

data/config/routes.rb

@@ -0,0 +1,17 @@
+Spree::Core::Engine.add_routes do
+  namespace :admin do
+    resources :reviews, only: [:index, :destroy, :edit, :update] do
+      member do
+        get :approve
+      end
+      resources :feedback_reviews, only: [:index, :destroy]
+    end
+    resource :review_settings, only: [:edit, :update]
+  end
+
+  resources :products, only: [] do
+    resources :reviews, only: [:index, :new, :create] do
+    end
+  end
+  post '/reviews/:review_id/feedback(.:format)' => 'feedback_reviews#create', as: :feedback_reviews
+end

data/db/migrate/20081020220724_create_reviews.rb

@@ -0,0 +1,18 @@
+class CreateReviews < ActiveRecord::Migration
+  def self.up
+    create_table :reviews do |t|
+      t.integer :product_id
+      t.string  :name
+      t.string  :location
+      t.integer :rating
+      t.text    :title
+      t.text    :review
+      t.boolean :approved, :default => false
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :reviews
+  end
+end

data/db/migrate/20101222083309_create_feedback_reviews.rb

@@ -0,0 +1,17 @@
+class CreateFeedbackReviews < ActiveRecord::Migration
+  def self.up
+    create_table :feedback_reviews do |t|
+      t.integer :user_id
+      t.integer :review_id, :null => false
+      t.integer :rating,    :default => 0
+      t.text    :comment
+      t.timestamps
+    end
+    add_index :feedback_reviews, :review_id
+    add_index :feedback_reviews, :user_id
+  end
+
+  def self.down
+    drop_table :feedback_reviews
+  end
+end

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/migrate/20140703200946_add_show_identifier_to_reviews.rb

@@ -0,0 +1,6 @@
+class AddShowIdentifierToReviews < ActiveRecord::Migration
+  def change
+    add_column :spree_reviews, :show_identifier, :boolean, default: true
+    add_index :spree_reviews, :show_identifier
+  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/lib/generators/solidus_reviews/install/install_generator.rb

@@ -0,0 +1,30 @@
+module SolidusReviews
+  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/solidus_reviews\n"
+        append_file "vendor/assets/javascripts/spree/backend/all.js", "//= require spree/backend/solidus_reviews\n"
+      end
+
+      def add_stylesheets
+        inject_into_file "vendor/assets/stylesheets/spree/frontend/all.css", " *= require spree/frontend/solidus_reviews\n", :before => /\*\//, :verbose => true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=solidus_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/solidus_reviews/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/lib/solidus_reviews/factories/review_factory.rb

@@ -0,0 +1,20 @@
+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
+    show_identifier true
+    user
+    product
+
+    trait :approved do
+      approved true
+    end
+
+    trait :hide_identifier do
+      show_identifier false
+    end
+  end
+end

data/lib/solidus_reviews/factories.rb

@@ -0,0 +1,5 @@
+require "factory_girl"
+
+Dir["#{File.dirname(__FILE__)}/factories/**"].each do |f|
+  require File.expand_path(f)
+end

data/lib/solidus_reviews.rb

@@ -0,0 +1,6 @@
+require 'sass/rails'
+require 'solidus'
+require 'deface'
+require 'solidus_auth_devise'
+require 'spree_reviews/engine'
+require 'coffee_script'

data/lib/spree_reviews/engine.rb

@@ -0,0 +1,17 @@
+module SpreeReviews
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'solidus_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
+  end
+end

data/solidus_reviews.gemspec

@@ -0,0 +1,35 @@
+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.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.license      = 'BSD-3'
+
+  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 'solidus', '~> 1.0'
+  s.add_dependency 'deface', '~> 1.0'
+  s.add_dependency 'solidus_auth_devise', '~> 1.0'
+
+  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 'pry'
+end

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