workarea-wish_lists 3.0.5 → 3.1.0

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

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

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

@@ -0,0 +1,122 @@
+require 'test_helper'
+
+module Workarea
+  module Reports
+    class WishListProductsTest < TestCase
+      setup :add_data, :time_travel
+
+      def add_data
+        Metrics::ProductByDay.inc(
+          key: { product_id: 'foo' },
+          at: Time.zone.local(2018, 10, 27),
+          wish_list_units_sold: 2,
+          wish_list_revenue: 10.to_m,
+          wish_list_adds: 2,
+          wish_list_deletes: 1
+        )
+
+        Metrics::ProductByDay.inc(
+          key: { product_id: 'foo' },
+          at: Time.zone.local(2018, 10, 28),
+          wish_list_units_sold: 4,
+          wish_list_revenue: 15.to_m,
+          wish_list_adds: 1,
+          wish_list_deletes: 0
+        )
+
+        Metrics::ProductByDay.inc(
+          key: { product_id: 'foo' },
+          at: Time.zone.local(2018, 10, 29),
+          wish_list_units_sold: 6,
+          wish_list_revenue: 27.to_m,
+          wish_list_adds: 1,
+          wish_list_deletes: 1
+        )
+
+        Metrics::ProductByDay.inc(
+          key: { product_id: 'bar' },
+          at: Time.zone.local(2018, 10, 27),
+          wish_list_units_sold: 3,
+          wish_list_revenue: 11.to_m,
+          wish_list_adds: 2,
+          wish_list_deletes: 2
+        )
+
+        Metrics::ProductByDay.inc(
+          key: { product_id: 'bar' },
+          at: Time.zone.local(2018, 10, 28),
+          wish_list_units_sold: 5,
+          wish_list_revenue: 15.to_m,
+          wish_list_adds: 1,
+          wish_list_deletes: 1
+        )
+
+        Metrics::ProductByDay.inc(
+          key: { product_id: 'bar' },
+          at: Time.zone.local(2018, 10, 29),
+          wish_list_units_sold: 7,
+          wish_list_revenue: 27.to_m,
+          wish_list_adds: 0,
+          wish_list_deletes: 1
+        )
+      end
+
+      def time_travel
+        travel_to Time.zone.local(2018, 10, 30)
+      end
+
+      def test_grouping_and_summing
+        report = WishListProducts.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 = WishListProducts.new
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(4, foo['adds'])
+
+        report = WishListProducts.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 = WishListProducts.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 = WishListProducts.new(starts_at: '2018-10-28')
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(2, foo['adds'])
+
+        report = WishListProducts.new(ends_at: '2018-10-28')
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(3, foo['adds'])
+      end
+
+      def test_sorting
+        report = WishListProducts.new(sort_by: 'adds', sort_direction: 'asc')
+        assert_equal('bar', report.results.first['_id'])
+
+        report = WishListProducts.new(sort_by: 'adds', sort_direction: 'desc')
+        assert_equal('foo', report.results.first['_id'])
+
+        report = WishListProducts.new(sort_by: 'units_sold', sort_direction: 'asc')
+        assert_equal('foo', report.results.first['_id'])
+
+        report = WishListProducts.new(sort_by: 'units_sold', sort_direction: 'desc')
+        assert_equal('bar', report.results.first['_id'])
+      end
+    end
+  end
+end

