solidus_reviews 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0b51c02c6474636cf9398f1e7c51ca332eadba8
+  data.tar.gz: 0fb923dfe70a7b22fed4ba65aedea239d73101bb
+SHA512:
+  metadata.gz: e3257de4d8a2956c07f16e710559ed37505ffe456d2a1ad65b99ac70419556d92f112c1510a24374c96077db15d47127e32e5fd48c4de605ccfd44d4b352930b
+  data.tar.gz: ff881a9a9c17757c84aaff1877efde25378df3d22506bd87667b1918db9cf73459f75175ebf446b62187ad71126274a68a0075b1a3778b24be52b8e74f6f2685

data/.gitignore

@@ -0,0 +1,12 @@
+*.gem
+*.swp
+.bundle
+.idea
+.DS_Store
+Gemfile.lock
+pkg/*
+spec/dummy
+coverage
+.rvmrc
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--color
+-f documentation

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+rvm:
+  - 2.3.3
+sudo: false
+cache: bundler
+only: master
+env:
+  matrix:
+    - SOLIDUS_BRANCH=v1.0 DB=mysql
+    - SOLIDUS_BRANCH=v1.0 DB=postgresql
+    - SOLIDUS_BRANCH=v1.1 DB=mysql
+    - SOLIDUS_BRANCH=v1.1 DB=postgresql
+    - SOLIDUS_BRANCH=v1.2 DB=mysql
+    - SOLIDUS_BRANCH=v1.2 DB=postgresql
+    - SOLIDUS_BRANCH=v1.3 DB=mysql
+    - SOLIDUS_BRANCH=v1.3 DB=postgresql
+    - SOLIDUS_BRANCH=v1.4 DB=mysql
+    - SOLIDUS_BRANCH=v1.4 DB=postgresql

data/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing
+
+In the spirit of [free software][1], **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+- by using prerelease versions
+- by reporting [bugs][2]
+- by suggesting new features
+- by writing translations
+- by writing or editing documentation
+- by writing specifications
+- by writing code (*no patch is too small*: fix typos, add comments, clean up inconsistent whitespace)
+- by refactoring code
+- by resolving [issues][2]
+- by reviewing patches
+
+Starting point:
+
+- Fork the repo
+- Clone your repo
+- Run `bundle install`
+- Run `bundle exec rake test_app` to create the test application in `spec/test_app`
+- Ensure specs pass by running `bundle exec rspec spec`
+- Submit your pull request
+
+[1]: http://www.fsf.org/licensing/essays/free-sw.html
+[2]: https://github.com/spree-contrib/spree_reviews/issues

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+branch = ENV.fetch('SOLIDUS_BRANCH', 'v1.4')
+gem "solidus", github: "solidusio/solidus", branch: branch
+gem "solidus_auth_devise", github: "solidusio/solidus_auth_devise"
+
+case ENV['DB']
+when 'mysql'
+  gem 'mysql2'
+when 'postgresql'
+  gem 'pg'
+end
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,26 @@
+Copyright (c) 2009-2014 Spree Commerce and contributors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,93 @@
+# Reviews
+
+[![Build Status](https://travis-ci.org/solidusio-contrib/solidus_reviews.svg)](https://travis-ci.org/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.
+
+---
+
+## Installation
+
+Add the following to your `Gemfile` to install from git:
+
+```ruby
+gem 'solidus_reviews', github: 'solidusio-contrib/solidus_reviews'
+```
+Now bundle up with:
+
+    bundle
+
+Next, run the rake task that copies the necessary migrations and assets to your project:
+
+    rails g solidus_reviews:install
+
+And finish with a migrate:
+
+    rake db:migrate
+
+Now you should be able to boot up your server with:
+
+    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
+
+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
+
+Administrator can edit and/or approve and/or delete reviews.
+
+## Factories
+
+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"
+```
+
+## 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...
+
+---
+
+## Discussion
+
+Some points which might need modification in future:
+
+ - I don't track the actual user on a review (just their "screen name" at the
+   time), but we may want to use this information to avoid duplicate reviews
+   etc. See https://github.com/spree/spree_reviews/issues/18
+ - Rating votes are tied to a review, to avoid spam. However: ratings are
+   accepted whether or not the review is accepted. Perhaps they should only
+   be counted when the review is approved.
+
+---
+
+## Contributing
+
+See corresponding [contributing guidelines][1].
+
+---
+
+Copyright (c) 2009-2014 [Spree Commerce][2] and [contributors][3], released under the [New BSD License][4]
+
+[1]: ./CONTRIBUTING.md
+[2]: https://github.com/spree
+[3]: https://github.com/solidusio-contrib/solidus_reviews/graphs/contributors
+[4]: ./LICENSE.md

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir["spec/dummy"].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir("../../")
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'solidus_reviews'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/javascripts/spree/backend/solidus_reviews.js

@@ -0,0 +1,7 @@
+//= require jquery.rating
+//= require spree/backend
+
+// Navigating to a page with ratings via TurboLinks shows the radio buttons
+$(document).on('page:load', function () {
+  $('input[type=radio].star').rating();
+});

data/app/assets/javascripts/spree/frontend/solidus_reviews.js

@@ -0,0 +1,7 @@
+//= require jquery.rating
+//= require spree/frontend
+
+// Navigating to a page with ratings via TurboLinks shows the radio buttons
+$(document).on('page:load', function () {
+  $('input[type=radio].star').rating();
+});

data/app/assets/stylesheets/spree/backend/solidus_reviews.css

@@ -0,0 +1,3 @@
+/*
+ *= require spree/backend
+*/

