workarea-reviews 3.0.8 → 3.1.2

data/config/routes.rb

@@ -6,6 +6,10 @@ Workarea::Admin::Engine.routes.draw do
         get :reviews
       end
     end
+
+    resource :report, only: [] do
+      get :reviews_by_product
+    end
   end
 end
 

data/lib/workarea/reviews/engine.rb

@@ -5,7 +5,11 @@ module Workarea
       isolate_namespace Workarea::Reviews
 
       config.to_prepare do
+        Admin::ApplicationController.helper(Admin::ReviewsHelper)
         Storefront::ApplicationController.helper(Storefront::ReviewsHelper)
+        Workarea::Storefront::ApplicationController.helper(
+          Workarea::Storefront::ReviewsSchemaOrgHelper
+        )
       end
     end
   end

data/lib/workarea/reviews/version.rb

@@ -1,5 +1,5 @@
 module Workarea
   module Reviews
-    VERSION = '3.0.8'.freeze
+    VERSION = '3.1.2'.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/dummy/config/initializers/session_store.rb

@@ -1,3 +1,5 @@
 # Be sure to restart your server when you modify this file.
 
-Rails.application.config.session_store :cookie_store, key: '_dummy_session'
+Rails.application.config.session_store :cookie_store,
+                                       key: '_dummy_session',
+                                       expire_after: 30.minutes

data/test/helpers/workarea/storefront/reviews_helper_test.rb

@@ -4,7 +4,7 @@ module Workarea
   module Storefront
     class ReviewsHelperTest < ViewTest
       def test_rating_stars_displays_correct_rating
-        assert_match(/1\.0 out of 5 stars/, rating_stars(1))
+        assert_match(/1(?:\.0)? out of 5 stars/, rating_stars(1))
         assert_match(/2\.5 out of 5 stars/, rating_stars(2.5))
         assert_match(/4\.25 out of 5 stars/, rating_stars(4.251))
       end

data/test/integration/workarea/admin/reviews_integration_test.rb

@@ -6,7 +6,11 @@ module Workarea
       include Admin::IntegrationTest
 
       def test_updating_a_review
