workarea-reviews 3.0.10

data/app/views/workarea/admin/status_report_mailer/_reviews.html.haml

@@ -0,0 +1,5 @@
+%tr
+  %td
+    %h2= t('workarea.admin.status_report_mailer.reviews.title')
+    %p= t('workarea.admin.status_report_mailer.reviews.recent_html', count: link_to(pluralize(@reviews_summary.recent_reviews_count, t('workarea.admin.status_report_mailer.reviews.review')), reviews_url(sort: :newest), style: "color: #{@link_color};"))
+    %p= t('workarea.admin.status_report_mailer.reviews.pending_html', count: link_to(pluralize(@reviews_summary.pending_reviews_count, t('workarea.admin.status_report_mailer.reviews.review')), reviews_url(state: %w(Pending)), style: "color: #{@link_color};"))

data/app/views/workarea/storefront/products/_rating.html.haml

@@ -0,0 +1,10 @@
+%p.rating{ title: "#{rating.round(2)} #{t('workarea.storefront.reviews.out_of')} #{t('workarea.storefront.reviews.stars', count: 5)}", itemprop: itemprop, itemscope: true, itemtype: itemtype }
+  - full_star_count.times do
+    = inline_svg 'workarea/storefront/icons/star.svg', class: 'rating__star'
+  - if half_star_size > 0
+    = inline_svg 'workarea/storefront/icons/half_star.svg', class: 'rating__star'
+  - empty_star_count.times do
+    = inline_svg 'workarea/storefront/icons/empty_star.svg', class: 'rating__star'
+  %span.rating__text.visually-hidden
+    %meta{ itemprop: 'ratingValue', content: rating.round(2) }
+    #{rating.round(2)} #{t('workarea.storefront.reviews.out_of')} #{t('workarea.storefront.reviews.stars', count: 5)}

data/app/views/workarea/storefront/products/_reviews.html.haml

@@ -0,0 +1,23 @@
+- if product.has_reviews?
+  #reviews.reviews
+    %h2= t('workarea.storefront.reviews.heading')
+
+    .reviews__header
+      %p.reviews__count= t('workarea.storefront.reviews.reviews', count: product.reviews.length)
+      %p.reviews__write-action= link_to t('workarea.storefront.reviews.write_a_review'), new_product_review_path(product), class: 'button', data: { dialog_button: '' }
+      - if display_purchase_requirement_message
+        %span.reviews__write-purchase-requirement= t('workarea.storefront.reviews.purchase_requirement')
+
+    %ol.reviews__review-group
+      - product.reviews.each do |review|
+        %li.reviews__review{ itemprop: 'review', itemscope: true, itemtype: 'http://schema.org/Review', data: { product_review_section_entry: { rating: review.rating.to_f, createdAt: review.created_at.to_i }.to_json } }
+          = rating_stars(review.rating)
+
+          %h3.reviews__review-title{ itemprop: 'name' }= review.title
+          %p.reviews__review-body{ itemprop: 'reviewBody' }= review.body
+          .reviews__review-meta
+            %p.reviews__review-author{ itemprop: 'author', itemscope: true, itemtype: 'http://schema.org/Person' }
+              %span{ itemprop: 'name' }= review.user_info
+            - if review.verified?
+              %p.reviews__review-verified= t('workarea.storefront.reviews.verified_purchaser')
+            %p.reviews__review-date= local_time(review.created_at, format: :long, itemprop: 'datePublished')

data/app/views/workarea/storefront/products/_reviews_aggregate.html.haml