data/app/assets/stylesheets/spree/frontend/solidus_reviews.scss

@@ -0,0 +1,83 @@
+/*
+ *= require spree/frontend
+*/
+
+#reviews div.header {
+  margin-top: 10px;
+  margin-bottom: 10px;
+}
+
+.lit {
+  background-color: #aaaaaa;
+  color: #0000bb;
+  margin-right: 1px;
+  padding-left: 1px;
+}
+
+.unlit {
+  background-color: #aaaaaa;
+  color: #000000;
+  margin-right: 1px;
+  padding-left: 1px;
+}
+
+.star-rating-control {
+  display: inline-block;
+  height: 14px;
+}
+
+.review_hr {
+  size: 1px;
+  background: silver;
+  border: none;
+  margin: 1em 0;
+}
+
+/* jQuery.Rating Plugin CSS - http://www.fyneworks.com/jquery/star-rating/ */
+div.rating-cancel, div.star-rating {
+  float: left;
+  width: 17px;
+  height: 16px;
+  text-indent: -999em;
+  cursor: pointer;
+  display: block;
+  background: transparent;
+  overflow: hidden
+}
+
+div.rating-cancel, div.rating-cancel a {
+  background: transparent image-url('store/reviews/delete.gif') no-repeat scroll 0 -1px;
+}
+
+div.star-rating, div.star-rating a {
+  background: image-url('store/reviews/star.gif') no-repeat 0 0px
+}
+
+div.rating-cancel a, div.star-rating a {
+  display: block;
+  width: 16px;
+  height: 100%;
+  background-position: 0 0px;
+  border: 0
+}
+
+div.star-rating-on a {
+  background-position: 0 -32px !important
+}
+
+div.star-rating-hover a {
+  background-position: 0 -32px
+}
+
+/* Read Only CSS */
+div.star-rating-readonly a {
+  cursor: default !important
+}
+
+/* Partial Star CSS */
+div.star-rating {
+  background: transparent !important;
+  overflow: hidden !important
+}
+
+/* END jQuery.Rating Plugin CSS */

data/app/controllers/spree/admin/feedback_reviews_controller.rb

