workarea-core 3.4.45 → 3.5.0.beta.1

data/test/queries/workarea/featured_categorization_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+
+module Workarea
+  class FeaturedCategorizationTest < TestCase
+    include TestCase::Workers
+    include TestCase::SearchIndexing
+
+    setup :set_product
+
+    def set_product
+      @product = create_product
+    end
+
+    def test_all
+      release = create_release(publish_at: 1.day.from_now)
+      category_one = create_category
+      category_two = create_category(product_ids: [@product.id])
+
+      release.as_current do
+        category_one.update!(product_ids: [@product.id])
+        assert_equal(
+          [category_two, category_one],
+          FeaturedCategorization.new(@product.id).to_a
+        )
+      end
+
+      release.changesets.destroy_all
+      category_one.reload.update!(product_ids: [@product.id])
+
+      release.as_current do
+        category_one.update!(product_ids: [])
+        assert_equal([category_two], FeaturedCategorization.new(@product.id).to_a)
+      end
+
+      create_release(publish_at: 2.days.from_now).as_current do
+        assert_equal([category_two], FeaturedCategorization.new(@product.id).to_a)
+      end
+    end
+
+    def test_categories_affected_by_current_release
+      create_category
+      assert_empty(FeaturedCategorization.new(@product.id).categories_affected_by_current_release)
+
+      category_one = create_category
+      release_one = create_release(publish_at: 1.day.from_now)
+      release_one.as_current do
+        category_one.update!(product_ids: [@product.id])
+
+        categorization = FeaturedCategorization.new(@product.id)
+        assert_equal([category_one], categorization.categories_affected_by_current_release)
+        assert(categorization.categories_affected_by_current_release.first.featured_product?(@product.id))
+      end
+
+      release_two = create_release(publish_at: 2.days.from_now)
+      release_two.as_current do
+        category_one.update!(product_ids: ['foo'])
+
+        categorization = FeaturedCategorization.new(@product.id)
+        assert_equal([category_one], categorization.categories_affected_by_current_release)
+        refute(categorization.categories_affected_by_current_release.first.featured_product?(@product.id))
+      end
+
+      assert_empty(FeaturedCategorization.new(@product.id).categories_affected_by_current_release)
+    end
+  end
+end

data/test/queries/workarea/order_cancellation_metrics_test.rb

