workarea-reviews 3.1.0

data/app/assets/javascripts/workarea/storefront/reviews/templates/sort_by_property.jst.ejs

@@ -0,0 +1,11 @@
+<div class="property property--responsive">
+    <label class="property__name"><span class="property__text">Sort By</span></label>
+    <div class="value">
+        <select data-product-reviews-sort-menu="">
+            <option value="newest" selected>Most Recent</option>
+            <option value="oldest">Oldest First</option>
+            <option value="highest">Rating: High to Low</option>
+            <option value="lowest">Rating: Low to High</option>
+        </select>
+    </div>
+</div>

data/app/assets/stylesheets/workarea/storefront/reviews/components/_rating.scss

@@ -0,0 +1,28 @@
+/*------------------------------------*\
+    #RATING
+\*------------------------------------*/
+
+$rating-fill-color:   $yellow !default;
+$rating-empty-color:  $gray !default;
+$rating-star-size: 16px !default;
+
+
+
+.rating {
+    position: relative;
+    white-space: nowrap;
+    vertical-align: middle;
+    user-select: none;
+
+    .product-summary & {
+        margin: $spacing-unit auto 0;
+    }
+}
+
+    .rating__star {
+        display: inline-block;
+        width:  $rating-star-size;
+        height: $rating-star-size;
+        fill: $rating-fill-color;
+        overflow: hidden;
+    }

data/app/assets/stylesheets/workarea/storefront/reviews/components/_reviews.scss

@@ -0,0 +1,59 @@
+/*------------------------------------*\
+    #REVIEWS
+\*------------------------------------*/
+
+.reviews {
+    margin: ($spacing-unit * 3) 0 0;
+}
+
+    .reviews__header {
+        display: table;
+        margin: 0 0 ($spacing-unit * 2);
+        width: 100%;
+    }
+
+        .reviews__count {
+            display: table-cell;
+        }
+
+        .reviews__write-action {
+            display: table-cell;
+            text-align: right;
+        }
+
+    .reviews__review-group {
+        @extend %list-reset;
+    }
+
+        .reviews__review {
+            padding: ($spacing-unit * 2) 0;
+        }
+
+            .reviews__review-title {}
+
+            .reviews__review-body {}
+
+            .reviews__review-meta {
+                @extend %clearfix;
+            }
+
+                .reviews__review-author {
+                    margin: 0;
+                    float: left;
+                    line-height: 1;
+                }
+
+                .reviews__review-verified {
+                    margin: 0 0 0 $spacing-unit;
+                    padding-left: $spacing-unit;
+                    float: left;
+                    line-height: 1;
+                    font-weight: bold;
+                }
+
+                .reviews__review-date {
+                    margin: 0 0 0 $spacing-unit;
+                    padding-left: $spacing-unit;
+                    float: left;
+                    line-height: 1;
+                }

data/app/assets/stylesheets/workarea/storefront/reviews/components/_reviews_aggregate.scss

@@ -0,0 +1,38 @@
+/*------------------------------------*\
+    #REVIEWS-AGGREGATE
+\*------------------------------------*/
+
+$reviews-aggregate-border: 1px solid $link-color !default;
+
+
+.reviews-aggregate {
+    @extend %clearfix;
+    margin: 0 0 12px;
+
+    /**
+     * Extend `.rating {}` in _rating.scss.
+     */
+
+    .rating {
+        @extend %inline-list;
+        margin: 0 ($spacing-unit / 2) 0 0;
+    }
+}
+
+    .reviews-aggregate__rating-link:hover {
+        text-decoration: none;
+    }
+
+    .reviews-aggregate__count {
+        @extend %inline-list;
+    }
+
+    .reviews-aggregate__read {}
+
+    .reviews-aggregate__write-action {
+        &::before {
+            padding-right: ($spacing-unit / 2);
+            border-left: $reviews-aggregate-border;
+            content: '';
+        }
+    }

data/app/assets/stylesheets/workarea/storefront/reviews/components/_write_review.scss

