workarea-reviews 3.0.8 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f30df5849c1b3184fa2814e460c4b3cdbec61c6722624c28b237a5cd0215f8b4
-  data.tar.gz: 13ada10897237548b1401d7ae6dba2d2c485ceba45b318a3bbc56812a36551d1
+  metadata.gz: a07fba40d273a1fd46dfa4575601eefe0eb742fafe6da2be58c2ca07fba3b51f
+  data.tar.gz: 9a5f40859ec940937ac073bfc976ea1e899d05864f3cdf2e2b261b25a2963410
 SHA512:
-  metadata.gz: 6328e092e60c5d984c60a55cb497ec98ac1f53f255d40c503a39bcd8eca60e567eae12fa77a9ec61580170b85fec3bd5336da8da89354313bda762eac4e5fbaf
-  data.tar.gz: '0944261e9811b0695b546ec3cc38600f6f05fbba9a672f03b4e2c0e0e1f1964a516334e568050104002f10099a21d6852ac40256aaeee35fb1373728c8244656'
+  metadata.gz: 49005ddc4805c46ff4bcb725a1c6b30d53f616b912880c6c64404c57334e31281824ea1fe3109204981fbec7db255bc327be890d2fd536ef17a9a80e42e9efb6
+  data.tar.gz: 27fc7ae007ceb0b676576a8a93e270869aa8c362d76054e15faa0863911be3872eed903604132d15382fdd52cdc5f251f21ed514b6a515a4b93c24187d2290ee

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/.gitignore

@@ -12,5 +12,4 @@ test/dummy/tmp/
 test/dummy/public/
 node_modules
 test/reports
-package.json
-yarn.lock
+.rubocop-http*

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,24 +1,36 @@
-Workarea Reviews 3.0.8 (2019-08-21)
+Workarea Reviews 3.1.2 (2020-10-30)
 --------------------------------------------------------------------------------
 
-*   Open Source!
+*   Handle reviews with user_ids that do not match a user
 
+    REVIEWS-6
+
+    Matt Duffy
 
 
-Workarea Reviews 3.0.7 (2019-06-11)
+
+Workarea Reviews 3.1.1 (2020-01-07)
 --------------------------------------------------------------------------------
 
-*   Add Rake Task for Reconciling Verified Purchasers
+*   Fix failing reviews helper test
 
-    Reviews can have a `:verified` badge associated with the content, but
-    for those upgrading to a newer version some data needs to be changed in
-    order to make this happen retroactively for older reviews. Add a Rake
-    task for adding the `:verified` field to reviews where the user actually
-    bought the product. For any reviews that are made after the upgrade,
-    this will be automatically assigned as the review is being created.
+    Idk how we didn't catch this, like, 6 years ago.
 
-    REVIEWS-146
-    Tom Scott
+    REVIEWS-5
+    Curt Howard
+
+
+
+Workarea Reviews 3.1.0 (2019-11-26)
+--------------------------------------------------------------------------------
+
+*   Updates for v3.5 compatibility
+
+    Ben Crouse
+
+*   Initial commit on master
+
+    Curt Howard
 
 
 

data/Gemfile

@@ -1,6 +1,8 @@
 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'
+gem 'byebug'
+
+gem 'workarea', github: 'workarea-commerce/workarea', branch: 'v3.5-stable'

data/Rakefile

@@ -28,13 +28,12 @@ desc "Release version #{Workarea::Reviews::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"'
-  #system 'git push origin HEAD'
+  Rake::Task['workarea:changelog'].execute
+  system 'git add CHANGELOG.md'
+  system 'git commit -m "Update CHANGELOG"'
 
   system "git tag -a v#{Workarea::Reviews::VERSION} -m 'Tagging #{Workarea::Reviews::VERSION}'"
-  system 'git push --tags'
+  system 'git push origin HEAD --follow-tags'
 
   system 'gem build workarea-reviews.gemspec'
   system "gem push workarea-reviews-#{Workarea::Reviews::VERSION}.gem"

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

@@ -0,0 +1,10 @@
+module Workarea
+  decorate Admin::ReportsController, with: :reviews do
+    def reviews_by_product
+      @report = Admin::Reports::ReviewsByProductViewModel.wrap(
+        Workarea::Reports::ReviewsByProduct.new(params),
+        view_model_options
+      )
+    end
+  end
+end

data/app/helpers/workarea/admin/reviews_helper.rb

@@ -1,11 +1,12 @@
 module Workarea
   module Admin
     module ReviewsHelper
