workarea-wish_lists 3.0.5 → 3.1.0

data/app/seeds/workarea/wish_list_seeds.rb

@@ -13,9 +13,20 @@ module Workarea
           next unless sku
           wish_list.add_item(product.id, sku, quantity)
 
+          Metrics::ProductByDay.inc(
+            key: { product_id: product.id },
+            wish_list_adds: 1
+          )
+
           if rand(2).zero?
             purchased_quantity = rand(quantity) + 1
             wish_list.mark_item_purchased(sku, purchased_quantity)
+
+            Metrics::ProductByDay.inc(
+              key: { product_id: product.id },
+              wish_list_units_sold: purchased_quantity,
+              wish_list_revenue: rand(10000) / 100.0
+            )
           end
         end
       end

data/app/services/workarea/wish_list_session.rb

@@ -2,11 +2,11 @@ module Workarea
   # WishListSession is responsible for storing a representation of a product that will later be added to a user's Wish List.
   #
   class WishListSession
-    attr_reader :session
+    attr_reader :cookies
 
-    # @param [Hash] user's Session
-    def initialize(session)
-      @session = session
+    # @param [Hash] user's cookies
+    def initialize(cookies)
+      @cookies = cookies
     end
 
     # Store a form-posted representation of a Wish List Item. This would include the product_id, sku and quantity of that item.
@@ -16,20 +16,20 @@ module Workarea
     # @return [void]
     def store_item(params)
       collection_keys.each do |key|
-        session["wish_list_#{key}"] = params[key] if params[key].present?
+        cookies["wish_list_#{key}"] = params[key] if params[key].present?
       end
     end
 
-    # Add the current item in the session to a the given wish list.
+    # Add the current item in the cookies to a the given wish list.
     #
     # @param [WishList]
     #
     # @return [void]
     def add_item(wish_list)
-      product_id = session['wish_list_product_id']
-      sku = session['wish_list_sku']
-      quantity = session['wish_list_quantity']
-      customizations = session['wish_list_customizations']
+      product_id = cookies['wish_list_product_id']
+      sku = cookies['wish_list_sku']
+      quantity = cookies['wish_list_quantity']
+      customizations = cookies['wish_list_customizations']
 
       wish_list.add_item(
         product_id,
@@ -40,7 +40,7 @@ module Workarea
       )
 
       collection_keys.each do |key|
-        session.delete("wish_list_#{key}")
+        cookies.delete("wish_list_#{key}")
       end
     end
 

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

@@ -0,0 +1,10 @@
+module Workarea
+  decorate Admin::Dashboards::ReportsViewModel, with: :wish_lists do
+    def wish_list_products
+      @wish_list_products ||= Admin::Reports::WishListProductsViewModel.wrap(
+        Workarea::Reports::WishListProducts.new(options),
+        options
+      )
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Workarea
+  module Admin
+    module Reports
+      class WishListProductsViewModel < ApplicationViewModel
+        def results
+          @results ||= model.results.map do |result|
+            product = products.detect { |p| p.id == result['_id'] }
+            OpenStruct.new({ product: product }.merge(result))
+          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/views/workarea/admin/dashboards/_wish_list_products_card.html.haml

@@ -0,0 +1,17 @@
+.grid__cell
+  .card{ class: card_classes(:wish_list_products_report, local_assigns[:active]) }
+    = link_to wish_list_products_report_path, class: 'card__header' do
+      %span.card__header-text= t('workarea.admin.reports.wish_list_products.title')
+      = inline_svg 'workarea/admin/icons/insights.svg', class: 'card__icon'
+
+    .card__body
+      .card__centered-content
+        %table
+          %tbody
+            - dashboard.wish_list_products.results.take(4).each do |result|
+              %tr
+                %td= result.product.present? ? result.product.name : result._id
+                %td.align-right= number_to_currency(result.revenue)
+
+        = link_to wish_list_products_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_wish_listed_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_wish_listed_products.title')
+  .insight__body
+    %p.insight__note= t('workarea.admin.insights.most_wish_listed_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_wish_listed_products.times', count: result.adds)

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

