workarea-reviews 3.1.0

data/test/dummy/config/puma.rb

@@ -0,0 +1,47 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum, this matches the default thread size of Active Record.
+#
+threads_count = ENV.fetch('RAILS_MAX_THREADS') { 5 }.to_i
+threads threads_count, threads_count
+
+# Specifies the `port` that Puma will listen on to receive requests, default is 3000.
+#
+port        ENV.fetch('PORT') { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch('RAILS_ENV') { 'development' }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked webserver processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory. If you use this option
+# you need to make sure to reconnect any threads in the `on_worker_boot`
+# block.
+#
+# preload_app!
+
+# The code in the `on_worker_boot` will be called if you are using
+# clustered mode by specifying a number of `workers`. After each worker
+# process is booted this block will be run, if you are using `preload_app!`
+# option you will want to use this block to reconnect to any threads
+# or connections that may have been created at application boot, Ruby
+# cannot share connections between processes.
+#
+# on_worker_boot do
+#   ActiveRecord::Base.establish_connection if defined?(ActiveRecord)
+# end
+
+# Allow puma to be restarted by `rails restart` command.
+plugin :tmp_restart

data/test/dummy/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  mount Workarea::Core::Engine => '/'
+  mount Workarea::Admin::Engine => '/admin', as: 'admin'
+  mount Workarea::Storefront::Engine => '/', as: 'storefront'
+end

data/test/dummy/config/secrets.yml

@@ -0,0 +1,22 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rails secret` to generate a secure secret key.
+
+# Make sure the secrets in this file are kept private
+# if you're sharing your code publicly.
+
+development:
+  secret_key_base: 958e498ef6e641de48be17da594796b171313957cee8c4bd9012fc4bfbd1bfeca489ee8dea5a893f60f77eb8505a0739589fb87c001259dab8e86e811fb58e3b
+
+test:
+  secret_key_base: 96dce534407273cf8b9f9b7fb0a49a107350a08608622c80ee26a4f3debf9d30df5ab9276bd7460d53a60c6f25c50465ff7dd3b275a2d1983845b2dab752c60e
+
+# Do not keep production secrets in the repository,
+# instead read values from the environment.
+production:
+  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>

data/test/dummy/config/spring.rb

@@ -0,0 +1,6 @@
+%w(
+  .ruby-version
+  .rbenv-vars
+  tmp/restart.txt
+  tmp/caching-dev.txt
+).each { |path| Spring.watch(path) }

data/test/dummy/db/seeds.rb

@@ -0,0 +1,2 @@
+require 'workarea/seeds'
+Workarea::Seeds.run

data/test/factories/reviews.rb

@@ -0,0 +1,32 @@
+module Workarea
+  module Factories
+    module Reviews
+      Factories.add(self)
+
+      def create_review(overrides = {})
+        attributes = {
+          title: 'Test Product',
+          body: 'This is great.',
+          product_id: "PROD#{rand(9_999_999)}",
+          user_id: BSON::ObjectId.new,
+          approved: true,
+          rating: 4,
+          user_info: 'BC from Philadelphia'
+        }.merge(overrides)
+
+        Workarea::Review.create!(attributes)
+      end
+
+      def create_review_request(overrides = {})
+        attributes = {
+          product_id: "PROD#{rand(9_999_999)}",
+          order_id: SecureRandom.hex(5).upcase,
+          email: 'test@workarea.com',
+          send_after: Time.current
+        }.merge(overrides)
+
+        Workarea::Review::Request.create!(attributes)
+      end
+    end
+  end
+end

data/test/fixtures/reviews.csv

@@ -0,0 +1,5 @@
+product_id,rating,user_info,body,title,approved
+PROD1,3,"MD","Worked well for what I needed",,true
+PROD2,4,"BC","Exactly what I was looking for.",,false
+PROD2,5,"CH from Philadelphia","Greatest thing since avocados","OMG wow",false
+PROD3,2,"DB","Was not impressed, could have been built better.","Disappointed",true

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

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+module Workarea
+  module Storefront
+    class ReviewsHelperTest < ViewTest
+      def test_rating_stars_displays_correct_rating
+        assert_match(/1 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
+
+      def test_rating_stars_outputs_correct_number_of_stars
+        assert_equal(1, rating_stars(1).scan(/<title>star<\/title>/).size)
+        assert_equal(4, rating_stars(4.251).scan(/<title>star<\/title>/).size)
+        assert_equal(1, rating_stars(4.5).scan(/<title>half_star<\/title>/).size)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+module Workarea
+  module Admin
+    class ReviewsIntegrationTest < Workarea::IntegrationTest
+      include Admin::IntegrationTest
+
+      def test_updating_a_review
+        review = create_review(
+          product_id: product.id,
+          rating: 4,
+          approved: false
+        )
+
+        put admin.review_path(review), params: {
+          review: { body: 'foo bar', approved: true }
+        }
+
+        review.reload
+        assert_equal('foo bar', review.body)
+        assert(review.approved)
+      end
+
+      def test_deleting_a_review
+        review = create_review(product_id: product.id)
+        delete admin.review_path(review)
+        assert_empty(Review)
+      end
+
+      private
+
+      def product
+        @product ||= create_product
+      end
+    end
+  end
+end

data/test/integration/workarea/storefront/review_requests_integration_test.rb

@@ -0,0 +1,63 @@
+require 'test_helper'
+
+module Workarea
+  module Storefront
+    class ReviewRequestsIntegrationTest < Workarea::IntegrationTest
+      def test_show
+        order = create_placed_order
+
+        review_request = create_review_request(
+          product_id: create_product.id,
+          order_id: order.id,
+          email: order.email
+        )
+
+        get storefront.review_request_path(review_request.token)
+        assert(response.ok?)
+
+        review_request.complete!
+
+        get storefront.review_request_path(review_request.token)
+        assert_redirected_to(storefront.root_path)
+        assert(flash[:error].present?)
+      end
+
+      def test_complete
+        order = create_placed_order
+        product = create_product
+
+        review_request = create_review_request(
+          product_id: product.id,
+          order_id: order.id,
+          email: order.email
+        )
+
+        other_requests = Array.new(2) do
+          create_review_request(
+            product_id: '123',
+            order_id: order.id,
+            email: order.email
+          )
+        end
+
+        post storefront.complete_review_request_path(review_request.token),
+             params: {
+               review: {
+                 rating: 4,
+                 body: 'Exactly what I was looking for.'
+               }
+             }
+
+        assert_redirected_to(storefront.product_path(product))
+        assert(flash[:success].present?)
+
+        review_request.reload
+        assert(review_request.completed?)
+        assert_equal(1, Review.count)
+
+        other_requests.each(&:reload)
+        assert(other_requests.all?(&:canceled?))
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+require 'test_helper'
+
+module Workarea
+  module Storefront
+    class ReviewsIntegrationTest < Workarea::IntegrationTest
+      def user
+        @user ||= create_user(
+          email: 'test@weblinc.com',
+          password: 'w3bl1nc',
+          first_name: 'Bob',
+          last_name: 'Clams',
+        )
+      end
+
+      def product
+        @product ||= create_product
+      end
+
+      def login
+        post storefront.login_path,
+             params: {
+               email: user.email,
+               password: 'w3bl1nc'
+             }
+      end
+
+      def test_creating_a_review
+        login
+
+        post storefront.create_product_review_path(product),
+             params: {
+               review: {
+                 product_id: product.id,
+                 rating: 1,
+                 title: 'Amazing product',
+                 body: 'Totes buy this product!'
+               }
+             }
+
+        assert_redirected_to(storefront.product_path(product))
+
+        assert_equal(
+          I18n.t('workarea.storefront.reviews.flash_messages.created'),
+          flash[:success]
+        )
+      end
+
+      def test_creating_a_review_not_signed_in
+        post storefront.create_product_review_path(product),
+             params: {
+               review: {
+                 product_id: product.id,
+                 rating: 1,
+                 title: 'Amazing product',
+                 body: 'Totes buy this product!',
+                 first_name: 'Bob',
+                 last_name: 'Clams'
+               }
+             }
+
+        assert_redirected_to(storefront.product_path(product))
+
+        assert_equal(
+          I18n.t('workarea.storefront.reviews.flash_messages.created'),
+          flash[:success]
+        )
+      end
+
+      def test_create_failure
+        login
+
+        post storefront.create_product_review_path(product)
+
+        assert_equal(200, status)
+        assert_equal(
+          I18n.t('workarea.storefront.reviews.flash_messages.failure'),
+          flash[:error]
+        )
+      end
+    end
+  end
+end

data/test/javascripts/fixtures/product_review_ajax_submit.html.haml

@@ -0,0 +1,4 @@
+.view
+  = form_tag '/foo/bar', data: { product_review_ajax_submit: '' } do
+    = text_field_tag 'baz', nil, required: true
+    = submit_tag

data/test/javascripts/product_review_ajax_submit_spec.js

@@ -0,0 +1,28 @@
+//= require workarea/core/config
+//
+(function () {
+    'use strict';
+
+    describe('WORKAREA.productReviewAjaxSubmit', function () {
+        describe('init', function () {
+            var formIsInDialog = function ($form) {
+                    return ! _.isEmpty(WORKAREA.dialog.closest($form));
+                };
+
+            beforeEach(function () {
+                this.fixtures = fixture.load('product_review_ajax_submit.html');
+
+                WORKAREA.dialog.create($(this.fixtures));
+                WORKAREA.productReviewAjaxSubmit.init($(this.fixtures));
+            });
+
+            it('dialog remains if form invalid', function () {
+                expect($('form').valid()).to.equal(false);
+
+                $('form').trigger('submit');
+
+                expect(formIsInDialog($('form'))).to.equal(true);
+            });
+        });
+    });
+}());

data/test/javascripts/spec_helper.js

@@ -0,0 +1,23 @@
+//= require workarea/core/spec_helper
+//= require workarea/storefront/spec_helper
+
+//= require featurejs_rails/feature
+//= require webcomponentsjs-rails/MutationObserver
+//= require i18n
+//= require i18n/translations
+//= require local_time
+//= require lodash
+//= require jquery3
+//= require jquery-ui/core
+//= require jquery-ui/widget
+//= require jquery-ui/position
+//= require jquery-ui/widgets/mouse
+//= require jquery-ui/widgets/draggable
+//= require jquery-ui/widgets/resizable
+//= require jquery-ui/widgets/autocomplete
+//= require jquery-ui/widgets/button
+//= require jquery-ui/widgets/dialog
+//= require jquery-ui/widgets/menu
+//= require jquery.validate
+//= require waypoints/noframework.waypoints
+//= require waypoints/shortcuts/sticky

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