-      def reviewer_info(model)
-        return model.user_info unless model.user_id.present?
-
-        link_to model.user_info,
-                edit_user_path(model.user_id)
+      def reviews_report_filter_options
+        [
+          [t('workarea.admin.reports.reviews_by_product.filters.all'), nil],
+          [t('workarea.admin.reports.reviews_by_product.filters.approved'), 'approved'],
+          [t('workarea.admin.reports.reviews_by_product.filters.unapproved'), 'unapproved']
+        ]
       end
     end
   end

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

@@ -6,10 +6,8 @@ module Workarea
         empty_star_count = 5 - rating.ceil
         half_star_size = (rating % 1).round(2) * 100
         half_star_width = 20 + (half_star_size - 0) * (80.0 - 20) / (100.0 - 0)
-        itemprop = options[:aggregate] ? 'aggregateRating' : 'reviewRating'
-        itemtype = options[:aggregate] ? 'http://schema.org/AggregateRating' : 'http://schema.org/Rating'
 
-        render 'workarea/storefront/products/rating', rating: rating, full_star_count: full_star_count, empty_star_count: empty_star_count, half_star_width: half_star_width, half_star_size: half_star_size, itemprop: itemprop, itemtype: itemtype
+        render 'workarea/storefront/products/rating', rating: rating, full_star_count: full_star_count, empty_star_count: empty_star_count, half_star_width: half_star_width, half_star_size: half_star_size
       end
 
       def display_purchase_requirement_message

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

@@ -0,0 +1,34 @@
+module Workarea
+  module Storefront
+    module ReviewsSchemaOrgHelper
+      def product_schema(product, related_products: nil)
+        schema = super.merge(
+          'review': product.reviews.map do |review|
+            {
+              '@type': 'Review',
+              'author': review.user_info,
+              'datePublished': review.created_at.strftime('%Y-%m-%d'),
+              'description': review.body,
+              'name': review.title,
+              'reviewRating': {
+                '@type': 'Rating',
+                'bestRating': '5',
+                'worstRating': '1',
+                'ratingValue': review.rating.round(2).to_s
+              }
+            }
+          end
+        )
+
+        if product.total_reviews > 0 && product.average_rating.present?
+          schema['aggregateRating'] = {
+            'reviewCount': product.total_reviews.to_s,
+            'ratingValue': product.average_rating.round(2).to_s
+          }
+        end
+
+        schema
+      end
+    end
+  end
+end

data/app/mailers/workarea/admin/status_report_mailer.decorator

@@ -1,7 +1,7 @@
 module Workarea
   decorate Admin::StatusReportMailer, with: :reviews do
-    def report(email, date)
-      @reviews_summary =  ReviewSummary.new
+    def report(*)
+      @reviews_summary = ReviewSummary.new
       super
     end
   end

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