@@ -0,0 +1,38 @@
+- @page_title = t('workarea.admin.reports.wish_list_products.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.wish_list_products.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 wish_list_products_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__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.adds'), report: @report, sort_by: 'adds'
+          %th.align-center= link_to_reports_sorting t('workarea.admin.fields.deletes'), report: @report, sort_by: 'deletes'
+          %th.align-center= link_to_reports_sorting t('workarea.admin.fields.units_sold'), report: @report, sort_by: 'units_sold'
+          %th.align-right= link_to_reports_sorting t('workarea.admin.fields.revenue'), report: @report, sort_by: 'revenue'
+      %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.adds
+            %td.align-center= number_with_delimiter result.deletes
+            %td.align-center= number_with_delimiter result.units_sold
+            %td.align-right= number_to_currency(result.revenue)

data/app/views/workarea/storefront/carts/_move_to_wish_list.html.haml

@@ -1,4 +1,4 @@
 .grid__cell
   = form_tag from_cart_users_wish_list_path(item), method: 'post' do
     = hidden_field_tag :return_to, users_wish_list_path, id: "wishlist_return_to_#{dom_id(item)}"
-    %p= button_tag t('workarea.storefront.wish_lists.move_to_wish_list'), value: 'move_to_wish_list', class: 'text-button'
+    %p= button_tag t('workarea.storefront.wish_lists.move_to_wish_list'), value: 'move_to_wish_list', class: 'text-button', data: { analytics: add_to_wish_list_analytics_data(item.product).to_json }

data/app/views/workarea/storefront/pages/_wish_lists_robots.text.erb

@@ -0,0 +1 @@
+Disallow: /wish_lists

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

@@ -1,4 +1,4 @@
 .wish-list-button
   - if product.purchasable?
-    = link_to users_wish_list_path, class: 'wish-list-button__link text-button', data: { wish_list_button: '' } do
+    = link_to users_wish_list_path, class: 'wish-list-button__link text-button', data: { wish_list_button: '', analytics: add_to_wish_list_analytics_data(product).to_json } do
       = t('workarea.storefront.wish_lists.add_to_wish_list')

data/app/views/workarea/storefront/users/accounts/_wish_list_summary.html.haml

@@ -8,8 +8,10 @@
         - if user.wish_list_items.any?
           .grid
             - user.wish_list_items.each do |item|
+              = render_schema_org(product_schema(item.product))
+
               .grid__cell.grid__cell--50.grid__cell--25-at-medium.grid__cell--20-at-wide
-                .product-summary.product-summary--small{ itemscope: true, itemtype: 'http://schema.org/Product' }
+                .product-summary.product-summary--small
                   = render 'workarea/storefront/products/summary', product: item.product
         - else
           %p= t('workarea.storefront.wish_lists.empty.message', state: t('workarea.storefront.wish_lists.empty.states.unpurchased'))

data/app/views/workarea/storefront/users/wish_lists/show.html.haml

@@ -1,12 +1,14 @@
 - @title = t('workarea.storefront.wish_lists.wish_list_title')
 
+= render_schema_org(breadcrumb_list_schema([[t('workarea.storefront.layouts.home'), root_url], [t('workarea.storefront.users.account'), users_account_url], [t('workarea.storefront.wish_lists.wish_list_title'), wish_lists_url]]))
+
 - content_for :breadcrumbs do
   %p.breadcrumbs__node-group
-    %span.breadcrumbs__node{ itemprop: 'breadcrumb' }
+    %span.breadcrumbs__node
       = link_to t('workarea.storefront.layouts.home'), root_path, rel: 'home'
-    %span.breadcrumbs__node{ itemprop: 'breadcrumb' }
+    %span.breadcrumbs__node
       = link_to t('workarea.storefront.users.account'), users_account_path
-    %span.breadcrumbs__node{ itemprop: 'breadcrumb' }= t('workarea.storefront.wish_lists.wish_list_title')
+    %span.breadcrumbs__node= t('workarea.storefront.wish_lists.wish_list_title')
 
 .wish-lists.view
 
@@ -55,6 +57,8 @@
 
       %ul.product-list
         - @wish_list.items.each do |item|
+          = render_schema_org(product_schema(item.product))
+
           %li.product-list__item
             .product-list__item-cell
               .product-list__summary