@@ -0,0 +1,22 @@
+- if product.has_reviews?
+  .reviews-aggregate{ itemprop: 'aggregateRating', itemscope: true, itemtype: 'http://schema.org/AggregateRating' }
+    = link_to "#{product_path(product, product.browse_link_options)}#reviews", data: { scroll_to_button: '' }, class: 'reviews-aggregate__rating-link' do
+      = rating_stars(product.average_rating, aggregate: true)
+
+    = link_to "#{product_path(product, product.browse_link_options)}#reviews", data: { scroll_to_button: '' } do
+      %span.reviews-aggregate__count
+        %span.reviews-aggregate__read= t('workarea.storefront.reviews.read_reviews')
+        = surround '(', ')' do
+          %span{ itemprop: 'reviewCount' }= product.total_reviews
+
+    = link_to t('workarea.storefront.reviews.write_a_review'), new_product_review_path(product), class: 'reviews-aggregate__write-action', data: { dialog_button: '' }
+    - if display_purchase_requirement_message
+      %span.write-review__purchase-requirement= t('workarea.storefront.reviews.purchase_requirement')
+
+- else
+  .reviews-aggregate
+    %p.reviews-aggregate__count= t('workarea.storefront.reviews.reviews', count: 0)
+    = link_to t('workarea.storefront.reviews.write_a_review'), new_product_review_path(product), class: 'reviews-aggregate__write-action', data: { dialog_button: '' }
+    - if display_purchase_requirement_message
+      %p.write-review__purchase-requirement
+        = t('workarea.storefront.reviews.purchase_requirement')

data/app/views/workarea/storefront/products/_reviews_summary.html.haml

@@ -0,0 +1,2 @@
+- if product.has_reviews?
+  = rating_stars(product.average_rating, aggregate: true)

data/app/views/workarea/storefront/review_mailer/review_request.html.haml

@@ -0,0 +1,22 @@
+- content_for :preheader_text do
+  = @content
+
+%tr
+  %td
+    != @content
+
+    %table.product-grid
+      %tr
+        %td.stack-column-center
+          %table.product-grid__product{ role: 'presentation', width: '100%' }
+            %tr
+              %td.product-grid__image
+                = link_to product_url(@product), class: 'product-grid__link' do
+                  = image_tag(product_image_url(@product.primary_image, :medium_thumb), alt: @product.name)
+            %tr
+              %td.product-grid__info
+                = link_to product_url(@product), class: 'product-grid__link' do
+                  .product-grid__name= @product.name
+
+    %p
+      %strong= link_to t('workarea.storefront.email.review_request.link'), review_request_url(@request.token), class: 'button'

data/app/views/workarea/storefront/review_requests/show.html.haml

@@ -0,0 +1,44 @@
+- @title = t('workarea.storefront.reviews.write_a_review_title', name: @product.browser_title)
+
+.write-review.view
+  %h1= t('workarea.storefront.reviews.write_a_review_title', name: @product.name)
+
+  .grid
+    .grid__cell.grid__cell--25
+      .product-summary{ itemscope: true, itemtype: 'http://schema.org/Product' }
+        = render 'workarea/storefront/products/summary', product: @product
+
+    .grid__cell.grid__cell--75
+      - unless request.get?
+        - if @review.errors.any?
+          - @review.errors.full_messages.each do |message|
+            = render_message 'error', message, data: { analytics: validation_error_analytics_data('review').to_json }
+
+      = form_tag complete_review_request_path(@request.token), method: 'post', id: 'review_request_form' do
+        .property
+          = label_tag 'review[rating]', nil, class: 'property__name' do
+            %span.property__text= t('workarea.storefront.reviews.rating')
+          %ul.write-review__ratings
+            - (1..5).each do |i|
+              %li.write-review__rating
+                = radio_button_tag 'review[rating]', i, (i == @review.rating || i == 5) ? true : false, class: 'write-review__rating-input', data: { rating_button: '' }
+                = label_tag "review[rating][#{i}]", nil, class: 'write-review__star' do
+                  = inline_svg 'workarea/storefront/icons/star.svg', class: 'write-review__star-icon', title: t('workarea.storefront.reviews.stars', count: i)
+
+        .property
+          = label_tag 'review[title]', nil, class: 'property__name' do
+            %span.property__text= t('workarea.storefront.reviews.review_title')
+            %span.property__requirement.property__requirement--optional= t('workarea.storefront.forms.optional')
+          .value= text_field_tag 'review[title]', @review.title, class: 'text-box'
+
+        .property
+          = label_tag 'review[body]', nil, class: 'property__name' do
+            %span.property__requirement.property__requirement--required= t('workarea.storefront.forms.required')
+            %span.property__text= t('workarea.storefront.reviews.your_review')
+          .value= text_area_tag 'review[body]', @review.body, class: 'text-box text-box--multi-line', required: true
+
+        .property= recaptcha_tags
+
+        .grid.grid--auto
+          %p.grid__cell= button_tag t('workarea.storefront.reviews.submit'), value: 'submit_review', class: 'button', data: { disable_with: loading_indicator(t('workarea.storefront.reviews.submit_disabled')) }
+          %p.grid__cell= link_to t('workarea.storefront.forms.cancel'), product_path(@product), class: 'text-button', data: { dialog_close_button: '' }