-        review = create_review(product_id: product.id)
+        review = create_review(
+          product_id: product.id,
+          rating: 4,
+          approved: false
+        )
 
         put admin.review_path(review), params: {
           review: { body: 'foo bar', approved: true }

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

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+module Workarea
+  module Insights
+    class MostActiveReviewersTest < TestCase
+      setup :add_data, :time_travel
+
+      def add_data
+        travel_to Time.zone.local(2018, 10, 27)
+
+        5.times { create_review(email: 'foo@workarea.com', approved: true, verified: true) }
+        7.times { create_review(email: 'bar@workarea.com', approved: true) }
+      end
+
+      def time_travel
+        travel_to Time.zone.local(2018, 11, 1)
+      end
+
+      def test_generate_monthly!
+        MostActiveReviewers.generate_monthly!
+        assert_equal(1, MostActiveReviewers.count)
+
+        reviewers = MostActiveReviewers.first
+        assert_equal(2, reviewers.results.size)
+        assert_equal('foo@workarea.com', reviewers.results.first['email'])
+        assert_in_delta(5, reviewers.results.first['reviews'])
+        assert_equal('bar@workarea.com', reviewers.results.second['email'])
+        assert_in_delta(7, reviewers.results.second['reviews'])
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+module Workarea
+  module Insights
+    class MostReviewedProductsTest < TestCase
+      setup :add_data, :time_travel
+
+      def add_data
+        travel_to Time.zone.local(2018, 10, 27)
+
+        6.times { create_review(product_id: 'foo', approved: true) }
+        12.times { create_review(product_id: 'bar', approved: true) }
+      end
+
+      def time_travel
+        travel_to Time.zone.local(2018, 11, 1)
+      end
+
+      def test_generate_monthly!
+        MostReviewedProducts.generate_monthly!
+        assert_equal(1, MostReviewedProducts.count)
+
+        reviewed_products = MostReviewedProducts.first
+        assert_equal(2, reviewed_products.results.size)
+        assert_equal('bar', reviewed_products.results.first['product_id'])
+        assert_in_delta(12, reviewed_products.results.first['reviews'])
+        assert_equal('foo', reviewed_products.results.second['product_id'])
+        assert_in_delta(6, reviewed_products.results.second['reviews'])
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+module Workarea
+  module Insights
+    class TopRatedProductsTest < TestCase
+      setup :add_data, :time_travel
+
+      def add_data
+        create_review(product_id: 'foo', rating: 3, created_at: Time.zone.local(2018, 10, 27))
+        create_review(product_id: 'foo', rating: 3, created_at: Time.zone.local(2018, 10, 28))
+        create_review(product_id: 'foo', rating: 3, created_at: Time.zone.local(2018, 10, 28))
+        create_review(product_id: 'foo', rating: 5, created_at: Time.zone.local(2018, 10, 29))
+        create_review(product_id: 'foo', rating: 3, created_at: Time.zone.local(2018, 10, 29))
+        create_review(product_id: 'foo', rating: 2, created_at: Time.zone.local(2018, 10, 29))
+
+        create_review(product_id: 'bar', rating: 3, created_at: Time.zone.local(2018, 10, 27))
+        create_review(product_id: 'bar', rating: 4, created_at: Time.zone.local(2018, 10, 27))
+        create_review(product_id: 'bar', rating: 5, created_at: Time.zone.local(2018, 10, 27))
+        create_review(product_id: 'bar', rating: 5, created_at: Time.zone.local(2018, 10, 28))
+        create_review(product_id: 'bar', rating: 5, created_at: Time.zone.local(2018, 10, 28))
+        create_review(product_id: 'bar', rating: 5, created_at: Time.zone.local(2018, 10, 28))
+        create_review(product_id: 'bar', rating: 4, created_at: Time.zone.local(2018, 10, 28))
+        create_review(product_id: 'bar', rating: 4, created_at: Time.zone.local(2018, 10, 29))
+        create_review(product_id: 'bar', rating: 4, created_at: Time.zone.local(2018, 10, 29))
+        create_review(product_id: 'bar', rating: 5, created_at: Time.zone.local(2018, 10, 29))
+        create_review(product_id: 'bar', rating: 5, created_at: Time.zone.local(2018, 10, 29))
+        create_review(product_id: 'bar', rating: 3, created_at: Time.zone.local(2018, 10, 29))
+      end
+
+      def time_travel
+        travel_to Time.zone.local(2018, 11, 1)
+      end
+
+      def test_generate_monthly!
+        TopRatedProducts.generate_monthly!
+        assert_equal(1, TopRatedProducts.count)
+
+        rated_products = TopRatedProducts.first
+        assert_equal(2, rated_products.results.size)
+        assert_equal('bar', rated_products.results.first['product_id'])
+        assert_equal(4.33, rated_products.results.first['average_rating'].round(2))
+        assert_equal(3.73, rated_products.results.first['weighted_average_rating'].round(2))
+        assert_equal('foo', rated_products.results.second['product_id'])
+        assert_equal(3.17, rated_products.results.second['average_rating'].round(2))
+        assert_equal(3.06, rated_products.results.second['weighted_average_rating'].round(2))
+      end
+    end
+  end
+end

data/test/models/workarea/review_test.rb

@@ -2,6 +2,26 @@ require 'test_helper'
 
 module Workarea
   class ReviewTest < Workarea::TestCase
+    def product_id
+      'PROD1'
+    end
+
+    def approved
+      @approved ||= create_review(
+        product_id: product_id,
+        rating: 4,
+        approved: true
+      )
+    end
+
+    def unapproved
+      @unapproved ||= create_review(
+        product_id: product_id,
+        rating: 4,
+        approved: false
+      )
+    end
+
     def test_find_for_product_returns_approved_reviews
       assert([approved], Review.find_for_product(product_id))
     end
@@ -69,26 +89,17 @@ module Workarea
       assert_equal(review.body.truncate(50), review.title)
     end
 
-    private
-
-    def product_id
-      'PROD1'
-    end
+    def test_find_sorting_score
+      create_review(product_id: 'foo', rating: 4, approved: true)
+      create_review(product_id: 'foo', rating: 5, approved: true)
+      create_review(product_id: 'foo', rating: 5, approved: true)
+      assert_equal(3.38, Review.find_sorting_score('foo').round(2))
 
-    def approved
-      @approved ||= create_review(
-        product_id: product_id,
-        rating: 4,
-        approved: true
-      )
-    end
+      create_review(product_id: 'foo', rating: 1, approved: false)
+      assert_equal(3.38, Review.find_sorting_score('foo').round(2))
 
-    def unapproved
-      @unapproved ||= create_review(
-        product_id: product_id,
-        rating: 4,
-        approved: false
-      )
+      create_review(product_id: 'foo', rating: 1, approved: true)
+      assert_equal(3.21, Review.find_sorting_score('foo').round(2))
     end
   end
 end

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

@@ -0,0 +1,104 @@
+require 'test_helper'
+
+module Workarea
+  module Reports
+    class ReviewsByProductTest < TestCase
+      setup :add_data, :time_travel
+
+      def add_data
+        create_review(product_id: 'foo', rating: 4, created_at: Time.zone.local(2018, 10, 27), approved: true, verified: true)
+        create_review(product_id: 'foo', rating: 3, created_at: Time.zone.local(2018, 10, 28), approved: true, verified: true)
+        create_review(product_id: 'foo', rating: 4, created_at: Time.zone.local(2018, 10, 28), approved: true)
+        create_review(product_id: 'foo', rating: 4, created_at: Time.zone.local(2018, 10, 29), approved: true)
+        create_review(product_id: 'foo', rating: 3, created_at: Time.zone.local(2018, 10, 29), approved: false)
+        create_review(product_id: 'foo', rating: 2, created_at: Time.zone.local(2018, 10, 29), approved: false)
+
+        create_review(product_id: 'bar', rating: 3, created_at: Time.zone.local(2018, 10, 27), approved: true, verified: true)
+        create_review(product_id: 'bar', rating: 4, created_at: Time.zone.local(2018, 10, 28), approved: true)
+        create_review(product_id: 'bar', rating: 5, created_at: Time.zone.local(2018, 10, 28), approved: false)
+        create_review(product_id: 'bar', rating: 5, created_at: Time.zone.local(2018, 10, 29), approved: false)
+        create_review(product_id: 'bar', rating: 3, created_at: Time.zone.local(2018, 10, 29), approved: false)
+      end
+
+      def time_travel
+        travel_to Time.zone.local(2018, 10, 30)
+      end
+
+      def test_grouping_and_summing
+        report = ReviewsByProduct.new
+        assert_equal(2, report.results.length)
+
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(6, foo['reviews'])
+        assert_equal(2, foo['verified'])
+        assert_equal(3.33, foo['average_rating'].round(2))
+        assert_equal(3.13, foo['weighted_average_rating'].round(2))
+
+        bar = report.results.detect { |r| r['_id'] == 'bar' }
+        assert_equal(5, bar['reviews'])
+        assert_equal(1, bar['verified'])
+        assert_equal(4, bar['average_rating'])
+        assert_equal(3.33, bar['weighted_average_rating'].round(2))
+      end
+
+      def test_date_ranges
+        report = ReviewsByProduct.new
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(6, foo['reviews'])
+
+        report = ReviewsByProduct.new(starts_at: '2018-10-28', ends_at: '2018-10-28')
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(2, foo['reviews'])
+
+        report = ReviewsByProduct.new(starts_at: '2018-10-28', ends_at: '2018-10-29')
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(5, foo['reviews'])
+
+        report = ReviewsByProduct.new(starts_at: '2018-10-28')
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(5, foo['reviews'])
+
+        report = ReviewsByProduct.new(ends_at: '2018-10-28')
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(3, foo['reviews'])
+      end
+
+      def test_sorting
+        report = ReviewsByProduct.new(sort_by: 'average_rating', sort_direction: 'asc')
+        assert_equal('foo', report.results.first['_id'])
+
+        report = ReviewsByProduct.new(sort_by: 'average_rating', sort_direction: 'desc')
+        assert_equal('bar', report.results.first['_id'])
+
+        report = ReviewsByProduct.new(sort_by: 'reviews', sort_direction: 'desc')
+        assert_equal('foo', report.results.first['_id'])
+      end
+
+      def test_filtering
+        report = ReviewsByProduct.new(results_filter: 'unapproved')
+
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(2, foo['reviews'])
+        assert_equal(2.5, foo['average_rating'].round(2))
+        assert_equal(2.92, foo['weighted_average_rating'].round(2))
+
+        bar = report.results.detect { |r| r['_id'] == 'bar' }
+        assert_equal(3, bar['reviews'])
+        assert_equal(4.33, bar['average_rating'].round(2))
+        assert_equal(3.31, bar['weighted_average_rating'].round(2))
+
+        report = ReviewsByProduct.new(results_filter: 'approved')
+
+        foo = report.results.detect { |r| r['_id'] == 'foo' }
+        assert_equal(4, foo['reviews'])
+        assert_equal(3.75, foo['average_rating'].round(2))
+        assert_equal(3.21, foo['weighted_average_rating'].round(2))
+
+        bar = report.results.detect { |r| r['_id'] == 'bar' }
+        assert_equal(2, bar['reviews'])
+        assert_equal(3.5, bar['average_rating'])
+        assert_equal(3.08, bar['weighted_average_rating'].round(2))
+      end
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+require 'test_helper'
+
+module Workarea
+  module Reports
+    class ReviewsByUserTest < TestCase
+      setup :add_data, :time_travel
+
+      def add_data
+        create_review(email: 'foo@workarea.com', user_id: nil, rating: 4, created_at: Time.zone.local(2018, 10, 27), approved: true, verified: true)
+        create_review(email: 'foo@workarea.com', user_id: '123', rating: 3, created_at: Time.zone.local(2018, 10, 28), approved: true, verified: true)
+        create_review(email: 'foo@workarea.com', user_id: '123', rating: 4, created_at: Time.zone.local(2018, 10, 28), approved: true)
+        create_review(email: 'foo@workarea.com', user_id: nil, rating: 4, created_at: Time.zone.local(2018, 10, 29), approved: true)
+        create_review(email: 'foo@workarea.com', user_id: nil, rating: 3, created_at: Time.zone.local(2018, 10, 29), approved: false)
+        create_review(email: 'foo@workarea.com', user_id: nil, rating: 2, created_at: Time.zone.local(2018, 10, 29), approved: false)
+
+        create_review(email: 'bar@workarea.com', user_id: nil, rating: 3, created_at: Time.zone.local(2018, 10, 27), approved: true, verified: true)
+        create_review(email: 'bar@workarea.com', user_id: '456', rating: 4, created_at: Time.zone.local(2018, 10, 28), approved: true)
+        create_review(email: 'bar@workarea.com', user_id: nil, rating: 5, created_at: Time.zone.local(2018, 10, 28), approved: false)
+        create_review(email: 'bar@workarea.com', user_id: nil, rating: 5, created_at: Time.zone.local(2018, 10, 29), approved: false)
+        create_review(email: 'bar@workarea.com', user_id: nil, rating: 3, created_at: Time.zone.local(2018, 10, 29), approved: false)
+      end
+
+      def time_travel
+        travel_to Time.zone.local(2018, 10, 30)
+      end
+
+      def test_grouping_and_summing
+        report = ReviewsByUser.new
+        assert_equal(2, report.results.length)
+
+        foo = report.results.detect { |r| r['_id'] == 'foo@workarea.com' }
+        assert_equal(6, foo['reviews'])
+        assert_equal(2, foo['verified'])
+        assert_equal(3.33, foo['average_rating'].round(2))
+        assert_equal('123', foo['user_id'])
+        assert_equal(7.5, foo['activity_score'])
+
+        bar = report.results.detect { |r| r['_id'] == 'bar@workarea.com' }
+        assert_equal(5, bar['reviews'])
+        assert_equal(1, bar['verified'])
+        assert_equal(4, bar['average_rating'])
+        assert_equal('456', bar['user_id'])
+        assert_equal(5.75, bar['activity_score'])
+      end
+
+      def test_date_ranges
+        report = ReviewsByUser.new
+        foo = report.results.detect { |r| r['_id'] == 'foo@workarea.com' }
+        assert_equal(6, foo['reviews'])
+
+        report = ReviewsByUser.new(starts_at: '2018-10-28', ends_at: '2018-10-28')
+        foo = report.results.detect { |r| r['_id'] == 'foo@workarea.com' }
+        assert_equal(2, foo['reviews'])
+
+        report = ReviewsByUser.new(starts_at: '2018-10-28', ends_at: '2018-10-29')
+        foo = report.results.detect { |r| r['_id'] == 'foo@workarea.com' }
+        assert_equal(5, foo['reviews'])
+
+        report = ReviewsByUser.new(starts_at: '2018-10-28')
+        foo = report.results.detect { |r| r['_id'] == 'foo@workarea.com' }
+        assert_equal(5, foo['reviews'])
+
+        report = ReviewsByUser.new(ends_at: '2018-10-28')
+        foo = report.results.detect { |r| r['_id'] == 'foo@workarea.com' }
+        assert_equal(3, foo['reviews'])
+      end
+
+      def test_sorting
+        report = ReviewsByUser.new(sort_by: 'average_rating', sort_direction: 'asc')
+        assert_equal('foo@workarea.com', report.results.first['_id'])
+
+        report = ReviewsByUser.new(sort_by: 'average_rating', sort_direction: 'desc')
+        assert_equal('bar@workarea.com', report.results.first['_id'])
+
+        report = ReviewsByUser.new(sort_by: 'reviews', sort_direction: 'desc')
+        assert_equal('foo@workarea.com', report.results.first['_id'])
+      end
+
+      def test_filtering
+        report = ReviewsByUser.new(results_filter: 'unapproved')
+
+        foo = report.results.detect { |r| r['_id'] == 'foo@workarea.com' }
+        assert_equal(2, foo['reviews'])
+        assert_equal(2.5, foo['average_rating'].round(2))
+
+        bar = report.results.detect { |r| r['_id'] == 'bar@workarea.com' }
+        assert_equal(3, bar['reviews'])
+        assert_equal(4.33, bar['average_rating'].round(2))
+
+        report = ReviewsByUser.new(results_filter: 'approved')
+
+        foo = report.results.detect { |r| r['_id'] == 'foo@workarea.com' }
+        assert_equal(4, foo['reviews'])
+        assert_equal(3.75, foo['average_rating'].round(2))
+
+        bar = report.results.detect { |r| r['_id'] == 'bar@workarea.com' }
+        assert_equal(2, bar['reviews'])
+        assert_equal(3.5, bar['average_rating'])
+      end
+    end
+  end
+end