workarea-save_for_later 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bab92923c6b1840e8967b23fc09880497fd6e61a6c790672bd0b42e0cc89057
-  data.tar.gz: f2cbe6190d8efafdabb2df3e48a4c4b87c77a95bf55a47a1496e94eceb2d2f42
+  metadata.gz: 3569051f8611040d8cc0eebad53a149062b5613136c7ccd35dec1d912e7fc055
+  data.tar.gz: 16cca8449ab063bb6b54c83f03d6da4d738768afaeaf6f0e0a35ff01838efaf2
 SHA512:
-  metadata.gz: 79633fce99eaf90f567d5233cef2c1220098ebfa1d19a134b169b2b895d6e6258630ee9d6f2ffda34126d949f8f70ca227c0373917038302eec722efc8e0c565
-  data.tar.gz: d688d251695fcf80c0912537b9e774f18fd767941505bb95f66be2898386dfec703ff15624dfa75cf329eb6fdbdd65f26df84e26f45211e4f3259e379678c171
+  metadata.gz: 419afeabf7b6908b740aa826349789aabe9f35ecdd53ac8f3f2242564b4799a21c396538818dfaf2d561e03930b39a887f0492bf18a429832276f7ef83b0c1cd
+  data.tar.gz: 9ed1b62784231a7983bd681bf4c08b44e3189830caf155921e10baf226de8ecdf130b6962e85ffb728a1f3cd5663da3f547d45b40f936a89915f41255aa3dca5

data/.eslintrc.json

@@ -0,0 +1,35 @@
+{
+    "extends": "eslint:recommended",
+    "rules": {
+      "semi": ["error", "always"],
+      "eqeqeq": ["error", "always"]
+    },
+    "globals": {
+      "window": true,
+      "document": true,
+      "WORKAREA": true,
+      "$": true,
+      "jQuery": true,
+      "_": true,
+      "feature": true,
+      "JST": true,
+      "Turbolinks": true,
+      "I18n": true,
+      "Chart": true,
+      "Dropzone": true,
+      "strftime": true,
+      "Waypoint": true,
+      "wysihtml": true,
+      "LocalTime": true,
+      "describe": true,
+      "after": true,
+      "afterEach": true,
+      "before": true,
+      "beforeEach": true,
+      "it": true,
+      "expect": true,
+      "sinon": true,
+      "fixture": true,
+      "chai": true
+    }
+}

data/.github/workflows/ci.yml

@@ -0,0 +1,60 @@
+name: CI
+on: [push]
+
+jobs:
+  static_analysis:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: workarea-commerce/ci/bundler-audit@v1
+    - uses: workarea-commerce/ci/rubocop@v1
+    - uses: workarea-commerce/ci/eslint@v1
+      with:
+        args: '**/*.js'
+    - uses: workarea-commerce/ci/stylelint@v1
+      with:
+        args: '**/*.scss'
+
+  admin_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:admin
+
+  core_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:core
+
+  storefront_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:storefront
+
+  plugins_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:plugins

data/.gitignore