@@ -0,0 +1,6 @@
+class Spree::Admin::FeedbackReviewsController <  Spree::Admin::ResourceController
+  belongs_to 'spree/review'
+  def index
+    @collection = parent.feedback_reviews
+  end
+end

data/app/controllers/spree/admin/review_settings_controller.rb

@@ -0,0 +1,21 @@
+class Spree::Admin::ReviewSettingsController < Spree::Admin::BaseController
+  before_filter :process_unset_checkboxes, only: [:update]
+
+  def update
+    Spree::Reviews::Config.set(params[:preferences])
+
+    respond_to do |format|
+      format.html do
+        redirect_to edit_admin_review_settings_path
+      end
+    end
+  end
+
+  def process_unset_checkboxes
+    # workaround for unset checkbox behaviour
+    params[:preferences] ||= {}
+    Spree::ReviewsConfiguration.boolean_preferences.each do |sym|
+      params[:preferences][sym] = false if params[:preferences][sym].blank?
+    end
+  end
+end

data/app/controllers/spree/admin/reviews_controller.rb

@@ -0,0 +1,34 @@
+class Spree::Admin::ReviewsController < Spree::Admin::ResourceController
+  helper Spree::ReviewsHelper
+
+  def index
+    @reviews = collection
+  end
+
+  def approve
+    r = Spree::Review.find(params[:id])
+
+    if r.update_attribute(:approved, true)
+       flash[:notice] = Spree.t("info_approve_review")
+    else
+       flash[:error] = Spree.t("error_approve_review")
+    end
+    redirect_to admin_reviews_path
+  end
+
+  def edit
+    if @review.product.nil?
+      flash[:error] = Spree.t("error_no_product")
+      redirect_to admin_reviews_path and return
+    end
+  end
+
+  private
+
+  def collection
+    params[:q] ||= {}
+
+    @search = Spree::Review.ransack(params[:q])
+    @collection = @search.result.includes([:product, :user, :feedback_reviews]).page(params[:page]).per(params[:per_page])
+  end
+end

data/app/controllers/spree/feedback_reviews_controller.rb

@@ -0,0 +1,41 @@
+class Spree::FeedbackReviewsController < Spree::StoreController
+  helper Spree::BaseHelper
+
+  before_filter :sanitize_rating, only: [:create]
+  before_filter :load_review, only: [:create]
+
+  def create
+
+    if @review.present?
+      @feedback_review = @review.feedback_reviews.new(feedback_review_params)
+      @feedback_review.user = spree_current_user
+      @feedback_review.locale = I18n.locale.to_s if Spree::Reviews::Config[:track_locale]
+      authorize! :create, @feedback_review
+      @feedback_review.save
+    end
+
+    respond_to do |format|
+      format.html { redirect_to :back  }
+      format.js   { render :action => :create }
+    end
+
+  end
+
+  protected
+    def load_review
+      @review ||= Spree::Review.find_by_id!(params[:review_id])
+    end
+
+    def permitted_feedback_review_attributes
+      [:rating, :comment]
+    end
+
+    def feedback_review_params
+      params.require(:feedback_review).permit(permitted_feedback_review_attributes)
+    end
+
+    def sanitize_rating
+      params[:feedback_review][:rating].to_s.sub!(/\s*[^0-9]*\z/,'') unless (params[:feedback_review] && params[:feedback_review][:rating].blank?)
+    end
+end
+

data/app/controllers/spree/products_controller_decorator.rb

@@ -0,0 +1,5 @@
+Spree::ProductsController.class_eval do
+  helper Spree::ReviewsHelper
+
+  [:avg_rating, :reviews_count].each { |attrib| Spree::PermittedAttributes.product_attributes << attrib }
+end

data/app/controllers/spree/reviews_controller.rb