@@ -0,0 +1,63 @@
+/*------------------------------------*\
+    #WRITE-REVIEW
+\*------------------------------------*/
+
+$write-review-fill-color:   $yellow !default;
+$write-review-empty-color:  $transparent !default;
+$write-review-star-size:    16px !default;
+
+
+.write-review {}
+
+    .write-review__ratings {
+        @extend %inline-list;
+
+
+        .js & {
+            @extend %clearfix;
+        }
+    }
+
+        .write-review__rating {
+            font-size: $write-review-star-size;
+
+            .js & {
+                padding-right: ($spacing-unit / 2);
+                float: left;
+            }
+        }
+
+            .write-review__rating-input {
+                margin: 0 ($spacing-unit / 2) 0 0;
+
+                .js & {
+                    @extend %visually-hidden;
+                }
+            }
+
+            .write-review__star {}
+
+                .write-review__star-icon {
+                    width:  $write-review-star-size;
+                    height: $write-review-star-size;
+                    fill: $write-review-empty-color;
+                    stroke: $write-review-fill-color;
+
+                    .write-review__star--hovered &,
+                    .write-review__star--active & {
+                        fill: $write-review-fill-color;
+                    }
+                }
+
+
+                .write-review__star--hovered {
+                    opacity: 0.4;
+                }
+
+                .write-review__star--active {
+                    opacity: 1;
+                }
+
+                    .write-review__star-text {
+                        @extend %hidden-if-js-enabled;
+                    }

data/app/controllers/workarea/admin/catalog_products_controller.decorator

@@ -0,0 +1,9 @@
+module Workarea
+  decorate Admin::CatalogProductsController, with: :reviews do
+    decorated { helper Admin::ReviewsHelper }
+
+    def reviews
+      @reviews = Review.find_for_product(@product.id, true)
+    end
+  end
+end

data/app/controllers/workarea/admin/reports_controller.decorator

@@ -0,0 +1,10 @@
+module Workarea
+  decorate Admin::ReportsController, with: :reviews do
+    def reviews_by_product
+      @report = Admin::Reports::ReviewsByProductViewModel.wrap(
+        Workarea::Reports::ReviewsByProduct.new(params),
+        view_model_options
+      )
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+module Workarea
+  class Admin::ReviewsController < Admin::ApplicationController
+    required_permissions :marketing
+    before_action :find_review, except: :index
+
+    def index
+      search = Search::AdminReviews.new(params.merge(autocomplete: request.xhr?))
+      @search = Admin::ReviewsSearchViewModel.new(search, view_model_options)
+    end
+
+    def show
+      redirect_to edit_review_path(@review)
+    end
+
+    def edit; end
+
+    def update
+      if @review.update_attributes(review_params)
+        flash[:success] = t('workarea.admin.reviews.flash_messages.updated')
+        redirect_to reviews_path
+      else
+        render :edit
+      end
+    end
+
+    def destroy
+      @review.destroy
+      flash[:success] = t('workarea.admin.reviews.flash_messages.destroyed')
+      if params[:product].present?
+        redirect_to reviews_catalog_product_path(params[:product])
+      else
+        redirect_to reviews_path
+      end
+    end
+
+    private
+
+    def find_review
+      if params[:id].present?
+        review = Review.find(params[:id])
+        @review = Admin::ReviewViewModel.wrap(review)
+        @user = User.find(review.user_id) rescue nil
+      end
+    end
+
+    def review_params
+      return {} if params[:review].blank?
+      params[:review].permit(:body, :approved, :rating, :title)
+    end
+  end
+end

data/app/controllers/workarea/storefront/review_requests_controller.rb

@@ -0,0 +1,50 @@
+module Workarea
+  module Storefront
+    class ReviewRequestsController < Storefront::ApplicationController
+      before_action :validate_request
+      before_action :find_product, :set_review
+
+      def show; end
+
+      def complete
+        if verify_recaptcha(model: @review, env: Rails.env) && @review.save
+          @request.complete!
+          Review::Request.cancel_for_orders!(@request.order_id)
+
+          flash[:success] = t('workarea.storefront.reviews.flash_messages.created')
+          redirect_to product_path(@product)
+        else
+          flash[:error] = t('workarea.storefront.reviews.flash_messages.failure')
+          render :show
+        end
+      end
+
+      private
+
+      def validate_request
+        @request = Review::Request.find_by_token(params[:id])
+
+        if @request.nil? || @request.completed?
+          flash[:error] = t('workarea.storefront.review_requests.flash_messages.already_submitted')
+          redirect_to(root_path) && (return)
+        end
+      end
+
+      def find_product
+        model = Catalog::Product.find(@request.product_id)
+        @product = ProductViewModel.wrap(model, view_model_options)
+      end
+
+      def set_review
+        @review = ReviewViewModel.wrap(Review.new(review_params))
+      end
+
+      def review_params
+        ReviewRequestParams.new(
+          @request,
+          params[:review]&.permit(:rating, :title, :body)&.to_h || {}
+        ).to_h
+      end
+    end
+  end
+end

