#Feature/sort by modified for #307

.env.example

@@ -32,7 +32,7 @@ COOKIES_URL=
 EMAIL_MARKETING_MODE=false
 
 # Default scorer for new user accounts
-QUEPID_DEFAULT_SCORER=AP@10
+QUEPID_DEFAULT_SCORER=nDCG@10
 
 # Whether or not signing up via the UI is enabled.
 SIGNUP_ENABLED=true

.gitignore

@@ -43,3 +43,5 @@ public/srv
 
 # Test Reports
 test/reports
+
+.byebug_history

.rubocop.yml

@@ -17,6 +17,9 @@ AllCops:
 Naming/VariableNumber:
   Enabled: false  # we have a lot of legacy code to update
 
+Naming/MethodParameterName:
+  Enabled: false
+
 Bundler/OrderedGems:
   Enabled: false  # legacy gem file, someday.
 
@@ -30,7 +33,12 @@ Style/RedundantAssignment:
   Enabled: false # legacy stuff
 
 Style/EmptyMethod:
-  Enabled: false   
+  Enabled: false
+
+# scale.join(',') unless scale.nil? may not be good style compared to
+# scale&.join(','), but the & is very opaque to me!
+Style/SafeNavigation:
+  Enabled: false
 
 Lint/MissingSuper:
   Enabled: false # legacy stuff

Gemfile

@@ -22,7 +22,7 @@ gem 'jquery-rails'
 gem 'jquery-ui-rails' # Can we narrow the widgets to load faster?
 gem 'mysql2'
 gem 'postmark-rails', '~> 0.10.0'
-gem 'puma', '~> 3.11'
+gem 'puma', '~> 3.12'
 gem 'puma_worker_killer'
 gem 'pundit'
 gem 'rails', '~> 5.2.4', '>= 5.2.4.4'
@@ -35,6 +35,9 @@ gem 'd3-rails', '~> 3.5.5' # we have a very old version of D3.  This provides D3
 gem 'cal-heatmap-rails', '~> 3.6' # provides assets for cal heatmap, that requires old d3
 gem 'font-awesome-sass'
 
+gem 'rover-df'
+gem 'vega'
+
 group :development, :test do
   gem 'annotate'
   gem 'bullet'

Gemfile.lock

@@ -161,6 +161,7 @@ GEM
     nokogiri (1.11.2)
       mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
+    numo-narray (0.9.1.9)
     orm_adapter (0.5.0)
     parallel (1.20.1)
     parser (2.7.2.0)
@@ -228,6 +229,8 @@ GEM
       actionpack (>= 5.0)
       railties (>= 5.0)
     rexml (3.2.4)
+    rover-df (0.2.3)
+      numo-narray (>= 0.9.1.9)
     rubocop (1.6.0)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
@@ -284,6 +287,7 @@ GEM
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
     uniform_notifier (1.13.0)
+    vega (0.1.3)
     warden (1.2.9)
       rack (>= 2.0.9)
     webmock (3.10.0)
@@ -327,7 +331,7 @@ DEPENDENCIES
   mocha (~> 1.11)
   mysql2
   postmark-rails (~> 0.10.0)
-  puma (~> 3.11)
+  puma (~> 3.12)
   puma_worker_killer
   pundit
   rack-mini-profiler
@@ -336,13 +340,15 @@ DEPENDENCIES
   rails-erd (~> 1.6)
   redis (~> 4.0)
   responders
+  rover-df
   rubocop
   rubocop-rails
   sassc-rails (~> 2.1)
   sidekiq
   simplecov
   terser
   turbolinks (~> 5)
+  vega
   webmock
 
 RUBY VERSION

MULTIPLE_RATINGS_NOTES.md

