workarea-reviews 3.1.0

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/admin/review_view_model.rb

@@ -0,0 +1,23 @@
+module Workarea
+  module Admin
+    class ReviewViewModel < ApplicationViewModel
+      delegate :primary_image, to: :product, allow_nil: true
+
+      def name
+        if product.present?
+          t('workarea.admin.reviews.index.review_for', product: product.name)
+        else
+          t('workarea.admin.reviews.index.review')
+        end
+      end
+
+      def product
+        @product ||=
+          options[:product] ||
+          ProductViewModel.wrap(Catalog::Product.find(product_id))
+      rescue Mongoid::Errors::DocumentNotFound
+        nil
+      end
+    end
+  end
+end

data/app/view_models/workarea/admin/reviews_search_view_model.rb

@@ -0,0 +1,46 @@
+module Workarea
+  module Admin
+    class ReviewsSearchViewModel < SearchViewModel
+      def results
+        @results ||= PagedArray.from(
+          persisted_results.map do |review|
+            ReviewViewModel.new(
+              review,
+              product: products.detect { |p| p.id.to_s == review.product_id.to_s }
+            )
+          end,
+          model.results.page,
+          model.results.per_page,
+          total
+        )
+      end
+
+      def sort
+        if options[:sort] == Sort.highest_rating.to_s
+          Sort.highest_rating.to_s
+        elsif options[:sort] == Sort.lowest_rating.to_s
+          Sort.lowest_rating.to_s
+        else
+          super
+        end
+      end
+
+      def sorts
+        super + [
+          Sort.highest_rating.to_a,
+          Sort.lowest_rating.to_a
+        ]
+      end
+
+      private
+
+      def products
+        @products ||= ProductViewModel.wrap(
+          Catalog::Product
+            .any_in(id: persisted_results.map(&:product_id))
+            .map { |product| Admin::ProductViewModel.new(product) }
+        )
+      end
+    end
+  end
+end

data/app/view_models/workarea/storefront/product_view_model.decorator

@@ -0,0 +1,13 @@
+module Workarea
+  decorate Storefront::ProductViewModel, with: :reviews do
+    def has_reviews?
+      total_reviews > 0
+    end
+
+    def reviews
+      @reviews ||= Review
+        .find_for_product(model.id)
+        .order(created_at: :desc)
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Workarea
+  module Storefront
+    class ReviewViewModel < ApplicationViewModel
+      def requires_public_info?
+        anonymous? || user.public_info.blank?
+      end
+
+      def user
+        return if anonymous?
+        @user ||= User.find(user_id)
+      end
+    end
+  end
+end

data/app/views/workarea/admin/activities/_review_create.html.haml

@@ -0,0 +1,12 @@
+.activity
+  .activity__header
+    .activity__avatar
+      = link_to_modifier(entry) do
+        = avatar_for entry.modifier
+    %h3.activity__name= link_to_modifier(entry)
+    %p.activity__time= activity_time(entry.created_at)
+  .activity__message
+    - if entry.audited.present?
+      = t('workarea.admin.activities.review_create_html', name: link_to(t('workarea.admin.activities.review'), edit_review_path(entry.audited)))
+    - else
+      = t('workarea.admin.activities.review_create_html', name: t('workarea.admin.activities.review'))

data/app/views/workarea/admin/activities/_review_destroy.html.haml

@@ -0,0 +1,10 @@
+.activity
+  .activity__header
+    .activity__avatar
+      = link_to_modifier(entry) do
+        = avatar_for entry.modifier
+    %h3.activity__name= link_to_modifier(entry)
+    %p.activity__time= activity_time(entry.created_at)
+  .activity__message
+    = t('workarea.admin.activities.review_destroy_html', name: entry.model_attributes['title'])
+    = link_to_restore_for(entry)

data/app/views/workarea/admin/activities/_review_update.html.haml

@@ -0,0 +1,10 @@
+.activity
+  .activity__header
+    .activity__avatar
+      = link_to_modifier(entry) do
+        = avatar_for entry.modifier
+    %h3.activity__name= link_to_modifier(entry)
+    %p.activity__time= activity_time(entry.created_at)
+  .activity__message
+    - name = entry.audited.blank? ? entry.model_attributes['title'] : link_to(entry.model_attributes['title'], edit_review_path(entry.audited))
+    = t('workarea.admin.activities.review_update_html', fields: fields_clause_for(entry.tracked_changes), name: name)

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/admin/reviews/_aux_navigation.html.haml

@@ -0,0 +1,5 @@
+.grid.grid--auto.grid--right.grid--middle
+  - if model.product.present?
+    .grid__cell= link_to t('workarea.admin.reviews.edit.view_product'), catalog_product_path(model.product)
+  - unless model.anonymous?
+    .grid__cell= link_to t('workarea.admin.reviews.edit.view_user'), user_path(model.user_id)

