workarea-reviews 3.0.10

data/app/queries/workarea/search/category_browse.decorator

@@ -0,0 +1,9 @@
+module Workarea
+  decorate Search::CategoryBrowse, with: :reviews do
+    class_methods do
+      def available_sorts
+        super.tap { |sorts|  sorts << Sort.top_rated }
+      end
+    end
+  end
+end

data/app/queries/workarea/search/product_search.decorator

@@ -0,0 +1,9 @@
+module Workarea
+  decorate Search::ProductSearch, with: :reviews do
+    class_methods do
+      def available_sorts
+        super.tap { |sorts|  sorts << Sort.top_rated }
+      end
+    end
+  end
+end

data/app/seeds/review_seeds.rb

@@ -0,0 +1,49 @@
+module Workarea
+  class ReviewSeeds
+    def perform
+      puts 'Adding reviews...'
+
+      Sidekiq::Callbacks.disable do
+        create_reviews_for_catalog
+        create_review_request_email_content
+      end
+    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.new(
+        product_id: product.id,
+        user_id: BSON::ObjectId.new,
+        rating: rand(5) + 1,
+        title: Faker::Lorem.sentence,
+        body: Faker::Lorem.paragraph,
+        approved: [true, false].sample,
+        user_info: Faker::Internet.user_name,
+        verified: [true, false].sample,
+        created_at: rand(45).days.ago,
+        updated_at: Time.current
+      )
+    end
+
+    def create_review_request_email_content
+      Content::Email.create!(
+        type: 'review_request',
+        content: <<~HTML
+          <h1>Let us know what you think!</h1>
+          <p>Your feedback is important to us.</p>
+        HTML
+      )
+    end
+  end
+end

data/app/services/workarea/create_review.rb

@@ -0,0 +1,99 @@
+module Workarea
+  class CreateReview
+    include ActiveModel::Validations
+
+    validate :valid_review
+    validates :first_name, :last_name, presence: true
+
+    attr_reader :review, :user, :params
+
+    def self.for(product: nil, user: nil, params: {})
+      review = Review.new(
+        product_id: product.try(:id),
+        user_id: user.try(:id)
+      )
+
+      new(review, user: user, params: params)
+    end
+
+    def initialize(review, user: nil, params: {})
+      @review = review
+      @user = user
+      @params = params
+    end
+
+    def save
+      update_user_attributes
+      update_attributes
+
+      return false unless valid?
+      review.save.tap { |result| update_review_requests if result }
+    end
+
+    def verified?
+      user_order_ids_with_product.any?
+    end
+
+    private
+
+    def user_order_ids_with_product
+      return [] unless user.present?
+
+      @user_users_with_product ||=
+        Order.placed
+             .where(user_id: user.id.to_s)
+             .where('items.product_id' => review.product_id)
+             .pluck(:id)
+    end
+
+    def update_user_attributes
+      return if !user.present? || user.public_info.present?
+      user.update_attributes(params.slice(:first_name, :last_name))
+    end
+
+    def update_attributes
+      review.assign_attributes(
+        params
+          .slice(:rating, :body, :title)
+          .merge(
+            user_info: user_info,
+            first_name: first_name,
+            last_name: last_name,
+            email: email,
+            verified: verified?
+          )
+      )
+    end
+
+    def update_review_requests
+      return unless user_order_ids_with_product.any?
+      Review::Request.cancel_for_orders!(user_order_ids_with_product)
+    end
+
+    def user_info
+      return user.public_info if user&.public_info.present?
+
+      "#{first_name&.first} #{last_name&.first}".strip
+    end
+
+    def first_name
+      params[:first_name].presence || user&.first_name
+    end
+
+    def last_name
+      params[:last_name].presence || user&.last_name
+    end
+
+    def email
+      params[:email].presence || user&.email
+    end
+
+    def valid_review
+      unless review.valid?
+        review.errors.each do |attr, error|
+          errors.add(attr, error)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Workarea
+  decorate Admin::ProductViewModel, with: :reviews do
+    def pending_reviews_count
+      Review.pending.where(product_id: model.id).count
+    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/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