@@ -114,12 +118,13 @@
                     = form_tag cart_items_path, data: { dialog_form: { dialogOptions: { closeAll: true, initModules: true } }, analytics: add_to_cart_analytics_data(item.product).to_json } do
                       = hidden_field_tag :sku, item.sku, id: nil
                       = hidden_field_tag :quantity, item.quantity, id: nil
+                      = hidden_field_tag :via, @wish_list.to_gid_param, id: nil
                       - item.customizations.each do |param, value|
                         = hidden_field_tag param, value, id: nil
                       %p= button_tag t('workarea.storefront.products.add_to_cart'), value: 'add_to_cart', class: 'button'
                   - else
                     %p.unavailable= t('workarea.storefront.products.unavailable')
                 .grid__cell
-                  = form_tag remove_from_users_wish_list_path, method: 'delete' do
+                  = form_tag remove_from_users_wish_list_path, method: 'delete', data: { analytics: remove_from_wish_list_analytics_data(item.product).to_json } do
                     = hidden_field_tag :sku, item.sku, id: nil
                     %p= button_tag t('workarea.storefront.carts.remove'), value: 'remove_item', class: 'text-button'

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

@@ -1,12 +1,14 @@
 - @title = t('workarea.storefront.wish_lists.show_title', name: @wish_list.name)
 
+= render_schema_org(breadcrumb_list_schema([[t('workarea.storefront.layouts.home'), root_path], [t('workarea.storefront.wish_lists.find_title'), wish_lists_path], [@wish_list.name, wish_list_path(@wish_list)]]))
+
 - content_for :breadcrumbs do
   %p.breadcrumbs__node-group
-    %span.breadcrumbs__node{ itemprop: 'breadcrumb' }
+    %span.breadcrumbs__node
       = link_to t('workarea.storefront.layouts.home'), root_path, rel: 'home'
-    %span.breadcrumbs__node{ itemprop: 'breadcrumb' }
+    %span.breadcrumbs__node
       = link_to t('workarea.storefront.wish_lists.find_title'), wish_lists_path
-    %span.breadcrumbs__node{ itemprop: 'breadcrumb' }= t('workarea.storefront.wish_lists.show_title', name: @wish_list.name)
+    %span.breadcrumbs__node= t('workarea.storefront.wish_lists.show_title', name: @wish_list.name)
 
 .wish-lists.view
 
@@ -30,6 +32,8 @@
 
       %ul.product-list
         - @wish_list.items.each do |item|
+          = render_schema_org(product_schema(item.product))
+
           %li.product-list__item
             .product-list__item-cell
               .product-list__summary
@@ -47,6 +51,7 @@
             = form_tag cart_items_path, class: 'product-list__item-cell', data: { dialog_form: { dialogOptions: { closeAll: true, initModules: true } }, analytics: add_to_cart_analytics_data(item.product).to_json } do
               = hidden_field_tag :product_id, item.product_id, id: nil
               = hidden_field_tag :sku, item.sku, id: nil
+              = hidden_field_tag :via, @wish_list.to_gid_param, id: nil
               - item.customizations.each do |param, value|
                 = hidden_field_tag param, value, id: nil
               %table.table

data/app/workers/workarea/save_order_metrics.decorator

@@ -0,0 +1,21 @@
+module Workarea
+  decorate SaveOrderMetrics, with: :wish_lists do
+    class_methods do
+      def save_catalog(metrics)
+        super
+
+        save_wish_lists(metrics)
+      end
+
+      def save_wish_lists(metrics)
+        metrics.products_from_wish_lists.each do |product_id, data|
+          Metrics::ProductByDay.inc(
+            key: { product_id: product_id },
+            at: metrics.placed_at,
+            **data
+          )
+        end
+      end
+    end
+  end
+end

data/config/initializers/append_points.rb