@@ -0,0 +1,48 @@
+class Spree::ReviewsController < Spree::StoreController
+  helper Spree::BaseHelper
+  before_filter :load_product, :only => [:index, :new, :create]
+  rescue_from ActiveRecord::RecordNotFound, :with => :render_404
+
+  def index
+    @approved_reviews = Spree::Review.approved.where(product: @product)
+  end
+
+  def new
+    @review = Spree::Review.new(:product => @product)
+    authorize! :create, @review
+  end
+
+  # save if all ok
+  def create
+    params[:review][:rating].sub!(/\s*[^0-9]*\z/,'') unless params[:review][:rating].blank?
+
+    @review = Spree::Review.new(review_params)
+    @review.product = @product
+    @review.user = spree_current_user if spree_user_signed_in?
+    @review.ip_address = request.remote_ip
+    @review.locale = I18n.locale.to_s if Spree::Reviews::Config[:track_locale]
+
+    authorize! :create, @review
+    if @review.save
+      flash[:notice] = Spree.t('review_successfully_submitted')
+      redirect_to spree.product_path(@product)
+    else
+      render :new
+    end
+  end
+
+  private
+
+  def load_product
+    @product = Spree::Product.friendly.find(params[:product_id])
+  end
+
+  def permitted_review_attributes
+    [:rating, :title, :review, :name, :show_identifier]
+  end
+
+  def review_params
+    params.require(:review).permit(permitted_review_attributes)
+  end
+
+end

data/app/helpers/spree/reviews_helper.rb

@@ -0,0 +1,17 @@
+module Spree::ReviewsHelper
+
+  def star(the_class)
+    content_tag(:span, " ✮ ".html_safe, :class => the_class)
+  end
+
+  def mk_stars(m)
+    (1..5).collect {|n| n <= m ? star("lit") : star("unlit") }.join
+  end
+
+  def txt_stars(n, show_out_of = true)
+    res = Spree.t('star', :count => n)
+    res += " #{Spree.t('out_of_5')}" if show_out_of
+    res
+  end
+
+end

data/app/models/spree/feedback_review.rb

@@ -0,0 +1,17 @@
+class Spree::FeedbackReview < ActiveRecord::Base
+  belongs_to :user, :class_name => Spree.user_class.to_s
+
+  belongs_to :review, dependent: :destroy
+  validates :review, presence: true
+
+  validates :rating, numericality: { only_integer: true,
+                                     greater_than_or_equal_to: 1, 
+                                     less_than_or_equal_to: 5,
+                                     message: Spree.t('you_must_enter_value_for_rating') }
+
+  scope :most_recent_first, -> { order("spree_feedback_reviews.created_at DESC") }
+  default_scope { most_recent_first }
+
+  scope :localized, lambda { |lc| where('spree_feedback_reviews.locale = ?', lc) }
+
+end

data/app/models/spree/product_decorator.rb

@@ -0,0 +1,21 @@
+# Add access to reviews/ratings to the product model
+Spree::Product.class_eval do
+  has_many :reviews
+
+  def stars
+    avg_rating.try(:round) || 0
+  end
+
+  def recalculate_rating
+    reviews_count = self.reviews.reload.approved.count
+
+    self.reviews_count = reviews_count
+    if reviews_count > 0
+      self.avg_rating = self.reviews.approved.sum(:rating).to_f / reviews_count
+    else
+      self.avg_rating = 0
+    end
+    self.save
+  end
+
+end

data/app/models/spree/review.rb

