workarea-save_for_later 1.0.1 → 1.2.0

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

@@ -0,0 +1,11 @@
+module Workarea
+  decorate Admin::Dashboards::ReportsViewModel, with: :save_for_later do
+    def save_for_later_products
+      @save_for_later_products ||=
+        Admin::Reports::SaveForLaterProductsViewModel.wrap(
+          Workarea::Reports::SaveForLaterProducts.new(options),
+          options
+        )
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Workarea
+  module Admin
+    module Reports
+      class SaveForLaterProductsViewModel < 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/view_models/workarea/storefront/saved_list_view_model.rb

@@ -13,7 +13,6 @@ module Workarea
       def inventory
         @inventory ||= Inventory::Collection.new(model.items.map(&:sku))
       end
-
     end
   end
 end

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

@@ -0,0 +1,17 @@
+.grid__cell
+  .card{ class: card_classes(:save_for_later_products_report, local_assigns[:active]) }
+    = link_to save_for_later_products_report_path, class: 'card__header' do
+      %span.card__header-text= t('workarea.admin.reports.save_for_later_products.title')
+      = inline_svg 'workarea/admin/icons/insights.svg', class: 'card__icon'
+
+    .card__body
+      .card__centered-content
+        %table
+          %tbody
+            - dashboard.save_for_later_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 save_for_later_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_saved_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_saved_products.title')
+  .insight__body
+    %p.insight__note= t('workarea.admin.insights.most_saved_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_saved_products.times', count: result.adds)

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