@@ -12,7 +12,8 @@ Workarea.append_javascripts(
 Workarea.append_javascripts(
   'storefront.modules',
   'workarea/storefront/wish_lists/modules/wish_list_button',
-  'workarea/storefront/wish_lists/modules/wish_list_public_quantity_fields'
+  'workarea/storefront/wish_lists/modules/wish_list_public_quantity_fields',
+  'workarea/storefront/wish_lists/modules/wish_list_analytics'
 )
 
 Workarea.append_partials(
@@ -40,7 +41,17 @@ Workarea.append_partials(
   'workarea/storefront/wish_lists/wish_lists_link'
 )
 
+Workarea.append_partials(
+  'storefront.robots_txt',
+  'workarea/storefront/pages/wish_lists_robots'
+)
+
 Workarea.append_partials(
   'admin.user_cards',
   'workarea/admin/users/wish_list_card'
 )
+
+Workarea.append_partials(
+  'admin.reports_dashboard',
+  'workarea/admin/dashboards/wish_list_products_card'
+)

data/config/locales/en.yml

@@ -19,6 +19,26 @@ en:
           state: State
           title: Wish list for %{user}
           title_html: Wish list for %{user}
+      fields:
+        adds: Adds
+        deletes: Deletes
+      insights:
+        most_wish_listed_products:
+          title: Most Wish Listed Products
+          info: Your products most frequently added to a wish list.
+          times:
+            one: '%{count} time'
+            other: '%{count} times'
+      reports:
+        reference:
+          adds:
+            name: Adds
+            description: The total number of items added to a list.
+          deletes:
+            name: Deletes
+            description: The total number of items deleted from a list
+        wish_list_products:
+          title: Wish List Products
     storefront:
       flash_messages:
         item_moved_to_wish_list: This item has been moved to your wish list

data/config/routes.rb

@@ -3,6 +3,10 @@ Workarea::Admin::Engine.routes.draw do
     resources :users, only: [] do
       get :wish_list
     end
+
+    resource :report, only: [] do
+      get :wish_list_products
+    end
   end
 end
 
@@ -19,5 +23,8 @@ Workarea::Storefront::Engine.routes.draw do
         delete 'remove_item', as: :remove_from
       end
     end
+
+    post 'analytics/wish_list_add/:product_id', to: 'analytics#wish_list_add', as: :analytics_wish_list_add
+    post 'analytics/wish_list_remove/:product_id', to: 'analytics#wish_list_remove', as: :analytics_wish_list_remove
   end
 end

data/lib/workarea/wish_lists/engine.rb

@@ -10,6 +10,12 @@ module Workarea
              .action_dispatch
              .rescue_responses['Workarea::WishList::InvalidToken'] = :not_found
       end
+
+      config.to_prepare do
+        Workarea::Storefront::ApplicationController.helper(
+          Workarea::Storefront::WishListAnalyticsHelper
+        )
+      end
     end
   end
 end

data/lib/workarea/wish_lists/version.rb

@@ -1,5 +1,5 @@
 module Workarea
   module WishLists
-    VERSION = '3.0.5'.freeze
+    VERSION = '3.1.0'.freeze
   end
 end

data/package.json

@@ -0,0 +1,9 @@
+{
+  "devDependencies": {
+    "eslint": "~5.16.0",
+    "eslint-config-recommended": "~4.0.0",
+    "stylelint": "~10.1.0",
+    "stylelint-config-recommended-scss": "~3.3.0",
+    "stylelint-scss": "~3.9.2"
+  }
+}

data/test/dummy/config/initializers/session_store.rb

@@ -1,3 +1,5 @@
 # Be sure to restart your server when you modify this file.
 
-Rails.application.config.session_store :cookie_store, key: '_dummy_session'
+Rails.application.config.session_store :cookie_store,
+                                       key: '_dummy_session',
+                                       expire_after: 30.minutes

data/test/integration/workarea/storefront/wish_lists_integration_test.rb

@@ -194,7 +194,7 @@ module Workarea
 
         assert_redirected_to(storefront.login_path)
         refute_empty(order.reload.items)
-        assert_equal(item.id.to_s, session[:wish_list_item_id])
+        assert(cookies[:wish_list_item_id].present?)
 
         login
 
@@ -203,7 +203,7 @@ module Workarea
         follow_redirect!
 
         assert_response(:success)
-        refute(session.key?(:wish_list_item_id))
+        assert(cookies[:wish_list_item_id].blank?)
         assert_empty(order.reload.items)
       end
     end