data/app/views/workarea/storefront/reviews/new.html.haml

@@ -0,0 +1,68 @@
+- @title = t('workarea.storefront.reviews.write_a_review_title', name: @product.browser_title)
+
+.write-review.view
+  %h1= t('workarea.storefront.reviews.write_a_review_title', name: @product.browser_title)
+
+  - unless request.get?
+    - if @create_review.errors.any?
+      - @create_review.errors.full_messages.each do |message|
+        = render_message 'error', message, data: { analytics: validation_error_analytics_data('review').to_json }
+
+  = form_tag create_product_review_path(@product), method: 'post', id: 'review_form', data: { product_review_ajax_submit: '' } do
+    = hidden_field_tag 'review[product_id]', @product.id
+
+    - if display_purchase_requirement_message
+      %span.write-review__purchase-requirement= t('workarea.storefront.reviews.purchase_requirement')
+
+    - if @review.requires_public_info?
+      .property
+        = label_tag 'review[first_name]', nil, class: 'property__name' do
+          %span.property__requirement.property__requirement--required= t('workarea.storefront.forms.required')
+          %span.property__text= t('workarea.storefront.users.first_name')
+        .value
+          = text_field_tag 'review[first_name]', @review.first_name, class: 'text-box', required: true
+          .value__note= t('workarea.storefront.reviews.notes.display_name')
+      .property
+        = label_tag 'review[last_name]', nil, class: 'property__name' do
+          %span.property__requirement.property__requirement--required= t('workarea.storefront.forms.required')
+          %span.property__text= t('workarea.storefront.users.last_name')
+        .value
+          = text_field_tag 'review[last_name]', @review.last_name, class: 'text-box', required: true
+          .value__note= t('workarea.storefront.reviews.notes.display_name')
+
+    - if @review.anonymous?
+      .property
+        = label_tag 'review[email]', nil, class: 'property__name' do
+          %span.property__text= t('workarea.storefront.users.email')
+          %span.property__requirement.property__requirement--optional= t('workarea.storefront.forms.optional')
+        .value
+          = email_field_tag 'review[email]', @review.email, class: 'text-box', autocapitalize: 'off', autocorrect: 'off', autocomplete: 'email'
+          .value__note= t('workarea.storefront.reviews.notes.email')
+
+    .property
+      = label_tag 'review[rating]', nil, class: 'property__name' do
+        %span.property__text= t('workarea.storefront.reviews.rating')
+      %ul.write-review__ratings
+        - (1..5).each do |i|
+          %li.write-review__rating
+            = radio_button_tag 'review[rating]', i, (i == @review.rating || i == 5) ? true : false, class: 'write-review__rating-input', data: { rating_button: '' }
+            = label_tag "review[rating][#{i}]", nil, class: 'write-review__star' do
+              = inline_svg 'workarea/storefront/icons/star.svg', class: 'write-review__star-icon', title: t('workarea.storefront.reviews.stars', count: i)
+
+    .property
+      = label_tag 'review[title]', nil, class: 'property__name' do
+        %span.property__text= t('workarea.storefront.reviews.review_title')
+        %span.property__requirement.property__requirement--optional= t('workarea.storefront.forms.optional')
+      .value= text_field_tag 'review[title]', @review.title, class: 'text-box'
+
+    .property
+      = label_tag 'review[body]', nil, class: 'property__name' do
+        %span.property__requirement.property__requirement--required= t('workarea.storefront.forms.required')
+        %span.property__text= t('workarea.storefront.reviews.your_review')
+      .value= text_area_tag 'review[body]', @review.body, class: 'text-box text-box--multi-line', required: true
+
+    .property= recaptcha_tags
+
+    .grid.grid--auto
+      %p.grid__cell= button_tag t('workarea.storefront.reviews.submit'), value: 'submit_review', class: 'button', data: { disable_with: loading_indicator(t('workarea.storefront.reviews.submit_disabled')) }
+      %p.grid__cell= link_to t('workarea.storefront.forms.cancel'), product_path(@product), class: 'text-button', data: { dialog_close_button: '' }