@@ -0,0 +1,88 @@
+* The custom Struct for ratings is weird.
+* DONE: Need a migration to assign ALL ratings to whoever owns the case.   
+* DONE:  Need a migration to add the `case_view` column to cases.metadata.
+* back out the average stuff on the rating view on updating it.
+* When swapping between invidicual and consolidated, the front end UI doesn't refresh.
+* When you share a case with a team, we need to refresh the component for "changes ratings view" in the front end
+* Still a bug where sometimes tryNo in JS is 0, not 1!!!
+* Think about moving the variances to something like /cases/case_id/analytics/variances end point, and introduce a case_analytics_controller.rb to deal with all of that!
+
+
+
+
+# Saving for later
+
+### view
+json.ratings do
+  query.ratings_averaged.each { |rating| json.set! rating.doc_id, rating.rating }
+  Query.ratings_averaged(query.ratings).each { |rating| json.set! rating.doc_id, rating.rating }
+end
+
+### Test
+
+describe "Lets check out the rating_views" do
+           rating = {
+             doc_id: 'x123z',
+             rating: 14,
+             user_id: nil
+           }
+
+
+           test "individual view returns individual rating" do
+             put :update, params: { case_id: acase.id, query_id: query.id, rating: rating, ratings_view: 'individual' }
+             assert_response :ok
+
+             data = JSON.parse(response.body)
+             assert_equal data['rating'],    14
+           end
+
+           test "average view returns averaged rating" do
+             doc_id = 'x123z'
+             query.ratings.create(doc_id: doc_id, rating: 1, user_id: doug.id)
+             query.ratings.create(doc_id: doc_id, rating: 1, user_id: user.id)
+
+             put :update, params: { case_id: acase.id, query_id: query.id, rating: rating, ratings_view: 'average' }
+             assert_response :ok
+             #byebug
+
+             data = JSON.parse(response.body)
+             assert_equal data['rating'],  5
+           end
+
+         end
+
+### controller
+
+def update
+-          # user_id sometimes is nil and sometimes is populated
++          ratings_view  = params[:ratings_view] || :individual
++
++          # user_id sometimes is nil and sometimes is populated, and thats okay
+  @rating = @query.ratings.find_or_create_by doc_id: @doc_id, user_id: rating_params[:user_id]
+
+  if @rating.update rating_params
+    Analytics::Tracker.track_rating_created_event current_user, @rating
+-            respond_with @rating
++            if ratings_view == :individual
++              respond_with @rating
++            else
++              ratings_averaged   = Query.ratings_averaged(@query.ratings.where(doc_id: @doc_id))
++              require 'pp'
++              pp ratings_averaged
++              @rating = ratings_averaged.first
++              respond_with @rating
++            end
+  else
+    render json: @rating.errors, status: :bad_request
+  end
+
+
+
+## Discussion w/ Nate .
+
+
+Do we show the case variance stop light in INDIVIDUAL mode?
+
+If, when you change from CONSOLIDATED to INDIVIDUAL and back, maybe we just redirect you to the case and reload everything, versus trying to update in place????   I don't expect it to be super common changing, unlike say the show rated toggle.
+
+Maybe if you start rating, we single the case variance stop light to become a hollow circle to indicate the data is out of date?

README.md

