workarea-reviews 3.0.8 → 3.1.2

data/app/queries/workarea/reports/reviews_by_user.rb

@@ -0,0 +1,71 @@
+module Workarea
+  module Reports
+    class ReviewsByUser
+      include Report
+
+      self.reporting_class = Review
+      self.sort_fields = %w(reviews verified average_rating activity_score)
+
+      def aggregation
+        [filter_results, project_used_fields, group_by_email, project_fields]
+      end
+
+      def filter_results
+        {
+          '$match' => {
+            'created_at' => { '$gte' => starts_at, '$lte' => ends_at },
+            **approval_query
+          }
+        }
+      end
+
+      def project_used_fields
+        {
+          '$project' => {
+            'email' => 1,
+            'user_id' => 1,
+            'rating' => 1,
+            'verified' => 1
+          }
+        }
+      end
+
+      def group_by_email
+        {
+          '$group' => {
+            '_id' => '$email',
+            'user_id' => { '$max' => '$user_id' },
+            'reviews' => { '$sum' => 1 },
+            'verified' => { '$sum' => { '$cond' => { 'if' => '$verified', 'then' => 1, 'else' => 0 } } },
+            'rating_tally' => { '$sum' => '$rating' }
+          }
+        }
+      end
+
+      def project_fields
+        {
+          '$project' => {
+            'email' => 1,
+            'user_id' => 1,
+            'reviews' => 1,
+            'verified' => 1,
+            'average_rating' => { '$divide' => ['$rating_tally', '$reviews'] },
+            'activity_score' => { '$sum' => ['$reviews', { '$multiply' => ['$verified', 0.75] }] }
+          }
+        }
+      end
+
+      private
+
+      def approval_query
+        if params[:results_filter] == 'approved'
+          { approved: true }
+        elsif params[:results_filter] == 'unapproved'
+          { approved: false }
+        else
+          {}
+        end
+      end
+    end
+  end
+end

data/app/seeds/{reviews.rb → workarea/review_seeds.rb}

@@ -3,17 +3,26 @@ module Workarea
     def perform
       puts 'Adding reviews...'
 
-      Workarea::Catalog::Product.all.each_by(100) do |product|
-        rand(10).times { create_review(product) }
+      Sidekiq::Callbacks.disable do
+        create_reviews_for_catalog
+        create_review_request_email_content
       end
-
-      create_review_request_email_content
     end
 
     private
 
+    def create_reviews_for_catalog
+      Workarea::Catalog::Product.all.each_by(100) do |product|
+        reviews = Array.new(rand(10)) { create_review(product) }
+        next unless reviews.size > 0
+
+        Workarea::Review.collection.insert_many(reviews.map(&:as_document))
+        UpdateProductReviewData.perform_async(product.id)
+      end
+    end
+
     def create_review(product)
