workarea-wish_lists 3.0.5 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2a0cc205fea571704b4ce49a9259dc6e54f79c9f5a9a5cfdee0f9766b8f6f18
-  data.tar.gz: 00fe354136534a94be79aa0eb3d18d12a86c3317bf2b7ea8cfc2981cc66e540a
+  metadata.gz: 9a060b4ac8c812642c3468a8c04bf2d41d350bf82129d80bc23e80fc8a7f1076
+  data.tar.gz: d0e73f8423e4e6d9ba3977ea33329778cbea295cea8485933a2ec2ed625cade0
 SHA512:
-  metadata.gz: 592d3ddd2066ad1a484cadfe357907a0dd53293207d34ca5af98b01c8fb6e5bf910bdb6e1dc54f7e676852c3f9e7486c30233dcca8ac51c7994933dc817524ef
-  data.tar.gz: f0e6be8eb3bc9ef8b42b88bd71e893081257bb3715ff07e225af58a70306385f6aad0b4d4a6d0b28d915a1948bb647adf485a0216043331f77ea7b5be49ba3a3
+  metadata.gz: 86bcf3cf9b45407591b95c8827edb4f6bc748f20e81501dab7ffb08642b2456a6e606b881fa6d6e89e36d6f5236ae5bd845bd4046a48766d484aa65ae12e5771
+  data.tar.gz: 5c9e81aa4102e7beea127fb4c0606316a07bd1db7eba1e8f982dc513dee1d59dc442de3acc902067b5aee62ce5befc429155375fa9f0fffdc0af69dd8f2a1262

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/.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,54 +1,3 @@
-Workarea Wish Lists 3.0.5 (2020-10-22)
---------------------------------------------------------------------------------
-
-*   Fix typo to filename for WishListUserViewModelTest
-
-
-    Basia
-
-
-
-Workarea Wish Lists 3.0.4 (2019-08-21)
---------------------------------------------------------------------------------
-
-*   Open Source!
-
-
-
-Workarea Wish Lists 3.0.3 (2019-06-11)
---------------------------------------------------------------------------------
-
-*   Improve Empty Wish List Copy Text
-
-    Change the copy text for when a wish list is empty to indicate whether
-    the items in the wish list are purchased or not purchased yet.
-
-    WISHLISTS-88
-    Tom Scott
-
-
-
-Workarea Wish Lists 3.0.2 (2019-04-30)
---------------------------------------------------------------------------------
-
-*   Move utility nav link partial to a better location
-
-    The `_wish_lists_link.html.haml` partial was stored in
-    `app/views/layouts` which causes it to not be skipped or overridden in
-    the expected way. This commit duplicates the file into
-    `app/views/workarea/storefront/wish_lists` to avoid developer confusion
-    and to allow it to be skipped by normal means.
-
-    The previous file remains in place in order to not cause issues for
-    applications that include this plugin, but will now fire off a
-    deprecation warning, prompting developers to update the path themselves
-    in their app.
-
-    WISHLISTS-127
-    Curt Howard
-
-
-
 Workarea Wish Lists 3.0.1 (2019-04-16)
 --------------------------------------------------------------------------------
 

data/Gemfile

@@ -1,6 +1,7 @@
 source 'https://rubygems.org'
-git_source(:github) { |repo| "git@github.com:#{repo}.git" }
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 gemspec
 
-gem 'workarea', '>= 3.3.0'
+# gem 'workarea', '>= 3.4.0'
+gem 'workarea', github: 'workarea-commerce/workarea'

data/Rakefile

@@ -38,12 +38,13 @@ desc "Release version #{Workarea::WishLists::VERSION} of the gem"
 task :release do
   host = "https://#{ENV['BUNDLE_GEMS__WEBLINC__COM']}@gems.weblinc.com"
 
-  Rake::Task['workarea:changelog'].execute
-  system 'git add CHANGELOG.md'
-  system 'git commit -m "Update CHANGELOG"'
+  #Rake::Task['workarea:changelog'].execute
+  #system 'git add CHANGELOG.md'
+  #system 'git commit -m "Update CHANGELOG"'
+  #system 'git push origin HEAD'
 
   system "git tag -a v#{Workarea::WishLists::VERSION} -m 'Tagging #{Workarea::WishLists::VERSION}'"
-  system 'git push origin HEAD --follow-tags'
+  system 'git push --tags'
 
   system 'gem build workarea-wish_lists.gemspec'
   system "gem push workarea-wish_lists-#{Workarea::WishLists::VERSION}.gem"

data/app/assets/javascripts/workarea/storefront/wish_lists/modules/wish_list_analytics.js

@@ -0,0 +1,31 @@
+/**
+ * @method
+ * @name registerAdapter
+ * @memberof WORKAREA.analytics
+ */
+WORKAREA.analytics.registerAdapter('wish_lists', function () {
+    'use strict';
+
+    return {
+        'addToWishList': function (payload) {
+            if (payload.id) {
+                $.ajax({
+                    type: 'POST',
+                    url: WORKAREA.routes.storefront.analyticsWishListAddPath(
+                        { product_id: payload.id }
+                    ),
+                });
+            }
+        },
+        'removeFromWishList': function (payload) {
+            if (payload.id) {
+                $.ajax({
+                    type: 'POST',
+                    url: WORKAREA.routes.storefront.analyticsWishListRemovePath(
+                        { product_id: payload.id }
+                    ),
+                });
+            }
+        }
+    };
+});

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