@@ -0,0 +1,203 @@
+require 'test_helper'
+
+module Workarea
+  class OrderCancellationMetricsTest < IntegrationTest
+    setup :set_models
+
+    def set_models
+      create_life_cycle_segments
+      @product_one = create_product(
+        name: 'Foo 1',
+        variants: [{ sku: 'SKU1', regular: 5.to_m, tax_code: '001' }]
+      )
+
+      @product_two = create_product(
+        name: 'Foo 2',
+        variants: [{ sku: 'SKU2', regular: 6.to_m, tax_code: '001' }]
+      )
+
+      shipping_service = create_shipping_service(rates: [{ price: 5.to_m }])
+
+      @category = create_category(product_ids: [@product_one.id])
+      @search = Navigation::SearchResults.new(q: 'foo')
+      @taxon = create_taxon(navigable: @category)
+      @menu = create_menu(taxon: @taxon)
+
+      @order = Order.new(
+        email: 'bcrouse@workarea.com',
+        promo_codes: ['foo'],
+        segment_ids: [Segment::FirstTimeVisitor.instance.id],
+        items: [
+          { product_id: @product_one.id, sku: 'SKU1', quantity: 2, via: @category.to_gid_param },
+          { product_id: @product_two.id, sku: 'SKU2', quantity: 1, via: @search.to_gid_param }
+        ]
+      )
+
+      create_payment_profile(store_credit: 6.to_m, reference: @order.id)
+
+      Metrics::User.save_order(email: 'bcrouse@workarea.com', revenue: 10.to_m)
+
+      create_tax_category(code: '001', rates: [{ percentage: 0.06, country: 'US' }])
+      complete_checkout(@order, shipping_service: shipping_service.name)
+    end
+
+    def test_sales_data
+      metrics = OrderCancellationMetrics.new(@order)
+
+      assert_equal(1, metrics.sales_data[:cancellations])
+      assert_equal(3, metrics.sales_data[:units_canceled])
+      assert_equal(-21.96.to_m, metrics.sales_data[:refund])
+      assert_equal(-21.96.to_m, metrics.sales_data[:revenue])
+
+      metrics = OrderCancellationMetrics.new(
+        @order,
+        item_values: { @order.items.first.id.to_s => { quantity: 1, amount: 4.0 } },
+        shipping_value: 2.0
+      )
+
+      assert_equal(1, metrics.sales_data[:cancellations])
+      assert_equal(1, metrics.sales_data[:units_canceled])
+      assert_equal(-6, metrics.sales_data[:refund])
+      assert_equal(-6, metrics.sales_data[:revenue])
+    end
+
+    def test_products
+      metrics = OrderCancellationMetrics.new(@order)
+
+      assert_equal(2, metrics.products.size)
+
+      assert_equal(2, metrics.products[@product_one.id][:units_canceled])
+      assert_equal(-10.6.to_m, metrics.products[@product_one.id][:refund])
+      assert_equal(-10.6.to_m, metrics.products[@product_one.id][:revenue])
+
+      assert_equal(1, metrics.products[@product_two.id][:units_canceled])
+      assert_equal(-6.36.to_m, metrics.products[@product_two.id][:refund])
+      assert_equal(-6.36.to_m, metrics.products[@product_two.id][:revenue])
+
+      metrics = OrderCancellationMetrics.new(
+        @order,
+        item_values: { @order.items.first.id.to_s => { quantity: 1, amount: 4.0 } },
+      )
+
+      assert_equal(1, metrics.products.size)
+
+      assert_equal(1, metrics.products[@product_one.id][:units_canceled])
+      assert_equal(-4, metrics.products[@product_one.id][:refund])
+      assert_equal(-4, metrics.products[@product_one.id][:revenue])
+    end
+
+    def test_categories
+      metrics = OrderCancellationMetrics.new(@order)
+
+      assert_equal(1, metrics.categories.size)
+      assert_equal(2, metrics.categories[@category.id.to_s][:units_canceled])
+      assert_equal(-10.6.to_m, metrics.categories[@category.id.to_s][:refund])
+      assert_equal(-10.6.to_m, metrics.categories[@category.id.to_s][:revenue])
+
+      metrics = OrderCancellationMetrics.new(
+        @order,
+        item_values: { @order.items.first.id.to_s => { quantity: 1, amount: 4.0 } },
+      )
+
+      assert_equal(1, metrics.categories.size)
+      assert_equal(1, metrics.categories[@category.id.to_s][:units_canceled])
+      assert_equal(-4, metrics.categories[@category.id.to_s][:refund])
+      assert_equal(-4, metrics.categories[@category.id.to_s][:revenue])
+    end
+
+    def test_searches
+      metrics = OrderCancellationMetrics.new(@order)
+
+      assert_equal(1, metrics.searches.size)
+      query_id = @search.query_string.id
+
+      assert_equal(1, metrics.searches[query_id][:units_canceled])
+      assert_equal(-6.36.to_m, metrics.searches[query_id][:refund])
+      assert_equal(-6.36.to_m, metrics.searches[query_id][:revenue])
+
+      metrics = OrderCancellationMetrics.new(
+        @order,
+        item_values: { @order.items.first.id.to_s => { quantity: 1, amount: 4.0 } },
+      )
+      assert_equal(0, metrics.searches.size)
+
+      metrics = OrderCancellationMetrics.new(
+        @order,
+        item_values: { @order.items.second.id.to_s => { quantity: 1, amount: 4.0 } },
+      )
+
+      assert_equal(1, metrics.searches.size)
+      query_id = @search.query_string.id
+
+      assert_equal(1, metrics.searches[query_id][:units_canceled])
+      assert_equal(-4, metrics.searches[query_id][:refund])
+      assert_equal(-4, metrics.searches[query_id][:revenue])
+    end
+
+    def test_skus
+      metrics = OrderCancellationMetrics.new(@order)
+
+      assert_equal(2, metrics.skus.size)
+
+      assert_equal(2, metrics.skus['SKU1'][:units_canceled])
+      assert_equal(-10.6.to_m,  metrics.skus['SKU1'][:refund])
+      assert_equal(-10.6.to_m,  metrics.skus['SKU1'][:revenue])
+
+      assert_equal(1, metrics.skus['SKU2'][:units_canceled])
+      assert_equal(-6.36.to_m, metrics.skus['SKU2'][:refund])
+      assert_equal(-6.36.to_m, metrics.skus['SKU2'][:revenue])
+
+      metrics = OrderCancellationMetrics.new(
+        @order,
+        item_values: { @order.items.first.id.to_s => { quantity: 1, amount: 4.0 } },
+      )
+
+      assert_equal(1, metrics.skus.size)
+
+      assert_equal(1, metrics.skus['SKU1'][:units_canceled])
+      assert_equal(-4,  metrics.skus['SKU1'][:refund])
+      assert_equal(-4,  metrics.skus['SKU1'][:revenue])
+    end
+
+    def test_menus
+      metrics = OrderCancellationMetrics.new(@order)
+      assert_equal(1, metrics.menus.size)
+
+      assert_equal(2, metrics.menus[@menu.id.to_s][:units_canceled])
+      assert_equal(-10.6.to_m, metrics.menus[@menu.id.to_s][:refund])
+      assert_equal(-10.6.to_m, metrics.menus[@menu.id.to_s][:revenue])
+
+      metrics = OrderCancellationMetrics.new(
+        @order,
+        item_values: { @order.items.first.id.to_s => { quantity: 1, amount: 4.0 } },
+      )
+
+      assert_equal(1, metrics.menus.size)
+
+      assert_equal(1, metrics.menus[@menu.id.to_s][:units_canceled])
+      assert_equal(-4, metrics.menus[@menu.id.to_s][:refund])
+      assert_equal(-4, metrics.menus[@menu.id.to_s][:revenue])
+    end
+
+    def test_segments_data
+      metrics = OrderCancellationMetrics.new(@order)
+      segment = Segment::FirstTimeVisitor.instance
+
+      assert_equal(1, metrics.segments[segment.id][:cancellations])
+      assert_equal(3, metrics.segments[segment.id][:units_canceled])
+      assert_equal(-21.96.to_m, metrics.segments[segment.id][:refund])
+      assert_equal(-21.96.to_m, metrics.segments[segment.id][:revenue])
+
+      metrics = OrderCancellationMetrics.new(
+        @order,
+        item_values: { @order.items.first.id.to_s => { quantity: 1, amount: 4.0 } },
+        shipping_value: 2.0
+      )
+
+      assert_equal(1, metrics.segments[segment.id][:cancellations])
+      assert_equal(1, metrics.segments[segment.id][:units_canceled])
+      assert_equal(-6, metrics.segments[segment.id][:refund])
+      assert_equal(-6, metrics.segments[segment.id][:revenue])
+    end
+  end
+end