data/app/views/workarea/storefront/style_guides/_reviews_product_summary_docs.html.haml

@@ -0,0 +1,13 @@
+%p With reviews:
+.style-guide__example-block
+  .product-summary
+    %p.product-summary__media
+      = link_to('#', class: 'product-summary__media-link') do
+        = image_tag('workarea/storefront/style_guide_product.jpg', alt: 'Product Name', class: 'product-summary__media-image')
+    .product-summary__info
+      %p.product-summary__name= link_to('Product Name', '#')
+      .product-summary__price-group
+        %p.product-summary__price
+          %span= number_to_currency(109.99)
+      = rating_stars(3.5, aggregate: true)
+    %p.product-summary__quickview= link_to('Quick View', '#', class: 'button button--small', rel: 'nofollow', data: { dialog_button: '' })

data/app/views/workarea/storefront/style_guides/components/_reviews.html.haml

@@ -0,0 +1,17 @@
+#rating.style-guide__subsection
+
+  %h3= link_to_style_guide('components', 'rating')
+
+  %p Displays a graphical rating scale for a numerical rating (1.0 - 5.0). Use the <code>rating_stars(rating, options = {})</code> helper to generate the rating stars.
+
+  %h4 Options
+  %ul
+    %li
+      <code>aggregate</code> (default: false)
+      %ul
+        %li Passing <code>aggregate: true</code> will change schema.org rating type from `reviewRating` to `aggregateRating` (an average rating from multiple reviews). See <a href="https://schema.org/AggregateRating">https://schema.org/AggregateRating</a> for more info.
+
+  - [1.5, 2.0, 3.75, 4.1, 4.8].each do |rating|
+    %p Example: rating of #{rating}
+    .style-guide__example-block
+      = rating_stars(rating, aggregate: true)

data/app/workers/workarea/create_review_requests.rb

@@ -0,0 +1,33 @@
+module Workarea
+  class CreateReviewRequests
+    include Sidekiq::Worker
+    include Sidekiq::CallbacksWorker
+
+    sidekiq_options(
+      enqueue_on: {
+        Order => :place,
+        only_if: -> { Workarea.config.send_transactional_emails }
+      },
+      queue: 'low'
+    )
+
+    def perform(order_id)
+      order = Order.find(order_id)
+      product_ids = order.items
+                         .sort_by(&:original_unit_price)
+                         .reverse
+                         .map(&:product_id)
+                         .uniq
+                         .take(Workarea.config.review_requests_per_order)
+
+      product_ids.each do |product_id|
+        Review::Request.create(
+          email: order.email,
+          order_id: order.id,
+          user_id: order.user_id,
+          product_id: product_id
+        )
+      end
+    end
+  end
+end

data/app/workers/workarea/schedule_review_requests.rb

@@ -0,0 +1,44 @@
+module Workarea
+  class ScheduleReviewRequests
+    include Sidekiq::Worker
+
+    sidekiq_options queue: 'low'
+
+    def perform(order_id, shipped_items)
+      requests = Review::Request.by_order(order_id).to_a
+      return if requests.all?(&:send_after)
+
+      order = Order.find(order_id)
+      product_ids =
+        shipped_items.map do |item|
+          order_item = order.items.detect { |i| i.id.to_s == item['id'] }
+          order_item&.product_id
+        end
+        .compact
+
+      schedule_requests(
+        requests.select { |request| request.product_id.in?(product_ids) },
+        requests
+      )
+    end
+
+    def schedule_requests(affected_requests, all_requests)
+      affected_requests.each do |request|
+        next if request.send_after.present?
+
+        last_scheduled =
+          all_requests.select(&:send_after).sort_by(&:send_after).last
+
+        date_to_send =
+          if last_scheduled.present?
+            last_scheduled.send_after +
+              Workarea.config.review_request_secondary_delivery_delay
+          else
+            Workarea.config.review_request_initial_delivery_delay.from_now
+          end
+
+        request.update_attributes(send_after: date_to_send)
+      end
+    end
+  end
+end