data/test/queries/workarea/wish_list_order_metrics_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+module Workarea
+  class WishListOrderMetricsTest < TestCase
+    def test_products_from_wish_lists
+      product_one = create_product(
+        name: 'Foo 1',
+        variants: [
+          { sku: 'SKU1', regular: 5.to_m },
+          { sku: 'SKU11', regular: 10.to_m }
+        ]
+      )
+
+      product_two = create_product(
+        name: 'Foo 2',
+        variants: [
+          { sku: 'SKU2', regular: 6.to_m },
+          { sku: 'SKU22', regular: 12.to_m }
+        ]
+      )
+
+      user = create_user
+      wish_list = WishList.for_user(user.id)
+
+      order = create_order(
+        email: 'test@workarea.com',
+        items: [
+          { product_id: product_one.id, sku: 'SKU1', quantity: 2, via: wish_list.to_gid_param },
+          { product_id: product_one.id, sku: 'SKU11', quantity: 1, via: wish_list.to_gid_param },
+          { product_id: product_two.id, sku: 'SKU2', quantity: 1 },
+          { product_id: product_two.id, sku: 'SKU22', quantity: 2, via: wish_list.to_gid_param }
+        ]
+      )
+
+      Pricing.perform(order)
+      complete_checkout(order)
+
+      results = OrderMetrics.new(order).products_from_wish_lists
+
+      product_data = results[product_one.id]
+      assert_equal(3, product_data[:wish_list_units_sold])
+      assert_equal(20.to_m, product_data[:wish_list_revenue])
+
+      product_data = results[product_two.id]
+      assert_equal(2, product_data[:wish_list_units_sold])
+      assert_equal(24.to_m, product_data[:wish_list_revenue])
+    end
+  end
+end

data/test/system/workarea/admin/wish_list_products_report_system_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+module Workarea
+  module Admin
+    class WishListProductsReportSystemTest < Workarea::SystemTest
+      include Admin::IntegrationTest
+
+      def test_wish_list_products_report
+        create_product(id: 'foo', name: 'Foo')
+
+        Metrics::ProductByDay.inc(
+          key: { product_id: 'foo' },
+          wish_list_adds: 1,
+          wish_list_units_sold: 5
+        )
+        Metrics::ProductByDay.inc(
+          key: { product_id: 'bar' },
+          wish_list_adds: 4,
+          wish_list_units_sold: 3
+        )
+
+        visit admin.wish_list_products_report_path
+        assert(page.has_content?('Foo'))
+        assert(page.has_content?('bar'))
+        assert(page.has_content?('1'))
+        assert(page.has_content?('5'))
+        assert(page.has_content?('4'))
+        assert(page.has_content?('3'))
+
+        click_link t('workarea.admin.fields.adds')
+        assert(page.has_content?("#{t('workarea.admin.fields.adds')} ↓"))
+        assert(page.has_ordered_text?('bar', 'Foo'))
+
+        click_link t('workarea.admin.fields.units_sold')
+        assert(page.has_content?("#{t('workarea.admin.fields.units_sold')} ↓"))
+        assert(page.has_ordered_text?('Foo', 'bar'))
+
+        click_link t('workarea.admin.fields.units_sold')
+        assert(page.has_content?("#{t('workarea.admin.fields.units_sold')} ↑"))
+        assert(page.has_ordered_text?('bar', 'Foo'))
+      end
+    end
+  end
+end

data/test/system/workarea/storefront/wish_list_analytics_system_test.rb

@@ -0,0 +1,75 @@
+require 'test_helper'
+
+module Workarea
+  module Storefront
+    class WishListAnalyticsSystemTest < Workarea::SystemTest
+      include Storefront::SystemTest
+
+      setup :product, :login_user
+
+      def find_analytics_events(for_event: nil)
+        all_events = page.evaluate_script('WORKAREA.analytics.events')
+
+        if for_event.blank?
+          all_events
+        else
+          all_events.select { |e| e['name'] == for_event }
+        end
+      end
+
+      def disable_dom_events
+        page.execute_script('WORKAREA.analytics.disableDomEvents();')
+      end
+
+      def product
+        @product ||= create_product(name: 'Test Product')
+      end
+
+      def login_user
+        @user ||= create_user(email: 'test@workarea.com', password: 'W3bl1nc!')
+
+        visit storefront.login_path
+
+        within '#login_form' do
+          fill_in 'email', with: 'test@workarea.com'
+          fill_in 'password', with: 'W3bl1nc!'
+          click_button t('workarea.storefront.users.login')
+        end
+      end
+
+      def test_announcing_add_to_wish_list_event
+        visit storefront.product_path(product)
+        click_button t('workarea.storefront.products.add_to_cart')
+
+        visit storefront.cart_path
+
+        disable_dom_events
+        click_button t('workarea.storefront.wish_lists.move_to_wish_list')
+
+        events = find_analytics_events(for_event: 'addToWishList')
+        assert_equal(1, events.count)
+        payload = events.first['arguments'].first
+
+        assert_equal(product.id, payload['id'])
+        assert_equal('Test Product', payload['name'])
+      end
+
+      def test_announcing_remove_from_wish_list_event
+        visit storefront.product_path(product)
+        click_link t('workarea.storefront.wish_lists.add_to_wish_list')
+
+        visit storefront.users_wish_list_path
+
+        disable_dom_events
+        click_button 'remove_item'
+
+        events = find_analytics_events(for_event: 'removeFromWishList')
+        assert_equal(1, events.count)
+        payload = events.first['arguments'].first
+
+        assert_equal(product.id, payload['id'])
+        assert_equal('Test Product', payload['name'])
+      end
+    end
+  end
+end