@@ -21,5 +21,4 @@ test/dummy/log/*.log
 test/dummy/db/*.sqlite3
 test/dummy/db/*.sqlite3-journal
 node_modules
-package.json
-yarn.lock
+.rubocop-http*

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_from:
+  - https://raw.githubusercontent.com/workarea-commerce/workarea/master/.rubocop.yml
+

data/.stylelintrc.json

@@ -0,0 +1,8 @@
+{
+  "extends": "stylelint-config-recommended-scss",
+  "rules": {
+    "block-no-empty": null,
+    "no-descending-specificity": null,
+    "property-no-unknown": [true, { "ignoreProperties": ["mso-hide"] }]
+  }
+}

data/CHANGELOG.md

@@ -1,9 +1,28 @@
-Workarea Save For Later 1.0.1 (2019-08-21)
+Workarea Save For Later 1.1.0 (2019-03-13)
 --------------------------------------------------------------------------------
 
-*   Open Source!
- 
- 
+*   Clean Saved Lists After Predetermined Time Range
+
+    Ensure that `Workarea::SavedList` records are removed after a
+    predetermined length of time (default: 3 months) by way of the [TTL
+    Indexes](https://docs.mongodb.com/manual/core/index-ttl/) feature of
+    MongoDB. Only Saved Lists that do not belong to a User will be cleaned
+    in this manner.
+
+    SAVE4LATER-4
+    Tom Scott
+
+*   Update for workarea v3.4 compatibility
+
+    SAVE4LATER-3
+    Matt Duffy
+
+*   Add details to README
+
+    SAVE4LATER-2
+    Matt Duffy
+
+
 
 Workarea Save For Later 1.0.0 (2018-08-08)
 --------------------------------------------------------------------------------

data/Gemfile

@@ -1,17 +1,10 @@
 source 'https://rubygems.org'
-git_source(:github) { |repo| "git@github.com:#{repo}.git" }
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-# Declare your gem's dependencies in save_for_later.gemspec.
-# Bundler will treat runtime dependencies like base dependencies, and
-# development dependencies will be added by default to the :development group.
 gemspec
 
-# Declare any dependencies that are still in development here instead of in
-# your gemspec. These might include edge Rails or gems from your path or
-# Git. Remember to move these dependencies to your gemspec before releasing
-# your gem to rubygems.org.
-
 # To use a debugger
 # gem 'byebug', group: [:development, :test]
 
+# gem 'workarea', '>= 3.4.0'
 gem 'workarea', github: 'workarea-commerce/workarea'

data/README.md

@@ -1,7 +1,53 @@
 Workarea Save For Later
 ================================================================================
 
-Save For Later plugin for the Workarea platform.
+Increase average order values and help retail customers save items for later without having to create an account.
+
+This plugin allows a consumer with or without an account to move items from their cart to a "Saved For Later" list that displays on the cart page. For users without an account, this list is persisted through a cookie that will retain their list on their browser. For users with accounts, this list is tied to their account directly and will appear in any browser they log into allow quick access to items they may be considering for purchase.
+
+Features
+--------------------------------------------------------------------------------
+
+* Each product in cart will display a “Save for later” link
+* Moving a product from the regular cart to the saved cart will remove it from the cart
+* Saved cart product list item will maintain SKU, quantity, and customizations
+* Each product listed in the saved cart will display a “Move to cart” link
+* Moving a product from the saved cart to the regular cart will remove it from the saved cart
+* If a consumer has not saved any products to a saved cart the saved cart will not display
+* Cookie-based list for guests, tied to account's for signed in users.
+* Lists created while logged out will merge into a consumer's existing list if they log in after adding items to their "Saved for Later" list
+* Utilizes existing cart HTML/CSS to add no additional components that need to be styled.
+* Lists created by guest users are pruned from the database after a
+  predetermined length of time (**default:** 3 months)
+
+Configuration
+--------------------------------------------------------------------------------
+
+`Workarea.config.saved_lists_expiration` configures the expiration time for `Workarea::SavedList` records. Using [MongoDB's TTL Indexes](https://docs.mongodb.com/manual/core/index-ttl/), we can leverage the database to prune these documents in a background thread when they are no longer relevant. This is used to define the `expireAfterSeconds` parameter on the TTL index, which means if this setting is changed, you'll have to rebuild indexes for the `SavedList` model like so:
+
+```ruby
+Workarea::SavedList.remove_indexes
+Workarea::SavedList.create_indexes
+```
+
+To make sure your changes were taken up, view the specification for the TTL index like so:
+
+```ruby
+Workarea::SavedList.index_specifications
+
+=> [#<Mongoid::Indexable::Specification:0x00007fd52a3b9078
+  @fields=[:user_id],
+  @key={:user_id=>1},
+  @klass=Workarea::SavedList,
+  @options={}>,
+ #<Mongoid::Indexable::Specification:0x00007fd52a3acc10
+  @fields=[:updated_at],
+  @key={:updated_at=>1},
+  @klass=Workarea::SavedList,
+  @options=
+   {:expire_after=>1 month, # <<< this is what should change
+    :partial_filter_expression=>{:user_id=>{"$eq"=>nil}}}>]
+```
 
 Getting Started
 --------------------------------------------------------------------------------

data/app/assets/javscripts/workarea/storefront/save_for_later/modules/saved_list_analytics.js

@@ -0,0 +1,31 @@
+/**
+ * @method
+ * @name registerAdapter
+ * @memberof WORKAREA.analytics
+ */
+WORKAREA.analytics.registerAdapter('saved_lists', function () {
+    'use strict';
+
+    return {
+        'addToSavedList': function (payload) {
+            if (payload.id) {
+                $.ajax({
+                    type: 'POST',
+                    url: WORKAREA.routes.storefront.analyticsSavedListAddPath(
+                        { product_id: payload.id }
+                    ),
+                });
+            }
+        },
+        'removeFromSavedList': function (payload) {
+            if (payload.id) {
+                $.ajax({
+                    type: 'POST',
+                    url: WORKAREA.routes.storefront.analyticsSavedListRemovePath(
+                        { product_id: payload.id }
+                    ),
+                });
+            }
+        }
+    };
+});