data/app/views/workarea/admin/reviews/_catalog_products_aux_link.html.haml

@@ -0,0 +1,5 @@
+.grid__cell
+  = link_to reviews_path(q: %{"#{model.id}"}, sort: 'newest') do
+    = t('workarea.admin.catalog_products.reviews_link')
+    - if model.pending_reviews_count > 0
+      = t('workarea.admin.catalog_products.pending', pending: model.pending_reviews_count)

data/app/views/workarea/admin/reviews/_dashboard_navigation.html.haml

@@ -0,0 +1 @@
+%li= link_to t('workarea.admin.dashboards.marketing.reviews'), reviews_path, class: 'dashboard__navigation-link'

data/app/views/workarea/admin/reviews/_menu.html.haml

@@ -0,0 +1,3 @@
+%li{ class: "primary-nav__item" }
+  = link_to reviews_path, class: navigation_link_classes(reviews_path) do
+    = t('workarea.admin.reviews.menu.product_reviews', count: Workarea::Review.pending.count)

data/app/views/workarea/admin/reviews/_summary.html.haml

@@ -0,0 +1,12 @@
+= link_to edit_review_path(model), class: 'summary', data: { global_id: model.to_global_id.to_param } do
+  .summary__image-container
+    = image_tag(product_image_url(model.primary_image, :medium), alt: model.name, class: 'summary__image') if model.primary_image.present?
+  %span.summary__name= model.name
+  .summary__info-container
+    %span.summary__info= local_time_ago(model.updated_at)
+    %span.summary__info
+      - if model.approved
+        = t('workarea.admin.reviews.approved')
+      - else
+        = t('workarea.admin.reviews.pending')
+  %span.summary__type= t('workarea.admin.reviews.summary.type')

data/app/views/workarea/admin/reviews/edit.html.haml

@@ -0,0 +1,77 @@
+- @page_title = @review.name
+
+.view
+  .view__header
+    .grid.grid--middle.grid--right
+      .grid__cell.grid__cell--50
+        .view__heading
+          = link_to_index_for(@review)
+          %h1= @review.name
+      .grid__cell.grid__cell--25
+        = render_aux_navigation_for(@review)
+
+  .view__container.view__container--narrow
+    - @review.errors.full_messages.each do |message|
+      = render_message 'error', message
+
+    = form_tag review_path(@review), method: :patch, id: 'sku_form' do
+      .section
+        .grid.grid--huge.grid--middle
+          .grid__cell.grid__cell--50-at-medium
+            .property
+              = label_tag 'review_title', t('workarea.admin.fields.title'), class: 'property__name'
+              = text_field_tag 'review[title]', @review.title, class: 'text-box'
+
+          .grid__cell.grid__cell--50-at-medium
+            .grid.grid--right.grid--auto
+              .grid__cell
+                .property
+                  %span.property__name= t('workarea.admin.reviews.approved')
+                  = toggle_button_for 'review[approved]', @review.approved
+
+        .property
+          = label_tag 'review_body', t('workarea.admin.fields.body'), class: 'property__name'
+          = text_area_tag 'review[body]', @review.body, class: 'text-box text-box--multi-line'
+
+        .grid.grid--huge
+          .grid__cell.grid__cell--50.grid__cell--25-at-medium
+            .property
+              = label_tag 'review_rating', t('workarea.admin.fields.rating'), class: 'property__name'
+              = @review.rating
+          .grid__cell.grid__cell--50.grid__cell--25-at-medium
+            .property
+              = label_tag 'verified', t('workarea.admin.fields.verified'), class: 'property__name'
+              = t("workarea.admin.#{@review.verified?}")
+          .grid__cell.grid__cell--50.grid__cell--25-at-medium
+            .property
+              = label_tag 'review_updated_at', t('workarea.admin.fields.updated_at'), class: 'property__name'
+              = local_time(@review.updated_at)
+          .grid__cell.grid__cell--50.grid__cell--25-at-medium
+            .property
+              = label_tag 'review_created_at', t('workarea.admin.fields.created_at'), class: 'property__name'
+              = local_time(@review.created_at)
+
+          .grid__cell.grid__cell--50.grid__cell--25-at-medium
+            .property
+              = label_tag 'review_product_id', t('workarea.admin.fields.product_id'), class: 'property__name'
+              - if @review.product.nil?
+                = @review.product_id
+              - else
+                = link_to @review.product_id, catalog_product_path(@review.product)
+          - if @review.anonymous?
+            .grid__cell.grid__cell--50.grid__cell--25-at-medium
+              .property
+                = label_tag 'review_name', t('workarea.admin.fields.name'), class: 'property__name'
+                = [@review.first_name, @review.last_name].join(' ')
+            .grid__cell.grid__cell--50.grid__cell--25-at-medium
+              .property
+                = label_tag 'review_email', t('workarea.admin.fields.email'), class: 'property__name'
+                = @review.email.presence || '--'
+
+
+      .workflow-bar
+        .grid.grid--middle
+          .grid__cell.grid__cell--50
+            = link_to t('workarea.admin.actions.delete'), review_path(@review), data: { method: 'delete', confirm: t('workarea.admin.actions.delete_confirmation')}, class: 'workflow-bar__button workflow-bar__button--delete'
+          .grid__cell.grid__cell--50.align-right
+            .grid__cell= button_tag t('workarea.admin.reviews.edit.save_review'), value: 'save_review', class: 'workflow-bar__button workflow-bar__button--update'