data/workarea-wish_lists.gemspec

@@ -6,10 +6,10 @@ Gem::Specification.new do |s|
   s.name        = 'workarea-wish_lists'
   s.version     = Workarea::WishLists::VERSION
   s.authors     = ['bcrouse']
-  s.email       = ['bcrouse@weblinc.com']
+  s.email       = ['bcrouse@workarea.com']
   s.homepage    = 'https://github.com/workarea-commerce/workarea-wish-lists'
-  s.summary     = 'Wish Lists plugin for the Workarea ecommerce platform'
-  s.description = "Adds a wish list to user's account in the Workarea ecommerce platform"
+  s.summary     = 'Wish Lists plugin for the Workarea Commerce Platform'
+  s.description = "Adds a wish list to a customer's account in the Workarea Commerce Platform"
 
   s.files = `git ls-files`.split("\n")
 
@@ -17,5 +17,5 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.3.0'
 
-  s.add_dependency 'workarea', '~> 3.x', '>= 3.3.x'
+  s.add_dependency 'workarea', '~> 3.x', '>= 3.5.x'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workarea-wish_lists
 version: !ruby/object:Gem::Version
-  version: 3.0.5
+  version: 3.1.0
 platform: ruby
 authors:
 - bcrouse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-22 00:00:00.000000000 Z
+date: 2019-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: workarea
@@ -19,7 +19,7 @@ dependencies:
         version: 3.x
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.x
+        version: 3.5.x
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,10 +29,10 @@ dependencies:
         version: 3.x
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.x
-description: Adds a wish list to user's account in the Workarea ecommerce platform
+        version: 3.5.x
+description: Adds a wish list to a customer's account in the Workarea Commerce Platform
 email:
-- bcrouse@weblinc.com
+- bcrouse@workarea.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -40,11 +40,15 @@ files:
 - ".editorconfig"
 - ".eslintignore"
 - ".eslintrc"
+- ".eslintrc.json"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/documentation-request.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - ".scss-lint.yml"
+- ".stylelintrc.json"
 - ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -53,32 +57,46 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- app/assets/javascripts/workarea/storefront/wish_lists/modules/wish_list_analytics.js
 - app/assets/javascripts/workarea/storefront/wish_lists/modules/wish_list_button.js
 - app/assets/javascripts/workarea/storefront/wish_lists/modules/wish_list_public_quantity_fields.js
 - app/assets/javascripts/workarea/storefront/wish_lists/templates/hidden_input.jst.ejs
 - app/assets/stylesheets/workarea/storefront/wish_lists/components/_wish_list_button.scss
 - app/assets/stylesheets/workarea/storefront/wish_lists/components/_wish_lists.scss
+- app/controllers/workarea/admin/reports_controller.decorator
 - app/controllers/workarea/admin/users_controller.decorator
+- app/controllers/workarea/storefront/analytics_controller.decorator
 - app/controllers/workarea/storefront/users/wish_lists_controller.rb
 - app/controllers/workarea/storefront/wish_lists_controller.rb
+- app/helpers/workarea/storefront/wish_list_analytics_helper.rb
+- app/models/workarea/insights/most_wish_listed_products.rb
+- app/models/workarea/metrics/product_by_day.decorator
 - app/models/workarea/wish_list.rb
 - app/models/workarea/wish_list/item.rb
 - app/models/workarea/wish_list/pricing.rb
 - app/models/workarea/wish_list/pricing/calculators/totals_calculator.rb
 - app/models/workarea/wish_list/public_search.rb
 - app/models/workarea/wish_list/request.rb