@@ -0,0 +1,36 @@
+class Spree::Review < ActiveRecord::Base
+  belongs_to :product, touch: true
+  belongs_to :user, :class_name => Spree.user_class.to_s
+  has_many   :feedback_reviews
+
+  after_save :recalculate_product_rating, :if => :approved?
+  after_destroy :recalculate_product_rating
+
+  validates :name, presence: true
+  validates :review, presence: true
+
+  validates :rating, numericality: { only_integer: true,
+                                     greater_than_or_equal_to: 1, 
+                                     less_than_or_equal_to: 5,
+                                     message: Spree.t('you_must_enter_value_for_rating') }
+
+
+  default_scope { order("spree_reviews.created_at DESC") }
+  
+  scope :localized, ->(lc) { where('spree_reviews.locale = ?', lc) }
+  scope :most_recent_first, -> { order('spree_reviews.created_at DESC') }
+  scope :oldest_first, -> { reorder('spree_reviews.created_at ASC') }
+  scope :preview, -> { limit(Spree::Reviews::Config[:preview_size]).oldest_first }
+  scope :approved, -> { where(approved: true) }
+  scope :not_approved, -> { where(approved: false) }
+  scope :default_approval_filter, -> { Spree::Reviews::Config[:include_unapproved_reviews] ? all : approved }
+
+  def feedback_stars
+    return 0 if feedback_reviews.size <= 0
+    ((feedback_reviews.sum(:rating) / feedback_reviews.size) + 0.5).floor
+  end
+
+  def recalculate_product_rating
+    self.product.recalculate_rating if product.present?
+  end
+end

data/app/models/spree/reviews_ability.rb

@@ -0,0 +1,17 @@
+class Spree::ReviewsAbility
+  include CanCan::Ability
+
+  def initialize user
+    review_ability_class = self.class
+    can :create, Spree::Review do |review|
+      review_ability_class.allow_anonymous_reviews? || !user.email.blank?
+    end
+    can :create, Spree::FeedbackReview do |review|
+      review_ability_class.allow_anonymous_reviews? || !user.email.blank?
+    end
+  end
+
+  def self.allow_anonymous_reviews?
+    !Spree::Reviews::Config[:require_login]
+  end
+end

data/app/models/spree/reviews_configuration.rb

@@ -0,0 +1,26 @@
+class Spree::ReviewsConfiguration < Spree::Preferences::Configuration
+  def self.boolean_preferences
+    %w(include_unapproved_reviews feedback_rating show_email require_login track_locale)
+  end
+
+  # include non-approved reviews in (public) listings
+  preference :include_unapproved_reviews, :boolean, :default => false
+
+  # control how many reviews are shown in summaries etc.
+  preference :preview_size, :integer, :default => 3
+
+  # show a reviewer's email address
+  preference :show_email, :boolean, :default => false
+
+  # show helpfullness rating form elements
+  preference :feedback_rating, :boolean, :default => false
+
+  # require login to post reviews
+  preference :require_login, :boolean, :default => true
+
+  # whether to keep track of the reviewer's locale
+  preference :track_locale, :boolean, :default => false
+
+  # render checkbox for a user to approve to show their identifier (name or email) on their review
+  preference :render_show_identifier_checkbox, :boolean, :default => false
+end

data/app/overrides/add_reviews_after_product_properties.rb

@@ -0,0 +1,5 @@
+Deface::Override.new(:virtual_path => "spree/products/show",
+                     :name => "converted_product_properties_767643482",
+                     :insert_after => "[data-hook='product_properties']",
+                     :partial => "spree/shared/reviews",
+                     :disabled => false)

data/app/overrides/add_reviews_tab_to_admin.rb

@@ -0,0 +1,4 @@
+Deface::Override.new(:virtual_path => "spree/admin/shared/_product_sub_menu",
+                     :name => "reviews_admin_tab",
+                     :insert_bottom => "[data-hook='admin_product_sub_tabs']",
+                     :text => "<%= tab(:reviews, :label => 'review_management') %>")

data/app/overrides/add_reviews_to_admin_configuration_sidebar.rb

@@ -0,0 +1,5 @@
+Deface::Override.new(:virtual_path => "spree/admin/shared/_configuration_menu",
+                     :name => "converted_admin_configurations_menu",
+                     :insert_bottom => "[data-hook='admin_configurations_sidebar_menu'], #admin_configurations_sidebar_menu[data-hook]",
+                     :text => "<%= configurations_sidebar_menu_item Spree.t('spree_reviews.review_settings'), edit_admin_review_settings_path %>",
+                     :disabled => false)