data/app/views/workarea/admin/reviews/index.html.haml

@@ -0,0 +1,74 @@
+- @page_title = t('workarea.admin.reviews.index.page_title')
+
+.view
+  .view__header
+    .grid.grid--middle.grid--center
+      .grid__cell.grid__cell--50
+        .view__heading
+          = link_to "↑ #{t('workarea.admin.reviews.index.dashboard_link')}", marketing_dashboards_path, class: 'view__dashboard-button'
+          %h1= t('workarea.admin.reviews.index.heading')
+
+  .view__container
+    .browsing-controls.browsing-controls--with-divider.browsing-controls--center{ class: ('browsing-controls--filters-displayed' unless @search.toggle_facets?) }
+      = form_tag reviews_path, method: 'get', id: 'review_sort_form' do
+        = facet_hidden_inputs(@search.facets)
+        .browsing-controls__sort
+          .property.property--inline
+            = label_tag 'sort', t('workarea.admin.search.sort_by'), class: 'property__name'
+            = select_tag :sort, options_for_select(@search.sorts, selected: @search.sort), data: { form_submitting_control: '' }
+
+        .browsing-controls__search
+          .search-form
+            = text_field_tag :q, params[:q], class: 'search-form__input', id: 'search_products', title: t('workarea.admin.search.keywords'), placeholder: t('workarea.admin.search.keywords')
+            = submit_tag 'search_orders', class: 'search-form__button'
+
+        = render 'workarea/admin/shared/creation_date', search: @search, form_path: reviews_path
+
+        - if @search.facets.present?
+          - @search.facets.each do |facet|
+            = render "workarea/admin/facets/#{facet.type}", facet: facet
+
+        - if @search.toggle_facets?
+          .browsing-controls__toggle-filters
+            %button.text-button{ type: 'button', data: { toggle_filters: '' } }= t('workarea.admin.search.show_filters')
+
+      = render 'workarea/admin/facets/applied', search: @search, reset_path: reviews_path
+
+      %p.browsing-controls__count= pluralize(@search.total, 'Reviews')
+
+    - if @search.results.any?
+      %table.index-table
+        %thead
+          %tr
+            %th.index-table__control-cell
+              .checkbox
+                = check_box_tag 'select_all', nil, false, id: 'select_all', class: 'checkbox__input', data: { bulk_action_select_all: '' }
+                = label_tag 'select_all', t('workarea.admin.bulk_actions.select_all'), class: 'checkbox__label'
+            %th= t('workarea.admin.fields.name')
+            %th= t('workarea.admin.fields.title')
+            %th.align-center= t('workarea.admin.fields.rating')
+            %th.align-center= t('workarea.admin.fields.approved')
+            %th.align-center= t('workarea.admin.fields.verified')
+            %th= t('workarea.admin.fields.created_at')
+
+        %tbody
+          - @search.results.each do |result|
+            %tr.index-table__row
+              %td.index-table__control-cell
+                .checkbox
+                  = check_box_tag 'global_id', result.to_gid_param, false, class: 'checkbox__input', id: dom_id(result), data: { bulk_action_item: '' }
+                  = label_tag dom_id(result), '', class: 'checkbox__label', title: t('workarea.admin.bulk_actions.add_summary_button')
+              %td= link_to result.name, edit_review_path(result)
+              %td= result.title
+              %td.align-center= result.rating
+              %td.align-center= t("workarea.admin.#{result.approved}")
+              %td.align-center= t("workarea.admin.#{result.verified}")
+              %td= local_time_ago(result.created_at)
+
+      - if @search.results.total_pages > 1
+        = render 'workarea/admin/shared/pagination', collection: @search.results
+
+    .workflow-bar
+      .grid
+        .grid__cell.grid__cell--50
+          = render 'workarea/admin/shared/bulk_actions', klass: Workarea::Review, search: @search