+- app/queries/workarea/order_metrics.decorator
+- app/queries/workarea/reports/wish_list_products.rb
 - app/seeds/workarea/wish_list_seeds.rb
 - app/services/workarea/set_wish_list_details.rb
 - app/services/workarea/wish_list_session.rb
+- app/view_models/workarea/admin/dashboards/reports_view_model.decorator
+- app/view_models/workarea/admin/reports/wish_list_products_view_model.rb
 - app/view_models/workarea/admin/user_view_model.decorator
 - app/view_models/workarea/storefront/user_view_model.decorator
 - app/view_models/workarea/storefront/wish_list_item_view_model.rb
 - app/view_models/workarea/storefront/wish_list_view_model.rb
 - app/views/layouts/workarea/storefront/_wish_lists_link.html.haml
+- app/views/workarea/admin/dashboards/_wish_list_products_card.html.haml
+- app/views/workarea/admin/insights/_most_wish_listed_products.html.haml
+- app/views/workarea/admin/reports/wish_list_products.html.haml
 - app/views/workarea/admin/users/_wish_list_card.html.haml
 - app/views/workarea/admin/users/_wish_list_item_summary.html.haml
 - app/views/workarea/admin/users/wish_list.html.haml
 - app/views/workarea/storefront/carts/_move_to_wish_list.html.haml
+- app/views/workarea/storefront/pages/_wish_lists_robots.text.erb
 - app/views/workarea/storefront/products/_add_to_wish_list.html.haml
 - app/views/workarea/storefront/style_guides/_wish_lists_product_list_docs.html.haml
 - app/views/workarea/storefront/users/accounts/_wish_list_summary.html.haml
@@ -87,6 +105,7 @@ files:
 - app/views/workarea/storefront/wish_lists/index.html.haml
 - app/views/workarea/storefront/wish_lists/show.html.haml
 - app/workers/workarea/mark_wish_list_items_purchased.rb
+- app/workers/workarea/save_order_metrics.decorator
 - app/workers/workarea/update_wish_list_details.rb
 - bin/rails
 - config/initializers/append_points.rb
@@ -97,6 +116,7 @@ files:
 - lib/workarea/wish_lists.rb
 - lib/workarea/wish_lists/engine.rb
 - lib/workarea/wish_lists/version.rb
+- package.json
 - test/dummy/Rakefile
 - test/dummy/app/assets/config/manifest.js
 - test/dummy/app/assets/images/.keep
@@ -150,18 +170,24 @@ files:
 - test/dummy/public/apple-touch-icon.png
 - test/dummy/public/favicon.ico
 - test/integration/workarea/storefront/wish_lists_integration_test.rb
+- test/models/workarea/insights/most_wish_listed_products_test.rb
 - test/models/workarea/wish_list/public_search_test.rb
 - test/models/workarea/wish_list_test.rb
+- test/queries/workarea/reports/wish_list_products_test.rb
+- test/queries/workarea/wish_list_order_metrics_test.rb
 - test/services/workarea/set_wish_list_details_test.rb
 - test/services/workarea/wish_list_session_test.rb
+- test/system/workarea/admin/wish_list_products_report_system_test.rb
 - test/system/workarea/admin/wish_lists_system_test.rb
+- test/system/workarea/storefront/wish_list_analytics_system_test.rb
 - test/system/workarea/storefront/wish_lists_system_test.rb
 - test/test_helper.rb
+- test/view_models/workarea/storefront/user_view_model_test.rb
 - test/view_models/workarea/storefront/wish_list_item_view_model_test.rb
-- test/view_models/workarea/storefront/wish_list_user_view_model_test.rb
 - test/view_models/workarea/storefront/wish_list_view_model_test.rb
 - test/workers/workarea/mark_wish_list_items_purchased_test.rb
 - workarea-wish_lists.gemspec
+- yarn.lock
 homepage: https://github.com/workarea-commerce/workarea-wish-lists
 licenses:
 - Business Software License
@@ -181,8 +207,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: Wish Lists plugin for the Workarea ecommerce platform
+summary: Wish Lists plugin for the Workarea Commerce Platform
 test_files: []