data/test/queries/workarea/order_item_details_test.rb

@@ -12,6 +12,22 @@ module Workarea
       assert_nil(OrderItemDetails.find('SKU1'))
     end
 
+    def test_requires_shipping?
+      product = create_product(variants: [{ sku: 'SKU', regular: 5.00 }])
+
+      assert(OrderItemDetails.find('SKU').requires_shipping?)
+
+      product.update(digital: true)
+      refute(OrderItemDetails.find('SKU').requires_shipping?)
+
+      product.update(digital: false)
+      sku = create_fulfillment_sku(id: 'SKU', policy: :ignore)
+      refute(OrderItemDetails.find('SKU').requires_shipping?)
+
+      sku.update(policy: :download, file: product_image_file)
+      refute(OrderItemDetails.find('SKU').requires_shipping?)
+    end
+
     def test_to_h
       product = create_product(id: "840B898080", variants: [{ sku: 'SKU', regular: 5.00 }])
       # we lose time precision on created_at/updated_at when storing in the database
@@ -23,6 +39,7 @@ module Workarea
       assert_equal(product.as_document, details[:product_attributes])
     end
 
+
     def test_shared_sku_products
       product = create_product(id: "840B898080", variants: [{ sku: 'SKU', regular: 5.00 }])
       product.reload