@@ -0,0 +1,38 @@
+- @page_title = t('workarea.admin.reports.save_for_later_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.save_for_later_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 save_for_later_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/_save_for_later_button.html.haml

@@ -1,5 +1,5 @@
 .grid__cell
-  = form_tag saved_list_items_path, method: 'post', class: 'action-group__item', data: { analytics: save_for_later_analytics_data(item).to_json } do
+  = form_tag saved_list_items_path, method: 'post', class: 'action-group__item', data: { analytics: add_to_saved_list_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 :quantity, item.quantity, id: nil

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

@@ -24,6 +24,8 @@
                 = hidden_field_tag :sku, item.sku, id: nil
                 = hidden_field_tag :quantity, item.quantity, id: nil
                 = hidden_field_tag :saved_list_item_id, item.id, id: nil
+                = hidden_field_tag :via, current_saved_list.to_gid_param, id: nil
+
                 - if item.customizations.present?
                   - item.customizations.each do |key, value|
                     = hidden_field_tag key, value
@@ -32,7 +34,8 @@
                 - else
                   %p.unavailable= t('workarea.storefront.products.unavailable')
             .grid__cell
-              = link_to t('workarea.storefront.saved_lists.remove'), saved_list_item_path(item), data: { method: 'delete', confirm: t('workarea.storefront.saved_lists.confirm_remove') }
+              = form_tag saved_list_item_path(item), method: :delete, data: { deletion_form: { message: t('workarea.storefront.saved_lists.confirm_remove') }, analytics: remove_from_saved_list_analytics_data(item.product).to_json } do
+                = button_tag t('workarea.storefront.saved_lists.remove'), class: 'text-button'
 
         .product-list__item-cell
           %table.table

data/app/workers/workarea/save_order_metrics.decorator

@@ -0,0 +1,21 @@
+module Workarea
+  decorate SaveOrderMetrics, with: :save_for_later do
+    class_methods do
+      def save_catalog(metrics)
+        super
+
+        save_saved_lists(metrics)
+      end
+
+      def save_saved_lists(metrics)
+        metrics.products_from_saved_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/appends.rb

@@ -12,3 +12,13 @@ Workarea.append_stylesheets(
   'storefront.components',
   'workarea/storefront/save_for_later/components/product_prices'
 )
+
+Workarea.append_javascripts(
+  'storefront.modules',
+  'workarea/storefront/save_for_later/modules/saved_list_analytics'
+)
+
+Workarea.append_partials(
+  'admin.reports_dashboard',
+  'workarea/admin/dashboards/save_for_later_products_card'
+)

data/config/initializers/config.rb

@@ -1,3 +1,7 @@
 Workarea.configure do |config|
-  # Add custom configuration here
+  # How long to wait before clearing out old, anonymous saved list
+  # records. The default is 3 months, and this configures MongoDB's TTL
+  # for the collection. Indexes will need to be rebuilt if this option
+  # is changed.
+  config.saved_lists_expiration = 3.months
 end

data/config/locales/en.yml

@@ -1,5 +1,26 @@
 en:
   workarea:
+    admin:
+      fields:
+        adds: Adds
+        deletes: Deletes
+      insights:
+        most_saved_products:
+          title: Most Saved Products
+          info: Your products most frequently saved for later from the cart.
+          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
+        save_for_later_products:
+          title: Save For Later Products
     storefront:
       carts:
         save_for_later: Save for Later

data/config/routes.rb

@@ -1,5 +1,16 @@
 Workarea::Storefront::Engine.routes.draw do
   scope '(:locale)', constraints: Workarea::I18n.routes_constraint do
     resources :saved_list_items, only: [:create, :destroy]
+
+    post 'analytics/saved_list_add/:product_id', to: 'analytics#saved_list_add', as: :analytics_saved_list_add
+    post 'analytics/saved_list_remove/:product_id', to: 'analytics#saved_list_remove', as: :analytics_saved_list_remove
+  end
+end
+
+Workarea::Admin::Engine.routes.draw do
+  scope '(:locale)', constraints: Workarea::I18n.routes_constraint do
+    resource :report, only: [] do
+      get :save_for_later_products
+    end
   end
 end

data/lib/workarea/save_for_later/version.rb

@@ -1,5 +1,5 @@
 module Workarea
   module SaveForLater
-    VERSION = '1.0.1'.freeze
+    VERSION = '1.2.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/integration/workarea/storefront/current_saved_list_integration_test.rb

@@ -54,7 +54,7 @@ module Workarea
 
         assert_raises(Mongoid::Errors::DocumentNotFound) { list.reload }
 
-        list = SavedList.find(user.id.to_s)
+        list = SavedList.find_by(user_id: user.id.to_s)
         assert_equal(1, list.items.count)
       end
     end

data/test/models/workarea/insights/most_saved_products_test.rb

@@ -0,0 +1,63 @@
+require 'test_helper'
+
+module Workarea
+  module Insights
+    class MostSavedProductsTest < TestCase
+      setup :add_data, :time_travel
+
+      def add_data
+        Metrics::ProductByDay.inc(
+          key: { product_id: 'foo' },
+          at: Time.zone.local(2018, 10, 27),
+          saved_list_adds: 1
+        )
+
+        Metrics::ProductByDay.inc(
+          key: { product_id: 'foo' },
+          at: Time.zone.local(2018, 10, 28),
+          saved_list_adds: 2
+        )
+
+        Metrics::ProductByDay.inc(
+          key: { product_id: 'foo' },
+          at: Time.zone.local(2018, 10, 29),
+          saved_list_adds: 3
+        )
+
+        Metrics::ProductByDay.inc(
+          key: { product_id: 'bar' },
+          at: Time.zone.local(2018, 10, 27),
+          saved_list_adds: 3
+        )
+
+        Metrics::ProductByDay.inc(
+          key: { product_id: 'bar' },
+          at: Time.zone.local(2018, 10, 28),
+          saved_list_adds: 4
+        )
+
+        Metrics::ProductByDay.inc(
+          key: { product_id: 'bar' },
+          at: Time.zone.local(2018, 10, 29),
+          saved_list_adds: 5
+        )
+      end
+
+      def time_travel
+        travel_to Time.zone.local(2018, 11, 1)
+      end
+
+      def test_generate_monthly!
+        MostSavedProducts.generate_monthly!
+        assert_equal(1, MostSavedProducts.count)
+
+        saved_products = MostSavedProducts.first
+        assert_equal(2, saved_products.results.size)
+        assert_equal('bar', saved_products.results.first['product_id'])
+        assert_in_delta(12, saved_products.results.first['adds'])
+        assert_equal('foo', saved_products.results.second['product_id'])
+        assert_in_delta(6, saved_products.results.second['adds'])
+      end
+    end
+  end
+end

data/test/queries/workarea/reports/save_for_later_products_test.rb

@@ -0,0 +1,122 @@
+require 'test_helper'
+
+module Workarea
+  module Reports
+    class SaveForLaterProductsTest < TestCase
+      setup :add_data, :time_travel
+
+      def add_data
+        Metrics::ProductByDay.inc(
+          key: { product_id: 'foo' },
+          at: Time.zone.local(2018, 10, 27),
+          saved_list_units_sold: 2,
+          saved_list_revenue: 10.to_m,
+          saved_list_adds: 2,
+          saved_list_deletes: 1
+        )
+
+        Metrics::ProductByDay.inc(
+          key: { product_id: 'foo' },
+          at: Time.zone.local(2018, 10, 28),
+          saved_list_units_sold: 4,
+          saved_list_revenue: 15.to_m,
+          saved_list_adds: 1,
+          saved_list_deletes: 0
+        )
+
+        Metrics::ProductByDay.inc(
+          key: { product_id: 'foo' },
+          at: Time.zone.local(2018, 10, 29),
+          saved_list_units_sold: 6,
+          saved_list_revenue: 27.to_m,
+          saved_list_adds: 1,
+          saved_list_deletes: 1
+        )
+
+        Metrics::ProductByDay.inc(
+          key: { product_id: 'bar' },
+          at: Time.zone.local(2018, 10, 27),
+          saved_list_units_sold: 3,
+          saved_list_revenue: 11.to_m,
+          saved_list_adds: 2,
+          saved_list_deletes: 2
+        )
+
+        Metrics::ProductByDay.inc(
+          key: { product_id: 'bar' },
+          at: Time.zone.local(2018, 10, 28),
+          saved_list_units_sold: 5,
+          saved_list_revenue: 15.to_m,
+          saved_list_adds: 1,
+          saved_list_deletes: 1
+        )
+
+        Metrics::ProductByDay.inc(
+          key: { product_id: 'bar' },
+          at: Time.zone.local(2018, 10, 29),
+          saved_list_units_sold: 7,
+          saved_list_revenue: 27.to_m,
+          saved_list_adds: 0,
+          saved_list_deletes: 1
+        )
+      end
+
+      def time_travel
+        travel_to Time.zone.local(2018, 10, 30)
+      end
+
+      def test_grouping_and_summing
+        report = SaveForLaterProducts.new
+        assert_equal(2, report.results.length)
+
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(12, foo['units_sold'])
+        assert_equal(52, foo['revenue'])
+        assert_equal(4, foo['adds'])
+        assert_equal(2, foo['deletes'])
+
+        bar = report.results.detect { |r| r['_id'] == 'bar' }
+        assert_equal(15, bar['units_sold'])
+        assert_equal(53, bar['revenue'])
+        assert_equal(3, bar['adds'])
+        assert_equal(4, bar['deletes'])
+      end
+
+      def test_date_ranges
+        report = SaveForLaterProducts.new
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(4, foo['adds'])
+
+        report = SaveForLaterProducts.new(starts_at: '2018-10-28', ends_at: '2018-10-28')
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(1, foo['adds'])
+
+        report = SaveForLaterProducts.new(starts_at: '2018-10-28', ends_at: '2018-10-29')
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(2, foo['adds'])
+
+        report = SaveForLaterProducts.new(starts_at: '2018-10-28')
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(2, foo['adds'])
+
+        report = SaveForLaterProducts.new(ends_at: '2018-10-28')
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(3, foo['adds'])
+      end
+
+      def test_sorting
+        report = SaveForLaterProducts.new(sort_by: 'adds', sort_direction: 'asc')
+        assert_equal('bar', report.results.first['_id'])
+
+        report = SaveForLaterProducts.new(sort_by: 'adds', sort_direction: 'desc')
+        assert_equal('foo', report.results.first['_id'])
+
+        report = SaveForLaterProducts.new(sort_by: 'units_sold', sort_direction: 'asc')
+        assert_equal('foo', report.results.first['_id'])
+
+        report = SaveForLaterProducts.new(sort_by: 'units_sold', sort_direction: 'desc')
+        assert_equal('bar', report.results.first['_id'])
+      end
+    end
+  end
+end