data/app/controllers/workarea/admin/reports_controller.decorator

@@ -0,0 +1,10 @@
+module Workarea
+  decorate Admin::ReportsController, with: :save_for_later do
+    def save_for_later_products
+      @report = Admin::Reports::SaveForLaterProductsViewModel.wrap(
+        Workarea::Reports::SaveForLaterProducts.new(params),
+        view_model_options
+      )
+    end
+  end
+end

data/app/controllers/workarea/storefront/analytics_controller.decorator

@@ -0,0 +1,17 @@
+module Workarea
+  decorate Storefront::AnalyticsController, with: :save_for_later do
+    def saved_list_add
+      Metrics::ProductByDay.inc(
+        key: { product_id: params[:product_id] },
+        saved_list_adds: 1
+      )
+    end
+
+    def saved_list_remove
+      Metrics::ProductByDay.inc(
+        key: { product_id: params[:product_id] },
+        saved_list_deletes: 1
+      )
+    end
+  end
+end

data/app/controllers/workarea/storefront/current_saved_list.rb

@@ -14,7 +14,7 @@ module Workarea
       def current_saved_list
         @current_saved_list ||= SavedListViewModel.wrap(
           if current_user.present?
-            SavedList.find_or_create_by(id: current_user.id)
+            SavedList.find_or_create_by(user_id: current_user.id)
           elsif cookies[:saved_list_id].present?
             SavedList.find_or_create_by(id: cookies[:saved_list_id])
           else

data/app/helpers/workarea/storefront/saved_lists_helper.rb

@@ -1,11 +1,19 @@
 module Workarea
   module Storefront
     module SavedListsHelper
-      def save_for_later_analytics_data(item)
+      def add_to_saved_list_analytics_data(product)
         {
-          event: 'savedForLater',
+          event: 'addToSavedList',
           domEvent: 'submit',
-          payload: order_item_analytics_data(item)
+          payload: product_analytics_data(product)
+        }
+      end
+
+      def remove_from_saved_list_analytics_data(product)
+        {
+          event: 'removeFromSavedList',
+          domEvent: 'submit',
+          payload: product_analytics_data(product)
         }
       end
     end

data/app/models/workarea/insights/most_saved_products.rb

@@ -0,0 +1,32 @@
+module Workarea
+  module Insights
+    class MostSavedProducts < Base
+      class << self
+        def dashboards
+          %w(catalog)
+        end
+
+        def generate_monthly!
+          results = generate_results
+          create!(results: results) if results.present?
+        end
+
+        def generate_results
+          report
+            .results
+            .take(Workarea.config.insights_products_list_max_results)
+            .map { |result| result.merge(product_id: result['_id']) }
+        end
+
+        def report
+          Reports::SaveForLaterProducts.new(
+            starts_at: beginning_of_last_month,
+            ends_at: end_of_last_month,
+            sort_by: 'adds',
+            sort_direction: 'desc'
+          )
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/metrics/product_by_day.decorator

@@ -0,0 +1,10 @@
+module Workarea
+  decorate Metrics::ProductByDay, with: :save_for_later do
+    decorated do
+      field :saved_list_adds, type: Integer, default: 0
+      field :saved_list_deletes, type: Integer, default: 0
+      field :saved_list_units_sold, type: Integer, default: 0
+      field :saved_list_revenue, type: Float, default: 0.0
+    end
+  end
+end

data/app/models/workarea/saved_list.rb

@@ -2,11 +2,21 @@ module Workarea
   class SavedList
     include ApplicationDocument
 
-    # Will be either a object id for guests, or a user's id
-    field :_id, type: String, default: -> { BSON::ObjectId.new.to_s }
+    field :user_id, type: String
 
     embeds_many :items, class_name: 'Workarea::SavedList::Item'
 
+    index({ user_id: 1 })
+    index(
+      { updated_at: 1 },
+      {
+        expire_after_seconds: Workarea.config.saved_lists_expiration,
+        partial_filter_expression: {
+          user_id: { '$eq' => nil }
+        }
+      }
+    )
+
     def add_item(item_attributes = {})
       item_attributes = item_attributes.with_indifferent_access
       existing = items.where(item_attributes.slice(:sku, :customizations)).first

data/app/queries/workarea/order_metrics.decorator

@@ -0,0 +1,26 @@
+module Workarea
+  decorate OrderMetrics, with: :save_for_later do
+    def products_from_saved_lists
+      @products_from_saved_lists ||=
+        items_from_saved_list
+          .group_by(&:product_id)
+          .transform_values do |items|
+            values = calculate_based_on_items(items)
+
+            {
+              saved_list_units_sold: values[:units_sold],
+              saved_list_revenue: values[:revenue]
+            }
+          end
+    end
+
+    private
+
+    def items_from_saved_list
+      @items_from_saved_list ||= items.select do |item|
+        via = GlobalID.parse(item.via)
+        via.present? && via.model_class.name == 'Workarea::SavedList'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+module Workarea
+  module Reports
+    class SaveForLaterProducts
+      include Report
+
+      self.reporting_class = Metrics::ProductByDay
+      self.sort_fields = %w(revenue units_sold adds deletes)
+
+      def aggregation
+        [filter_results, project_used_fields, group_by_product]
+      end
+
+      def filter_results
+        {
+          '$match' => {
+            'reporting_on' => { '$gte' => starts_at, '$lte' => ends_at },
+            '$or' => [
+              { 'saved_list_adds' => { '$gt' => 0 } },
+              { 'saved_list_deletes' => { '$gt' => 0 } },
+              { 'saved_list_units_sold' => { '$gt' => 0 } }
+            ]
+          }
+        }
+      end
+
+      def project_used_fields
+        {
+          '$project' => {
+            'product_id' => 1,
+            'saved_list_units_sold' => 1,
+            'saved_list_adds' => 1,
+            'saved_list_deletes' => 1,
+            'saved_list_revenue' => 1
+          }
+        }
+      end
+
+      def group_by_product
+        {
+          '$group' => {
+            '_id' => '$product_id',
+            'units_sold' => { '$sum' => '$saved_list_units_sold' },
+            'adds' => { '$sum' => '$saved_list_adds' },
+            'deletes' => { '$sum' => '$saved_list_deletes' },
+            'revenue' => { '$sum' => '$saved_list_revenue' }
+          }
+        }
+      end
+    end
+  end
+end