data/test/queries/workarea/order_metrics_test.rb

@@ -43,6 +43,8 @@ module Workarea
         ]
       )
 
+      create_payment_profile(store_credit: 6.to_m, reference: @order.id)
+
       Metrics::User.save_order(email: 'bcrouse@workarea.com', revenue: 10.to_m)
 
       create_tax_category(code: '001', rates: [{ percentage: 0.06, country: 'US' }])
@@ -176,5 +178,15 @@ module Workarea
       refute(metrics.first_time_customer?)
       refute(metrics.repeat_today?)
     end
+
+    def test_tenders
+      assert_equal(2, @metrics.tenders.size)
+
+      assert_equal(1, @metrics.tenders[:credit_card][:orders])
+      assert_equal(10.26.to_m, @metrics.tenders[:credit_card][:revenue])
+
+      assert_equal(1, @metrics.tenders[:store_credit][:orders])
+      assert_equal(6.to_m, @metrics.tenders[:store_credit][:revenue])
+    end
   end
 end

data/test/queries/workarea/product_releases_test.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+
+module Workarea
+  class ProductReleasesTest < TestCase
+    def test_product_changes
+      product = create_product(name: 'Foo')
+      release_one = create_release
+      release_one.as_current { product.update!(name: 'Bar') }
+
+      assert_equal([release_one], ProductReleases.new(product).releases)
+
+      release_one.update!(publish_at: 1.day.from_now)
+      release_two = create_release(publish_at: 3.days.from_now)
+      assert_equal([release_one, release_two], ProductReleases.new(product).releases)
+    end
+
+    def test_featured_product_changes
+      product = create_product
+      category = create_category
+
+      release_one = create_release
+      release_one.as_current { category.update!(product_ids: [product.id]) }
+      assert_equal([release_one], ProductReleases.new(product).releases)
+
+      release_one.update!(publish_at: 1.day.from_now)
+      release_two = create_release(publish_at: 3.days.from_now)
+      assert_equal([release_one, release_two], ProductReleases.new(product).releases)
+    end
+
+    def test_variant_changes
+      product = create_product(variants: [{ sku: 'SKU' }])
+      release = create_release
+      release.as_current { product.variants.first.update!(details: { color: 'Red' }) }
+      assert_equal([release], ProductReleases.new(product).releases)
+    end
+
+    def test_pricing_changes
+      product = create_product(variants: [{ sku: 'SKU' }])
+      pricing = Pricing::Sku.find('SKU')
+
+      release = create_release
+      release.as_current { pricing.prices.first.update!(regular: 10_000) }
+      assert_equal([release], ProductReleases.new(product).releases)
+    end
+
+    def test_changesets_with_missing_releases
+      product = create_product(name: 'Foo')
+      release = create_release
+      release.as_current { product.update!(name: 'Bar') }
+      release.delete
+
+      assert_nil(product.reload.changesets.first.release)
+      assert_equal([], ProductReleases.new(product).releases)
+    end
+  end
+end

data/test/queries/workarea/recommendation/searches_test.rb

@@ -4,9 +4,9 @@ module Workarea
   module Recommendation
     class SearchesTest < TestCase
       def test_find