@@ -0,0 +1,34 @@
+module Workarea
+  module Insights
+    class MostActiveReviewers < Base
+      class << self
+        def dashboards
+          %w(people marketing)
+        end
+
+        def generate_monthly!
+          results = generate_results
+          create!(results: results) if results.present?
+        end
+
+        def generate_results
+          report
+            .results
+            .select { |r| r['reviews'] > 0 }
+            .take(Workarea.config.insights_users_list_max_results)
+            .map { |result| result.merge(email: result['_id']) }
+        end
+
+        def report
+          Reports::ReviewsByUser.new(
+            starts_at: beginning_of_last_month,
+            ends_at: end_of_last_month,
+            sort_by: 'activity_score',
+            sort_direction: 'desc',
+            results_filter: 'approved'
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Workarea
+  module Insights
+    class MostReviewedProducts < Base
+      class << self
+        def dashboards
+          %w(marketing)
+        end
+
+        def generate_monthly!
+          results = generate_results
+          create!(results: results) if results.present?
+        end
+
+        def generate_results
+          report
+            .results
+            .select { |r| r['reviews'] > 0 }
+            .take(Workarea.config.insights_products_list_max_results)
+            .map { |result| result.merge(product_id: result['_id']) }
+        end
+
+        def report
+          Reports::ReviewsByProduct.new(
+            starts_at: beginning_of_last_month,
+            ends_at: end_of_last_month,
+            sort_by: 'reviews',
+            sort_direction: 'desc'
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Workarea
+  module Insights
+    class TopRatedProducts < Base
+      class << self
+        def dashboards
+          %w(marketing)
+        end
+
+        def generate_monthly!
+          results = generate_results
+          create!(results: results) if results.present?
+        end
+
+        def generate_results
+          report
+            .results
+            .select { |r| r['reviews'] > 0 }
+            .take(Workarea.config.insights_products_list_max_results)
+            .map { |result| result.merge(product_id: result['_id']) }
+        end
+
+        def report
+          Reports::ReviewsByProduct.new(
+            starts_at: beginning_of_last_month,
+            ends_at: end_of_last_month,
+            sort_by: 'weighted_average_rating',
+            sort_direction: 'desc'
+          )
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/review.rb

@@ -95,23 +95,12 @@ module Workarea
     # @return [Float]
     #
     def self.find_sorting_score(product_id)
-      reviews = find_for_product(product_id)
-
-      votes = [ reviews.select { |r| r.rating == 1 }.length,
-                reviews.select { |r| r.rating == 2 }.length,
-                reviews.select { |r| r.rating == 3 }.length,
-                reviews.select { |r| r.rating == 4 }.length,
-                reviews.select { |r| r.rating == 5 }.length ]
-
-      prior = [2, 2, 2, 2, 2]
-
-      posterior = votes.zip(prior).map { |a, b| a + b }
-      sum = posterior.inject { |a, b| a + b }
+      reviews = find_for_product(product_id).to_a
+      count = (1..5).each_with_object({}) do |i, memo|
+        memo[i] = reviews.select { |r| r.rating == i }.length + 2
+      end
 
-      posterior.
-        map.with_index { |v, i| (i + 1) * v }.
-        inject { |a, b| a + b }.
-        to_f / sum
+      count.sum { |rating, count| rating * count }.to_f / count.values.sum
     end
 
     def anonymous?

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

@@ -0,0 +1,86 @@
+module Workarea
+  module Reports
+    class ReviewsByProduct
+      include Report
+
+      self.reporting_class = Review
+      self.sort_fields = %w(reviews verified average_rating weighted_average_rating)
+
+      def aggregation
+        [filter_results, project_used_fields, group_by_product, project_averages]
+      end
+
+      def filter_results
+        {
+          '$match' => {
+            'created_at' => { '$gte' => starts_at, '$lte' => ends_at },
+            **approval_query
+          }
+        }
+      end
+
+      def project_used_fields
+        {
+          '$project' => {
+            'product_id' => 1,
+            'rating' => 1,
+            'verified' => 1
+          }
+        }
+      end
+
+      def group_by_product
+        {
+          '$group' => {
+            '_id' => '$product_id',
+            'reviews' => { '$sum' => 1 },
+            'verified' => { '$sum' => { '$cond' => { 'if' => '$verified', 'then' => 1, 'else' => 0 } } },
+            'rating_tally' => { '$sum' => '$rating' },
+            'rated_5' => { '$sum' => { '$cond' => { 'if' => { '$eq' => ['$rating', 5] }, 'then' => 1, 'else' => 0 } } },
+            'rated_4' => { '$sum' => { '$cond' => { 'if' => { '$eq' => ['$rating', 4] }, 'then' => 1, 'else' => 0 } } },
+            'rated_3' => { '$sum' => { '$cond' => { 'if' => { '$eq' => ['$rating', 3] }, 'then' => 1, 'else' => 0 } } },
+            'rated_2' => { '$sum' => { '$cond' => { 'if' => { '$eq' => ['$rating', 2] }, 'then' => 1, 'else' => 0 } } },
+            'rated_1' => { '$sum' => { '$cond' => { 'if' => { '$eq' => ['$rating', 1] }, 'then' => 1, 'else' => 0 } } }
+          }
+        }
+      end
+
+      def project_averages
+        {
+          '$project' => {
+            'product_id' => 1,
+            'reviews' => 1,
+            'verified' => 1,
+            'average_rating' => { '$divide' => ['$rating_tally', '$reviews'] },
+            'weighted_average_rating' => {
+              '$divide' => [
+                {
+                  '$sum' => [
+                    { '$multiply' => [{ '$sum' => [2, '$rated_5'] }, 5] },
+                    { '$multiply' => [{ '$sum' => [2, '$rated_4'] }, 4] },
+                    { '$multiply' => [{ '$sum' => [2, '$rated_3'] }, 3] },
+                    { '$multiply' => [{ '$sum' => [2, '$rated_2'] }, 2] },
+                    { '$multiply' => [{ '$sum' => [2, '$rated_1'] }, 1] }
+                  ]
+                },
+                { '$sum' => [10, '$rated_5', '$rated_4', '$rated_3', '$rated_2', '$rated_1'] }
+              ]
+            }
+          }
+        }
+      end
+
+      private
+
+      def approval_query
+        if params[:results_filter] == 'approved'
+          { approved: true }
+        elsif params[:results_filter] == 'unapproved'
+          { approved: false }
+        else
+          {}
+        end
+      end
+    end
+  end
+end