@@ -0,0 +1,10 @@
+module Workarea
+  decorate Admin::ReportsController, with: :wish_lists do
+    def wish_list_products
+      @report = Admin::Reports::WishListProductsViewModel.wrap(
+        Workarea::Reports::WishListProducts.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: :wish_lists do
+    def wish_list_add
+      Metrics::ProductByDay.inc(
+        key: { product_id: params[:product_id] },
+        wish_list_adds: 1
+      )
+    end
+
+    def wish_list_remove
+      Metrics::ProductByDay.inc(
+        key: { product_id: params[:product_id] },
+        wish_list_deletes: 1
+      )
+    end
+  end
+end

data/app/controllers/workarea/storefront/users/wish_lists_controller.rb

@@ -70,8 +70,9 @@ module Workarea
       private
 
       def require_login_and_redirect
-        remember_location(users_wish_list_path) unless logged_in?
-        require_login
+        result = require_login
+        remember_location(users_wish_list_path) if result == false
+        result
       end
 
       def current_wish_list
@@ -88,18 +89,18 @@ module Workarea
       end
 
       def add_item_from_session
-        item_id = session[:wish_list_item_id]
+        item_id = cookies[:wish_list_item_id]
 
         wish_list_session.add_item(current_wish_list)
-        current_order.remove_item(item_id) if item_id.present?
+        current_order.remove_item(item_id) if current_order.items.where(id: item_id).present?
       end
 
       def wish_list_session
-        WishListSession.new(session)
+        WishListSession.new(cookies)
       end
 
       def item_stored_in_session?
-        session.key?(:wish_list_product_id)
+        cookies.key?(:wish_list_product_id)
       end
 
       def customizations

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

@@ -0,0 +1,21 @@
+module Workarea
+  module Storefront
+    module WishListAnalyticsHelper
+      def add_to_wish_list_analytics_data(product)
+        {
+          event: 'addToWishList',
+          domEvent: 'click',
+          payload: product_analytics_data(product)
+        }
+      end
+
+      def remove_from_wish_list_analytics_data(product)
+        {
+          event: 'removeFromWishList',
+          domEvent: 'submit',
+          payload: product_analytics_data(product)
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Workarea
+  module Insights
+    class MostWishListedProducts < 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::WishListProducts.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: :wish_lists do
+    decorated do
+      field :wish_list_adds, type: Integer, default: 0
+      field :wish_list_deletes, type: Integer, default: 0
+      field :wish_list_units_sold, type: Integer, default: 0
+      field :wish_list_revenue, type: Float, default: 0.0
+    end
+  end
+end

data/app/models/workarea/wish_list.rb

@@ -1,7 +1,6 @@
 module Workarea
   class WishList
-    include Mongoid::Document
-    include Mongoid::Timestamps
+    include ApplicationDocument
     include UrlToken
 
     class InvalidToken < StandardError; end

data/app/models/workarea/wish_list/item.rb

@@ -1,7 +1,6 @@
 module Workarea
   class WishList::Item
-    include Mongoid::Document
-    include Mongoid::Timestamps
+    include ApplicationDocument
 
     field :product_id, type: String
     field :quantity, type: Integer, default: 1

data/app/queries/workarea/order_metrics.decorator

@@ -0,0 +1,24 @@
+module Workarea
+  decorate OrderMetrics, with: :wish_lists do
+    def products_from_wish_lists
+      @products_from_wish_lists ||=
+        wish_list_items
+          .group_by(&:product_id)
+          .transform_values do |items|
+            values = calculate_based_on_items(items)
+
+            {
+              wish_list_units_sold: values[:units_sold],
+              wish_list_revenue: values[:revenue]
+            }
+          end
+    end
+
+    def wish_list_items
+      @wish_list_items ||= items.select do |item|
+        via = GlobalID.parse(item.via)
+        via.present? && via.model_class.name == 'Workarea::WishList'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+module Workarea
+  module Reports
+    class WishListProducts
+      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' => [
+              { 'wish_list_adds' => { '$gt' => 0 } },
+              { 'wish_list_deletes' => { '$gt' => 0 } },
+              { 'wish_list_units_sold' => { '$gt' => 0 } }
+            ]
+          }
+        }
+      end
+
+      def project_used_fields
+        {
+          '$project' => {
+            'product_id' => 1,
+            'wish_list_units_sold' => 1,
+            'wish_list_adds' => 1,
+            'wish_list_deletes' => 1,
+            'wish_list_revenue' => 1
+          }
+        }
+      end
+
+      def group_by_product
+        {
+          '$group' => {
+            '_id' => '$product_id',
+            'units_sold' => { '$sum' => '$wish_list_units_sold' },
+            'adds' => { '$sum' => '$wish_list_adds' },
+            'deletes' => { '$sum' => '$wish_list_deletes' },
+            'revenue' => { '$sum' => '$wish_list_revenue' }
+          }
+        }
+      end
+    end
+  end
+end