-      Workarea::Review.create!(
+      Workarea::Review.new(
         product_id: product.id,
         user_id: BSON::ObjectId.new,
         rating: rand(5) + 1,
@@ -21,7 +30,9 @@ module Workarea
         body: Faker::Lorem.paragraph,
         approved: [true, false].sample,
         user_info: Faker::Internet.user_name,
-        verified: [true, false].sample
+        verified: [true, false].sample,
+        created_at: rand(45).days.ago,
+        updated_at: Time.current
       )
     end
 

data/app/view_models/workarea/admin/dashboards/reports_view_model.decorator

@@ -0,0 +1,11 @@
+module Workarea
+  decorate Admin::Dashboards::ReportsViewModel, with: :reviews do
+    def reviews_by_product
+      @reviews_by_product ||=
+        Admin::Reports::ReviewsByProductViewModel.wrap(
+          Workarea::Reports::ReviewsByProduct.new(options),
+          options
+        )
+    end
+  end
+end

data/app/view_models/workarea/admin/reports/reviews_by_product_view_model.rb

@@ -0,0 +1,27 @@
+module Workarea
+  module Admin
+    module Reports
+      class ReviewsByProductViewModel < ApplicationViewModel
+        def results
+          @results ||= model.results.map do |result|
+            product = products.detect { |p| p.id == result['_id'] }
+            OpenStruct.new(
+              { product: product }
+                .merge(result)
+                .merge(
+                  average_rating: result['average_rating'].round(2),
+                  weighted_average_rating: result['weighted_average_rating'].round(2)
+                )
+            )
+          end
+        end
+
+        def products
+          @products ||= Catalog::Product.any_in(
+            id: model.results.map { |r| r['_id'] }
+          ).to_a
+        end
+      end
+    end
+  end
+end

data/app/view_models/workarea/storefront/review_view_model.rb

@@ -2,12 +2,18 @@ module Workarea
   module Storefront
     class ReviewViewModel < ApplicationViewModel
       def requires_public_info?
-        anonymous? || user.public_info.blank?
+        anonymous? || user&.public_info.blank?
+      end
+
+      def anonymous?
+        model.anonymous? || user.nil?
       end
 
       def user
-        return if anonymous?
-        @user ||= User.find(user_id)
+        return if model.anonymous?
+        return @user if defined?(@user)
+
+        @user = User.find(user_id) rescue nil
       end
     end
   end

data/app/views/workarea/admin/dashboards/_reviews_by_product_card.html.haml

@@ -0,0 +1,17 @@
+.grid__cell
+  .card{ class: card_classes(:reviews_by_product_report, local_assigns[:active]) }
+    = link_to reviews_by_product_report_path, class: 'card__header' do
+      %span.card__header-text= t('workarea.admin.reports.reviews_by_product.title')
+      = inline_svg 'workarea/admin/icons/insights.svg', class: 'card__icon'
+
+    .card__body
+      .card__centered-content
+        %table
+          %tbody
+            - @dashboard.reviews_by_product.results.take(4).each do |result|
+              %tr
+                %td= result.product.present? ? result.product.name : result._id
+                %td.align-right= number_with_delimiter result.reviews
+
+        = link_to reviews_by_product_report_path, class: 'card__button' do
+          %span.button.button--small= t('workarea.admin.dashboards.reports.view_full_report')

data/app/views/workarea/admin/insights/_most_active_reviewers.html.haml

@@ -0,0 +1,22 @@
+.insight
+  .insight__date
+    %span.insight__period= insight.reporting_on.strftime('%B %Y')
+  .insight__heading= t('workarea.admin.insights.most_active_reviewers.title')
+  .insight__body
+    %p.insight__note= t('workarea.admin.insights.most_active_reviewers.info')
+    %table
+      %thead
+        %tr
+          %th.align-center= t('workarea.admin.insights.most_active_reviewers.user')
+          %th.align-center= t('workarea.admin.insights.most_active_reviewers.reviews')
+          %th.align-center= t('workarea.admin.insights.most_active_reviewers.verified')
+      %tbody
+        - insight.results.each do |result|
+          %tr
+            %td.align-center
+              - if result.user.present?
+                = link_to result.user.name, user_path(result.user)
+              - else
+                = result.email
+            %td.align-center= number_with_delimiter result.reviews
+            %td.align-center= number_with_delimiter result.verified

data/app/views/workarea/admin/insights/_most_reviewed_products.html.haml

@@ -0,0 +1,22 @@
+.insight
+  .insight__date
+    %span.insight__period= insight.reporting_on.strftime('%B %Y')
+  .insight__heading= t('workarea.admin.insights.most_reviewed_products.title')
+  .insight__body
+    %p.insight__note= t('workarea.admin.insights.most_reviewed_products.info')
+    .grid.grid--large.grid--center
+      - insight.results.each do |result|
+        .grid__cell.grid__cell--50.grid__cell--25-at-wide.align-center
+          .insight__product
+            - if result.product.blank?
+              = image_tag(product_image_url(Workarea::Catalog::ProductPlaceholderImage.cached, :small), alt: result.product_id, class: 'insight__product-image')
+            - else
+              = link_to catalog_product_path(result.product) do
+                = image_tag(product_image_url(result.product.primary_image, :small), alt: result.product.name, class: 'insight__product-image')
+            .insight__product-name
+              - if result.product.blank?
+                = result.product_id
+              - else
+                = link_to result.product.name, catalog_product_path(result.product)
+            .insight__product-info
+              %strong= t('workarea.admin.insights.most_reviewed_products.reviews', count: result.reviews)

data/app/views/workarea/admin/insights/_top_rated_products.html.haml

@@ -0,0 +1,22 @@
+.insight
+  .insight__date
+    %span.insight__period= insight.reporting_on.strftime('%B %Y')
+  .insight__heading= t('workarea.admin.insights.top_rated_products.title')
+  .insight__body
+    %p.insight__note= t('workarea.admin.insights.top_rated_products.info')
+    .grid.grid--large.grid--center
+      - insight.results.each do |result|
+        .grid__cell.grid__cell--50.grid__cell--25-at-wide.align-center
+          .insight__product
+            - if result.product.blank?
+              = image_tag(product_image_url(Workarea::Catalog::ProductPlaceholderImage.cached, :small), alt: result.product_id, class: 'insight__product-image')
+            - else
+              = link_to catalog_product_path(result.product) do
+                = image_tag(product_image_url(result.product.primary_image, :small), alt: result.product.name, class: 'insight__product-image')
+            .insight__product-name
+              - if result.product.blank?
+                = result.product_id
+              - else
+                = link_to result.product.name, catalog_product_path(result.product)
+            .insight__product-info
+              %strong= t('workarea.admin.insights.top_rated_products.rating', rating: number_with_delimiter(result.weighted_average_rating.round(2)))

data/app/views/workarea/admin/reports/reviews_by_product.html.haml

@@ -0,0 +1,44 @@
+- @page_title = t('workarea.admin.reports.reviews_by_product.title')
+
+.view
+  .view__header
+    .view__heading
+      = link_to "↑ #{t('workarea.admin.reports.all_reports')}", reports_dashboards_path
+      %h1.heading.heading--no-margin= t('workarea.admin.reports.reviews_by_product.title')
+      %p= t('workarea.admin.reports.reference_link_html', path: reference_report_path)
+
+  .view__container.view__container--narrow
+    .browsing-controls.browsing-controls--with-divider.browsing-controls--center.browsing-controls--filters-displayed
+      = form_tag reviews_by_product_report_path, method: 'get', class: 'browsing-controls__form' do
+        = render 'workarea/admin/shared/date_selector', starts_at: @report.starts_at, ends_at: @report.ends_at
+
+        .browsing-controls__filter
+          .property.property--inline
+            = label_tag 'results_filter', t('workarea.admin.reports.reviews_by_product.results_filter'), class: 'property__name'
+            = select_tag 'results_filter', options_for_select(reviews_report_filter_options, params[:results_filter]), data: { form_submitting_control: '' }
+
+
+      .browsing-controls__count
+        = render_reports_results_message(@report)
+        = render 'workarea/admin/reports/export', report: @report
+
+    %table
+      %thead
+        %tr
+          %th= t('workarea.admin.fields.product')
+          %th.align-center= link_to_reports_sorting t('workarea.admin.fields.reviews'), report: @report, sort_by: 'reviews'
+          %th.align-center= link_to_reports_sorting t('workarea.admin.fields.verified_reviews'), report: @report, sort_by: 'verified'
+          %th.align-center= link_to_reports_sorting t('workarea.admin.fields.average_rating'), report: @report, sort_by: 'average_rating'
+          %th.align-center= link_to_reports_sorting t('workarea.admin.fields.weighted_average_rating'), report: @report, sort_by: 'weighted_average_rating'
+      %tbody
+        - @report.results.each do |result|
+          %tr
+            %td
+              - if result.product.present?
+                = link_to result.product.name, catalog_product_path(result.product)
+              - else
+                = result._id
+            %td.align-center= number_with_delimiter result.reviews
+            %td.align-center= number_with_delimiter result.verified
+            %td.align-center= number_with_delimiter result.average_rating
+            %td.align-center= number_with_delimiter result.weighted_average_rating

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

@@ -1,4 +1,4 @@
-%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 }
+%p.rating{ title: "#{rating.round(2)} #{t('workarea.storefront.reviews.out_of')} #{t('workarea.storefront.reviews.stars', count: 5)}" }
   - full_star_count.times do
     = inline_svg 'workarea/storefront/icons/star.svg', class: 'rating__star'
   - if half_star_size > 0