data/app/workers/workarea/send_review_requests.rb

@@ -0,0 +1,12 @@
+module Workarea
+  class SendReviewRequests
+    include Sidekiq::Worker
+
+    def perform
+      Review::Request.ready_to_send.each do |request|
+        Storefront::ReviewMailer.review_request(request).deliver_now
+        request.send!
+      end
+    end
+  end
+end

data/app/workers/workarea/update_product_review_data.rb

@@ -0,0 +1,26 @@
+module Workarea
+  class UpdateProductReviewData
+    include Sidekiq::Worker
+    include Sidekiq::CallbacksWorker
+
+    sidekiq_options(
+      enqueue_on: {
+        Workarea::Review => [:save, :destroy],
+        with: -> { [product_id] }
+      },
+      unique: :until_and_while_executing
+    )
+
+    def perform(product_id)
+      product = Workarea::Catalog::Product.find(product_id)
+      review_data = Review.find_single_aggregates(product_id)
+
+      product.update_attributes!(
+        total_reviews: review_data[:count],
+        average_rating: review_data[:average]
+      )
+    rescue Mongoid::Errors::DocumentNotFound
+      # we're ok if the product doesn't exist
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/workarea/reviews/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'action_controller/railtie'
+require 'action_view/railtie'
+require 'action_mailer/railtie'
+require 'rails/test_unit/railtie'
+require 'sprockets/railtie'
+
+require 'rails/engine/commands'

data/config/initializers/append_points.rb

@@ -0,0 +1,70 @@
+module Workarea
+  #
+  # Storefront
+  #
+  #
+
+  Plugin.append_stylesheets(
+    'storefront.components',
+    'workarea/storefront/reviews/components/rating',
+    'workarea/storefront/reviews/components/reviews',
+    'workarea/storefront/reviews/components/reviews_aggregate',
+    'workarea/storefront/reviews/components/write_review',
+  )
+
+  Plugin.append_javascripts(
+    'storefront.templates',
+    'workarea/storefront/reviews/templates/sort_by_property'
+  )
+
+  Plugin.append_javascripts(
+    'storefront.modules',
+    'workarea/storefront/reviews/modules/product_review_ajax_submit',
+    'workarea/storefront/reviews/modules/product_reviews_sort_menus',
+    'workarea/storefront/reviews/modules/rating_buttons',
+  )
+
+  Plugin.append_partials(
+    'storefront.style_guide_product_summary',
+    'workarea/storefront/style_guides/reviews_product_summary_docs'
+  )
+
+  Plugin.append_partials(
+    'storefront.product_details',
+    'workarea/storefront/products/reviews_aggregate'
+  )
+
+  Plugin.append_partials(
+    'storefront.product_show',
+    'workarea/storefront/products/reviews'
+  )
+
+  Plugin.append_partials(
+    'storefront.product_summary',
+    'workarea/storefront/products/reviews_summary'
+  )
+
+  #
+  # Admin
+  #
+  #
+  Plugin.append_partials(
+    'admin.marketing_menu',
+    'workarea/admin/reviews/menu'
+  )
+
+  Plugin.append_partials(
+    'admin.catalog_product_aux_navigation',
+    'workarea/admin/reviews/catalog_products_aux_link'
+  )
+
+  Plugin.append_partials(
+    'admin.status_report_mailer',
+    'workarea/admin/status_report_mailer/reviews'
+  )
+
+  Workarea.append_partials(
+    'admin.marketing_dashboard_navigation',
+    'workarea/admin/reviews/dashboard_navigation'
+  )
+end