@@ -195,12 +195,16 @@ To check the Ruby syntax:
 bin/docker r bundle exec rubocop
 ```
 
-Rubocop can often autocorrect many of the lint issues it runs into via `--auto-correct-all`:
+If you get `Error: `Rails` cops have been extracted to the `rubocop-rails` gem.`, it means you forgot the `bundle exec` part!
+
+Rubocop has some magic "auto correction" features for simple/common issues, so you can just run it with autocorrect enabled:
 
 ```
 bin/docker r bundle exec rubocop --auto-correct-all
 ```
 
+Now check in your fixes to GitHub!
+
 If there is a new "Cop" as they call their rules that we don't like, you can add it to the `./rubocop.yml` file.
 
 ### All Tests
@@ -489,27 +493,20 @@ heroku restart -a quepid-staging
 
 ## Seed Data
 
-The following accounts are created through the seeds. They all follow the following format:
-
-```
-email: quepid+[type]@o19s.com
-password: password
-```
-
-where type is one of the following:
-
-* `admin`: An admin account
-* `1case`: A trial user with 1 case
-* `2case`: A trial user with 2 cases
-* `solr`: A trial user with a Solr case
-* `es`: A trial user with a ES case
-* `10sOfQueries`: A trial user with a Solr case that has 10s of queries
-* `100sOfQueries`: A trial user with a Solr case that has 100s of queries (usually disabled)
-* `1000sOfQueries`: A trial user with a Solr case that has 1000s of queries (usually disabled)
-* `oscOwner`: A trial user who owns the team 'OSC'
-* `oscMember`: A trial user who is a member of the team 'OSC'
-* `CustomScorer`: A trial user who has a custom scorer
-* `CustomScorerDefault`: A trial user who has a custom scorer that is set as their default
+The following accounts are created through the seeds. They all have the same password value of _password_ ;-)
+
+* `[email protected]`: An administrator account
+* `[email protected]`: A user with 1 case
+* `[email protected]`: A user with 2 cases
+* `[email protected]`: A user with a Solr case
+* `[email protected]`: A  user with a ES case
+* `[email protected]`: A user with a Solr case that has 10s of queries
+* `[email protected]`: A user with a Solr case that has 100s of queries (usually disabled)
+* `[email protected]`: A user with a Solr case that has 1000s of queries (usually disabled)
+* `[email protected]`: Kirk is the owner of the team 'NCC-1701 Enterprise', and has rated documents
+* `[email protected]`: A member of the team 'NCC-1701 Enterprise', shares cases with Kirk
+* `[email protected]`: A user who has a custom scorer
+* `[email protected]`: A user who has a custom scorer that is set as their default
 
 # Data Map
 

app/assets/javascripts/account.js

@@ -21,3 +21,7 @@
 //= require cookies_eu
 //= require bootstrap/dist/js/bootstrap.bundle
 //= require turbolinks
+
+//= require vega
+//= require vega-lite
+//= require vega-embed

app/assets/javascripts/components/case_analytics/analytics.html

@@ -0,0 +1,9 @@
+<div>
+  <div>
+    Case Rating Variance is <strong>{{thisCase.ratingVariance}}</strong>.
+  </div>
+
+  <div class="actions">
+
+  </div>
+</div>

app/assets/javascripts/components/case_analytics/case_analytics.html

@@ -0,0 +1,29 @@
+<a class="action-icon">
+  <span
+    ng-if="ctrl.thisCase.sharedWithTeam"
+    class="matches-popper"
+    uib-popover-template="'case_analytics/analytics.html'"
+    popover-title="Case Analytics"
+    popover-trigger="outsideClick"
+    popover-placement="auto top-right"
+  >
+    <i
+      class="fa fa-circle"
+      aria-hidden="true"
+      style="vertical-align: middle; font-size: 0.3em; color:{{ctrl.varianceColour()}} !important"
+      title="Case analytics"
+      alt="Case analytics"
+    ></i>
+  </span>
+  <span
+    ng-if="!ctrl.thisCase.sharedWithTeam"
+  >
+    <i
+      class="far fa-circle"
+      aria-hidden="true"
+      style="vertical-align: middle; font-size: 0.3em;"
+      title="Share with a team to gather case analytics"
+      alt="Share with a team to gather case analytics"
+    ></i>
+  </span>
+</a>

app/assets/javascripts/components/case_analytics/case_analytics_controller.js

@@ -0,0 +1,34 @@
+'use strict';
+
+/*jshint latedef:false*/
+
+angular.module('QuepidApp')
+  .controller('CaseAnalyticsCtrl', [
+    '$scope',
+    function (
+      $scope
+    ) {
+      var ctrl = this;
+
+      ctrl.thisCase         = $scope.thisCase;
+      ctrl.varianceColour  = varianceColour;
+
+      function varianceColour() {
+        var colour = '';
+        var val = ctrl.thisCase.ratingVariance;
+        switch(true)
+        {
+            case ((val >= 0) && (val < 0.25)):
+                colour = 'SeaGreen';
+                break;
+            case ((val >= 0.25) && (val < 0.5)):
+                colour = '#dbab09';
+                break;
+            case ((val >= 0.5) && (val <= 1)):
+                colour = 'Tomato';
+                break;
+        }
+        return colour;
+      }
+    }
+  ]);

app/assets/javascripts/components/case_analytics/case_analytics_directive.js

@@ -0,0 +1,16 @@
+'use strict';
+
+angular.module('QuepidApp')
+  .directive('caseAnalytics', [
+    function () {
+      return {
+        restrict:     'E',
+        controller:   'CaseAnalyticsCtrl',
+        controllerAs: 'ctrl',
+        templateUrl:  'case_analytics/case_analytics.html',
+        scope:        {
+          thisCase: '=',
+        },
+      };
+    }
+  ]);

app/assets/javascripts/components/change_ratings_view/_modal.html

@@ -0,0 +1,22 @@
+<div class="modal-header">
+  <button type="button" class="close" aria-label="Close" ng-click="ctrl.cancel()"><span aria-hidden="true">&times;</span></button>
+  <h3 class="modal-title">Change View of Ratings for Case: <span class="modal-case">{{ ctrl.acase.caseName }}</span></h3>
+</div>
+<div class="modal-body">
+  <p>You can look at the ratings in two ways, your individual ratings and then the ratings averaged across your team.</p>
+
+  <div class="form-group">
+  <div class="list-group">
+
+    <div class="list-group">
+      <a href="" class="list-group-item" ng-repeat="ratingView in ctrl.ratingViews" ng-class="{ active: ratingView === ctrl.acase.ratingsView }" ng-click="ctrl.selectRatingView(ratingView)">
+        {{ ratingView }}
+      </a>
+    </div>
+  </div>
+  </div>
+</div>
+<div class="modal-footer">
+  <button class="btn btn-default float-left" ng-click="ctrl.cancel()">Cancel</button>
+  <button class="btn btn-primary" ng-click="ctrl.ok()">Update</button>
+</div>