-        Recommendation::UserActivity.create!(searches: %w(foo bars))
-        Recommendation::UserActivity.create!(searches: %w(foo @#$%))
-        2.times { Recommendation::UserActivity.create!(searches: %w(foos baz)) }
+        Metrics::User.create!(viewed: { search_ids: %w(foo bar) })
+        Metrics::User.create!(viewed: { search_ids: %w(foo) })
+        2.times { Metrics::User.create!(viewed: { search_ids: %w(foo baz) }) }
 
         ProcessSearchRecommendations.new.perform
 

data/test/queries/workarea/recommendation/user_activity_based_test.rb

@@ -20,14 +20,14 @@ module Workarea
       end
 
       def test_using_popular_products_if_blank
-        activity = UserActivity.new
-        query = UserActivityBased.new(activity)
+        metrics = Metrics::User.new
+        query = UserActivityBased.new(metrics)
         assert_equal(%w(1 2 3), query.results)
       end
 
       def test_using_related_products
-        activity = UserActivity.new(product_ids: %w(1))
-        query = UserActivityBased.new(activity)
+        metrics = Metrics::User.new(viewed: { product_ids: %w(1) })
+        query = UserActivityBased.new(metrics)
         assert_equal(2, query.results.size)
         assert_includes(query.results, '2')
         assert_includes(query.results, '3')

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

@@ -14,7 +14,7 @@ module Workarea
 
         Metrics::User.save_order(
           email: 'returning-once@workarea.com',
-          revenue: 20.to_m,
+          revenue: 10.to_m,
           at: Time.zone.local(2018, 11, 16)
         )
 
@@ -36,7 +36,11 @@ module Workarea
           at: Time.zone.local(2018, 11, 16)
         )
 
-        Metrics::User.save_order(email: 'once@workarea.com', revenue: 15.to_m)
+        Metrics::User.save_order(
+          email: 'once@workarea.com',
+          revenue: 15.to_m,
+          at: Time.zone.local(2018, 11, 15)
+        )
       end
 
       def test_filtering
@@ -66,19 +70,19 @@ module Workarea
         report = Customers.new
         assert_equal(3, report.results.length)
 
-        once = report.results.detect { |r| r['_id'] == 'returning-once@workarea.com' }
+        once = report.results.detect { |r| r['_id'] == 'once@workarea.com' }
         assert_equal(Time.zone.local(2018, 11, 15).to_i, once['first_order_at'].to_i)
-        assert_equal(Time.zone.local(2018, 11, 16).to_i, once['last_order_at'].to_i)
-        assert_equal(2, once['orders'])
+        assert_equal(Time.zone.local(2018, 11, 15).to_i, once['last_order_at'].to_i)
+        assert_equal(1, once['orders'])
         assert_equal(15, once['average_order_value'])
-        assert_equal(30, once['revenue'])
+        assert_equal(15, once['revenue'])
 
         returning = report.results.detect { |r| r['_id'] == 'returning-once@workarea.com' }
         assert_equal(Time.zone.local(2018, 11, 15).to_i, returning['first_order_at'].to_i)
         assert_equal(Time.zone.local(2018, 11, 16).to_i, returning['last_order_at'].to_i)
         assert_equal(2, returning['orders'])
-        assert_equal(15, returning['average_order_value'])
-        assert_equal(30, returning['revenue'])
+        assert_equal(10, returning['average_order_value'])
+        assert_equal(20, returning['revenue'])
 
         twice = report.results.detect { |r| r['_id'] == 'returning-twice@workarea.com' }
         assert_equal(Time.zone.local(2018, 11, 14).to_i, twice['first_order_at'].to_i)

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

@@ -76,13 +76,11 @@ module Workarea
       end
 
       def test_results
-        Workarea.with_config do |config|
-          config.reports_max_results = 1
-          report = TestReport.new
+        Workarea.config.reports_max_results = 1
+        report = TestReport.new
 
-          assert_equal(1, report.count)
-          assert_equal(1, report.results.size)
-        end
+        assert_equal(1, report.count)
+        assert_equal(1, report.results.size)
       end
 
       def test_cache_key

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

@@ -23,7 +23,10 @@ module Workarea
           units_sold: 4,
           merchandise: 20.to_m,
           discounts: -5.to_m,
-          revenue: 15.to_m
+          revenue: 15.to_m,
+          units_canceled: 2,
+          refund: -10.to_m,
+          cancellations: 1
         )
 
         Metrics::CountryByDay.inc(
@@ -33,7 +36,10 @@ module Workarea
           units_sold: 6,
           merchandise: 30.to_m,
           discounts: -3.to_m,
-          revenue: 27.to_m
+          revenue: 27.to_m,
+          units_canceled: 1,
+          refund: -3.to_m,
+          cancellations: 1
         )
 
         Metrics::CountryByDay.inc(
@@ -43,7 +49,10 @@ module Workarea
           units_sold: 3,
           merchandise: 11.to_m,
           discounts: 0.to_m,
-          revenue: 11.to_m
+          revenue: 11.to_m,
+          units_canceled: 1,
+          refund: -5.to_m,
+          cancellations: 1
         )
 
         Metrics::CountryByDay.inc(
@@ -81,6 +90,9 @@ module Workarea
         assert_equal(60, us['merchandise'])
         assert_equal(-8, us['discounts'])
         assert_equal(52, us['revenue'])
+        assert_equal(2, us['cancellations'])
+        assert_equal(3, us['units_canceled'])
+        assert_equal(-13, us['refund'])
 
         ca = report.results.detect { |r| r['_id'] == 'CA' }
         assert_equal(9, ca['orders'])
@@ -88,6 +100,9 @@ module Workarea
         assert_equal(63, ca['merchandise'])
         assert_equal(-10, ca['discounts'])
         assert_equal(53, ca['revenue'])
+        assert_equal(1, ca['cancellations'])
+        assert_equal(1, ca['units_canceled'])
+        assert_equal(-5, ca['refund'])
       end
 
       def test_date_ranges

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

@@ -13,7 +13,8 @@ module Workarea
           units_sold: 2,
           merchandise: 10.to_m,
           discounts: 0.to_m,
-          revenue: 10.to_m
+          tax: 1.to_m,
+          revenue: 11.to_m
         )
 
         Metrics::ProductByDay.inc(
@@ -23,7 +24,10 @@ module Workarea
           units_sold: 4,
           merchandise: 20.to_m,
           discounts: -5.to_m,
-          revenue: 15.to_m
+          tax: 1.to_m,
+          revenue: 16.to_m,
+          units_canceled: 2,
+          refund: -10.to_m
         )
 
         Metrics::ProductByDay.inc(
@@ -33,7 +37,10 @@ module Workarea
           units_sold: 6,
           merchandise: 30.to_m,
           discounts: -3.to_m,
-          revenue: 27.to_m
+          tax: 2.to_m,
+          revenue: 29.to_m,
+          units_canceled: 1,
+          refund: -3.to_m
         )
 
         Metrics::ProductByDay.inc(
@@ -43,7 +50,10 @@ module Workarea
           units_sold: 3,
           merchandise: 11.to_m,
           discounts: 0.to_m,
-          revenue: 11.to_m
+          tax: 1.to_m,
+          revenue: 12.to_m,
+          units_canceled: 1,
+          refund: -5.to_m
         )
 
         Metrics::ProductByDay.inc(
@@ -53,7 +63,8 @@ module Workarea
           units_sold: 5,
           merchandise: 21.to_m,
           discounts: -6.to_m,
-          revenue: 15.to_m
+          tax: 1.to_m,
+          revenue: 16.to_m
         )
 
         Metrics::ProductByDay.inc(
@@ -63,7 +74,8 @@ module Workarea
           units_sold: 7,
           merchandise: 31.to_m,
           discounts: -4.to_m,
-          revenue: 27.to_m
+          tax: 2.to_m,
+          revenue: 29.to_m
         )
       end
 
@@ -80,14 +92,22 @@ module Workarea
         assert_equal(12, foo['units_sold'])
         assert_equal(60, foo['merchandise'])
         assert_equal(-8, foo['discounts'])
-        assert_equal(52, foo['revenue'])
+        assert_equal(4, foo['tax'])
+        assert_equal(56, foo['revenue'])
+        assert_equal(4.33, foo['average_price'])
+        assert_equal(3, foo['units_canceled'])
+        assert_equal(-13, foo['refund'])
 
         bar = report.results.detect { |r| r['_id'] == 'bar' }
         assert_equal(9, bar['orders'])
         assert_equal(15, bar['units_sold'])
         assert_equal(63, bar['merchandise'])
         assert_equal(-10, bar['discounts'])
-        assert_equal(53, bar['revenue'])
+        assert_equal(4, bar['tax'])
+        assert_equal(57, bar['revenue'])
+        assert_equal(3.53, bar['average_price'])
+        assert_equal(1, bar['units_canceled'])
+        assert_equal(-5, bar['refund'])
       end
 
       def test_date_ranges