@@ -6,5 +6,4 @@
   - 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

@@ -10,14 +10,14 @@
 
     %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 } }
+        %li.reviews__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
+          %h3.reviews__review-title= review.title
+          %p.reviews__review-body= review.body
           .reviews__review-meta
-            %p.reviews__review-author{ itemprop: 'author', itemscope: true, itemtype: 'http://schema.org/Person' }
-              %span{ itemprop: 'name' }= review.user_info
+            %p.reviews__review-author
+              %span= 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

@@ -1,5 +1,5 @@
 - if product.has_reviews?
-  .reviews-aggregate{ itemprop: 'aggregateRating', itemscope: true, itemtype: 'http://schema.org/AggregateRating' }
+  .reviews-aggregate
     = 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)
 
@@ -7,7 +7,7 @@
       %span.reviews-aggregate__count
         %span.reviews-aggregate__read= t('workarea.storefront.reviews.read_reviews')
         = surround '(', ')' do
-          %span{ itemprop: 'reviewCount' }= product.total_reviews
+          %span= 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

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

@@ -1,3 +1,5 @@
+= render_schema_org(email_action_schema(review_request_url(@request.token), t('workarea.storefront.email.review_request.email_action.name'), t('workarea.storefront.email.review_request.email_action.description')))
+
 - content_for :preheader_text do
   = @content
 

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