data/app/controllers/workarea/storefront/reviews_controller.rb

@@ -0,0 +1,53 @@
+module Workarea
+  module Storefront
+    class ReviewsController < Storefront::ApplicationController
+      before_action :find_product
+      before_action :set_review
+
+      def new; end
+
+      def create
+        if review_can_be_saved? && @create_review.save
+          redirect_to product_path(params[:product_id])
+          flash[:success] = t('workarea.storefront.reviews.flash_messages.created')
+        else
+          render :new
+          flash[:error] = t('workarea.storefront.reviews.flash_messages.failure')
+        end
+      end
+
+      private
+
+      def set_review
+        @create_review = CreateReview.for(
+          product: @product,
+          user: current_user,
+          params: review_params.to_h
+        )
+
+        @review = ReviewViewModel.wrap(@create_review.review)
+      end
+
+      def find_product
+        @product ||=
+          begin
+            model = Catalog::Product.find_by(slug: params[:product_id])
+            raise InvalidDisplay unless model.active? || current_user.try(:admin?)
+            ProductViewModel.wrap(model)
+          end
+      end
+
+      def review_params
+        return {} unless params[:review].present?
+
+        params[:review].permit(
+          :product_id, :rating, :title, :body, :first_name, :last_name, :email
+        )
+      end
+
+      def review_can_be_saved?
+        verify_recaptcha(model: @create_review, env: Rails.env)
+      end
+    end
+  end
+end

data/app/helpers/workarea/admin/reviews_helper.rb

@@ -0,0 +1,13 @@
+module Workarea
+  module Admin
+    module ReviewsHelper
+      def reviews_report_filter_options
+        [
+          [t('workarea.admin.reports.reviews_by_product.filters.all'), nil],
+          [t('workarea.admin.reports.reviews_by_product.filters.approved'), 'approved'],
+          [t('workarea.admin.reports.reviews_by_product.filters.unapproved'), 'unapproved']
+        ]
+      end
+    end
+  end
+end

data/app/helpers/workarea/storefront/reviews_helper.rb

@@ -0,0 +1,22 @@
+module Workarea
+  module Storefront
+    module ReviewsHelper
+      def rating_stars(rating, options = {})
+        full_star_count = rating.floor
+        empty_star_count = 5 - rating.ceil
+        half_star_size = (rating % 1).round(2) * 100
+        half_star_width = 20 + (half_star_size - 0) * (80.0 - 20) / (100.0 - 0)
+
+        render 'workarea/storefront/products/rating', rating: rating, full_star_count: full_star_count, empty_star_count: empty_star_count, half_star_width: half_star_width, half_star_size: half_star_size
+      end
+
+      def display_purchase_requirement_message
+        if current_user && Workarea.config.require_purchase_to_post_review && current_user.total_spent.to_f.zero?
+          true
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/app/helpers/workarea/storefront/reviews_schema_org_helper.rb

@@ -0,0 +1,34 @@
+module Workarea
+  module Storefront
+    module ReviewsSchemaOrgHelper
+      def product_schema(product, related_products: nil)
+        schema = super.merge(
+          'review': product.reviews.map do |review|
+            {
+              '@type': 'Review',
+              'author': review.user_info,
+              'datePublished': review.created_at.strftime('%Y-%m-%d'),
+              'description': review.body,
+              'name': review.title,
+              'reviewRating': {
+                '@type': 'Rating',
+                'bestRating': '5',
+                'worstRating': '1',
+                'ratingValue': review.rating.round(2).to_s
+              }
+            }
+          end
+        )
+
+        if product.total_reviews > 0 && product.average_rating.present?
+          schema['aggregateRating'] = {
+            'reviewCount': product.total_reviews.to_s,
+            'ratingValue': product.average_rating.round(2).to_s
+          }
+        end
+
+        schema
+      end
+    end
+  end
+end