@@ -5,7 +5,8 @@
 
   .grid
     .grid__cell.grid__cell--25
-      .product-summary{ itemscope: true, itemtype: 'http://schema.org/Product' }
+      .product-summary
+        = render_schema_org(product_schema(@product))
         = render 'workarea/storefront/products/summary', product: @product
 
     .grid__cell.grid__cell--75

data/config/initializers/append_points.rb

@@ -67,4 +67,9 @@ module Workarea
     'admin.marketing_dashboard_navigation',
     'workarea/admin/reviews/dashboard_navigation'
   )
+
+  Workarea.append_partials(
+    'admin.reports_dashboard',
+    'workarea/admin/dashboards/reviews_by_product_card'
+  )
 end

data/config/initializers/configuration.rb

@@ -1,5 +1,5 @@
 Workarea.configure do |config|
-  config.seeds << 'Workarea::ReviewSeeds'
+  config.seeds.insert('Workarea::InsightsSeeds', 'Workarea::ReviewSeeds')
 
   config.jump_to_navigation.merge!('Product Reviews' => :reviews_path)
 
@@ -11,6 +11,8 @@ Workarea.configure do |config|
 
   config.data_file_ignored_fields << %w(total_reviews average_rating)
 
+  config.insights_model_classes << 'Workarea::User'
+
   # The amount of time before a Review::Request will auto expire
   # and be removed from the collection
   config.review_request_ttl = 6.months

data/config/initializers/scheduled_jobs.rb

@@ -1,6 +1,8 @@
-Sidekiq::Cron::Job.create(
-  name: 'Workarea::SendReviewRequests',
-  klass: 'Workarea::SendReviewRequests',
-  cron: "0 0 * * * #{Time.zone.tzinfo.identifier}",
-  queue: 'low'
-)
+unless Workarea.config.skip_service_connections
+  Sidekiq::Cron::Job.create(
+    name: 'Workarea::SendReviewRequests',
+    klass: 'Workarea::SendReviewRequests',
+    cron: "0 0 * * * #{Time.zone.tzinfo.identifier}",
+    queue: 'low'
+  )
+end

data/config/locales/en.yml

@@ -15,12 +15,55 @@ en:
         marketing:
           reviews: Product reviews
       fields:
+        average_rating: Average Rating
         body: Body
         title: Title
         rating: Rating
+        reviews: Reviews
         approved: Approved
         auto_approve: Approve All Reviews
         verified: Verified Purchaser
+        verified_reviews: Verified
+        weighted_average_rating: Weighted Average Rating
+      insights:
+        most_active_reviewers:
+          info: Your customers that are submitting the most reviews.
+          reviews: Reviews
+          title: Most Active Reviewers
+          user: User
+          verified: Verified Reviews
+        most_reviewed_products:
+          title: Most Reviewed Products
+          info: Your products that have received the most reviews.
+          reviews:
+            one: '%{count} Review'
+            other: '%{count} Reviews'
+        top_rated_products:
+          title: Top Rated Products
+          info: Your products with the highest weighted average rating.
+          rating: '%{rating} Rating'
+      reports:
+        reference:
+          terms:
+            average_rating:
+              name: Average Rating
+              description: The sum of all review ratings divided by the total number of reviews.
+            reviews:
+              name: Reviews
+              description: The total number of reviews.
+            verified:
+              name: Verified
+              description: The total number of reviews made by customers who have purchased the product.
+            weighted_average_rating:
+              name: Weighted Average Rating
+              description: A base rating of 3.0, adjusted up or down by each review rating.
+        reviews_by_product:
+          filters:
+            all: All Reviews
+            approved: Approved Reviews
+            unapproved: Unapproved Reviews
+          results_filter: Results Filter
+          title: Reviews By Product
       reviews:
         approved: Approved
         catalog_products_cards:
@@ -66,6 +109,9 @@ en:
         review_request:
           subject: Review your recent purchase of %{product}
           link: Write a review
+          email_action:
+            name: Write Review
+            description: Please review your recent purchase
       fields:
         username: Username
       review_requests: