qa_server 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb899be9f195123d4e4b12780679afac70ea5322
-  data.tar.gz: a12013b8d2434dae73f9d8ccf46ce0964fa95d9e
+  metadata.gz: 9ac54427130510f4f5dc59e1359ecc154dbc2b94
+  data.tar.gz: 07b349e08fa02aab38e5b6090e16dd0df16871e5
 SHA512:
-  metadata.gz: 52e2544fe44d77e9db9e93402caf3d922bd68bbaf1cfd02c62bd26aa5615aa68ad22836797a9fd1a8bd18891592c3c3c2be5ef5d16d452823873c1bce38e91de
-  data.tar.gz: 6eba1a6ffc47017d4ee5d8e5cc58e7c4bbadd84bb8bd2937483585fe520c49f0fd16a0699e6948b7e3c364620a4044a39fa30dd0823ea5bf727bcb614bb709b9
+  metadata.gz: b804da6a0a5234a44ec0405685b6b0a948f1e9027043a0d864b935cb46cdfeb02400611d6f4d8ca391a4f6e69ab98a146f3f01a8491c6f046a1fd1b2858ad074
+  data.tar.gz: ed2f9fd29a267b4a435ac11e4e3ca4a4c41c04b3c37bdb846243dafc71d14229a7b426ca37b7cd420eb2304b9226bb32443ef4328bab1dd4046231b2b9a4a628

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 1.1.0 (2018-10-31)
+
+* allow historical data to be displayed as graph or datatable (configuration)
+* drive main nav menu from navmenu_presenter (configuration)
+* Add better install instructions in README
+
 ### 1.0.0 (2018-09-24)
 
 * drive URL base host path from qa engine mount location

data/Gemfile.lock

@@ -1,6 +1,6 @@
 GIT
   remote: https://github.com/samvera/questioning_authority.git
-  revision: e870fc07b991188053d2cd9eeb6a843b896911d8
+  revision: f44e597474cd55f64fb31a77bdb39ece81b97fa8
   branch: min_context
   specs:
     qa (2.1.1)
@@ -53,7 +53,7 @@ GEM
       activemodel (= 5.1.6)
       activesupport (= 5.1.6)
       arel (~> 8.0)
-    activerecord-import (0.25.0)
+    activerecord-import (0.27.0)
       activerecord (>= 3.2)
     activesupport (5.1.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -329,9 +329,9 @@ GEM
       sprockets (>= 2.8, < 4.0)
       sprockets-rails (>= 2.0, < 4.0)
       tilt (>= 1.1, < 3)
-    selenium-webdriver (3.14.0)
+    selenium-webdriver (3.14.1)
       childprocess (~> 0.5)
-      rubyzip (~> 1.2)
+      rubyzip (~> 1.2, >= 1.2.2)
     shex (0.5.2)
       ebnf (~> 1.1)
       json-ld (>= 2.2, < 4.0)
@@ -381,7 +381,7 @@ GEM
     websocket-driver (0.6.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.3)
-    xpath (3.1.0)
+    xpath (3.2.0)
       nokogiri (~> 1.8)
 
 PLATFORMS

data/README.md

@@ -6,6 +6,7 @@ This rails engine can be installed into your app to serve as a Questioning Autho
 * [Architecture for Authority Lookup](https://wiki.duraspace.org/x/84E2BQ) document describes the authority access and normalization layer that provides applications with a consistent output for processing.
 * [Authority aggregation and indexing](https://wiki.duraspace.org/display/ld4lLABS/Authority+aggregation+and+indexing) document describes the technology used for caching authority data.
 * [samvera/questioning_authority](https://github.com/samvera/questioning_authority) (QA) is the gem that provides access to external authorities and normalizes the results.  See the [Linked Open Data (LOD) Authorities](https://github.com/samvera/questioning_authority#linked-open-data-lod-authorities) section for details on the primary part of QA that is used by this engine.
+* [ruby-rdf/linkeddata](https://github.com/ruby-rdf/linkeddata) is a gem that processes linked data in a number of RDF formats.
 * [LD4P/linked_data_authorities](https://github.com/LD4P/linked_data_authorities) holds predefined Questioning Authority configurations that work with this qa_server engine.
 
 
@@ -20,7 +21,7 @@ Tested with...
 
 ### Prerequisites
 
-1. [ImageMagick](http://www.imagemagick.org/)
+1. [ImageMagick](http://www.imagemagick.org/) - Used to generate status charts.  Generated charts will be saved in `app/assets/images/qa_server/charts` directory.
 
 ### Installation Instructions
 
@@ -49,6 +50,8 @@ $ rails g qa_server:install
 $ rake db:migrate
 ```
 
+If upgrading instead of installing, see the Release notes for steps you may need to take manually since you won't be running the installer.
+
 #### Test the install
 
 * Start rails server with `rails s`

data/app/assets/stylesheets/qa_server/_check-status.scss

@@ -67,6 +67,11 @@ td.position {
   background-color: #ffcccc;
 }
 
+.status-neutral {
+  text-align: center;
+  background-color: #ffffff;
+}
+
 label.horizontal-list {
   padding-right: 15px;
 }

data/app/presenters/qa_server/monitor_status_presenter.rb

@@ -6,6 +6,10 @@ require 'gruff'
 # This presenter class provides all data needed by the view that monitors status of authorities.
 module QaServer
   class MonitorStatusPresenter # rubocop:disable Metrics/ClassLength
+    HISTORICAL_AUTHORITY_NAME_IDX = 0
+    HISTORICAL_FAILURE_COUNT_IDX = 1
+    HISTORICAL_PASSING_COUNT_IDX = 2
+
     # @param current_summary [ScenarioRunSummary] summary status of the latest run of test scenarios
     # @param current_data [Array<Hash>] current set of failures for the latest test run, if any
     # @param historical_summary_data [Array<Hash>] summary of past failuring runs per authority to drive chart
@@ -124,6 +128,53 @@ module QaServer
       end
     end
 
+    def historical_data_authority_name(historical_entry)
+      historical_entry[QaServer::MonitorStatusPresenter::HISTORICAL_AUTHORITY_NAME_IDX]
+    end
+
+    def days_authority_passing(historical_entry)
+      historical_entry[QaServer::MonitorStatusPresenter::HISTORICAL_PASSING_COUNT_IDX]
+    end
+
+    def days_authority_failing(historical_entry)
+      historical_entry[QaServer::MonitorStatusPresenter::HISTORICAL_FAILURE_COUNT_IDX]
+    end
+
+    def days_authority_tested(historical_entry)
+      days_authority_passing(historical_entry) + days_authority_failing(historical_entry)
+    end
+
+    def percent_authority_failing(historical_entry)
+      days_authority_failing(historical_entry).to_f / days_authority_tested(historical_entry)
+    end
+
+    def percent_authority_failing_str(historical_entry)
+      "#{percent_authority_failing(historical_entry) * 100}%"
+    end
+
+    def failure_style_class(historical_entry)
+      return "status-neutral" if days_authority_failing(historical_entry) <= 0
+      return "status-unknown" if percent_authority_failing(historical_entry) < 0.1
+      "status-bad"
+    end
+
+    def passing_style_class(historical_entry)
+      return "status-bad" if days_authority_passing(historical_entry) <= 0
+      "status-good"
+    end
+
+    def display_history_details?
+      display_historical_graph? || display_historical_datatable?
+    end
+
+    def display_historical_graph?
+      QaServer.config.display_historical_graph?
+    end
+
+    def display_historical_datatable?
+      QaServer.config.display_historical_datatable?
+    end
+
     private
 
       def graph_theme(g)

data/app/presenters/qa_server/navmenu_presenter.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+# This presenter class provides all data needed by the view that show the list of authorities.
+module QaServer
+  class NavmenuPresenter
+    include QaServer::Engine.routes.url_helpers
+
+    # @return [Array<Hash>] label-url pairs for the navigation bar's menu items justified left
+    # @example
+    #   [
+    #     { label: 'Home', url: '/' },
+    #     { label: 'Usage', url: '/usage' },
+    #     { label: 'Authorities', url: '/authorities' },
+    #     { label: 'Check Status', url: '/check_status' },
+    #     { label: 'Monitor Status', url: '/monitor_status' }
+    #   ]
+    attr_reader :leftmenu_items
+
+    # @return [Array<Hash>] label-url pairs for the navigation bar's menu items justified right
+    # @example
+    #   [
+    #     { label: 'LD4L Gateway', url: 'http://ld4l.org' }
+    #   ]
+    attr_reader :rightmenu_items
+
+    def initialize
+      @leftmenu_items = []
+      @leftmenu_items << { label: I18n.t("qa_server.menu.home"), url: root_path }
+      @leftmenu_items << { label: I18n.t("qa_server.menu.usage"), url: usage_index_path }
+      @leftmenu_items << { label: I18n.t("qa_server.menu.authorities"), url: authority_list_index_path }
+      @leftmenu_items << { label: I18n.t("qa_server.menu.check_status"), url: check_status_index_path }
+      @leftmenu_items << { label: I18n.t("qa_server.menu.monitor_status"), url: monitor_status_index_path }
+
+      @rightmenu_items = []
+      @rightmenu_items << { label: "LD4L Gateway", url: "http://ld4l.org/" }
+    end
+
+    # Append additional left justified menu items to the main navigation menu
+    # @param [Array<Hash<String,String>>] array of menu items to append with hash key = menu item label to display and hash value = URL for the menu item link
+    # @example
+    #   [
+    #     { label: 'New Item Label', url: 'http://new.item/one' },
+    #     { label: '2nd New Item Label', url: 'http://new.item/two' }
+    #   ]
+    def append_leftmenu_items(additional_items = [])
+      return if additional_items.nil?
+      additional_items.each { |item| @leftmenu_items << item }
+    end
+  end
+end

data/app/views/layouts/qa_server.html.erb

@@ -33,18 +33,17 @@
     <div class="container-fluid">
       <div class="navbar-header">
         <ul class="nav-menu">
-          <li class="left-menu"><%= link_to t("qa_server.menu.home"), main_app.root_path %></li>
-          <li class="left-menu"><%= link_to t("qa_server.menu.usage"), qa_server.usage_index_path %></li>
-          <li class="left-menu"><%= link_to t("qa_server.menu.authorities"), qa_server.authority_list_index_path %></li>
-          <li class="left-menu"><%= link_to t("qa_server.menu.check_status"), qa_server.check_status_index_path %></li>
-          <li class="left-menu"><%= link_to t("qa_server.menu.monitor_status"), qa_server.monitor_status_index_path %></li>
-          <li class="right-menu"><%= link_to "LD4L Gateway", "http://ld4l.org/" %></li>
+          <% QaServer.config.navmenu_presenter.leftmenu_items.each do |item| %>
+            <li class='left-menu'><%= link_to item[:label], item[:url] %></li>
+          <% end %>
+          <% QaServer.config.navmenu_presenter.rightmenu_items.each do |item| %>
+            <li class='right-menu'><%= link_to item[:label], item[:url] %></li>
+          <% end %>
         </ul>
       </div>
     </div>
   </nav>
 </div>
-</div>
 
 <div id="content-wrapper" class="container" role="main">
   <a name="skip_to_content"></a>

data/app/views/qa_server/monitor_status/index.html.erb

@@ -12,11 +12,11 @@
       <th><%= t('qa_server.monitor_status.summary.total_tests') %></th>
     </tr>
     <tr>
-      <td><%= @presenter.authorities_count %></td>
+      <td class="status-neutral"><%= @presenter.authorities_count %></td>
       <td class="<%= @presenter.authorities_count_style %>"><%= @presenter.failing_authorities_count %></td>
-      <td><%= @presenter.passing_tests_count%></td>
+      <td class="status-neutral"><%= @presenter.passing_tests_count%></td>
       <td class="<%= @presenter.failing_tests_style %>"><%= @presenter.failing_tests_count %></td>
-      <td><%= @presenter.tests_count %></td>
+      <td class="status-neutral"><%= @presenter.tests_count %></td>
     </tr>
   </table>
   <p class="status-update-dtstamp"><%= t('qa_server.monitor_status.summary.last_updated', date: @presenter.last_updated) %></p>
@@ -51,33 +51,35 @@
     </div>
   <% end %>
 
-  <% if @presenter.history? %>
+  <% if @presenter.history? && @presenter.display_history_details?%>
       <div id="status-section" class="status-section">
         <h2><%= t('qa_server.monitor_status.history.title') %></h2>
         <p class="status-update-dtstamp"><%= t('qa_server.monitor_status.history.since', date: @presenter.first_updated) %></p>
         <%#= column_chart @presenter.historical_summary, stacked: true, colors: ["green", "red"], xtitle: 'Authority', ytitle: 'Pass-Fail', legend: 'bottom' %>
-        <%= image_tag(@presenter.historical_graph, alt: 'History Graph Unavailable') %>
+        <% if @presenter.display_historical_graph? %>
+          <%= image_tag(@presenter.historical_graph, alt: 'History Graph Unavailable') %>
+        <% end %>
 
-<!--
-        <table class="status">
-          <tr>
-            <th><%= t('qa_server.monitor_status.history.days_failing') %></th>
-            <th><%= t('qa_server.monitor_status.history.authority') %></th>
-            <th><%= t('qa_server.monitor_status.history.subauthority') %></th>
-            <th><%= t('qa_server.monitor_status.history.service') %></th>
-            <th><%= t('qa_server.monitor_status.history.action') %></th>
-          </tr>
-          <%# @presenter.history.each do |entry| %>
-              <tr>
-                <td><%#= entry[:days_failing] %></td>
-                <td><%#= entry[:authority_name] %></td>
-                <td><%#= entry[:subauthority_name] %></td>
-                <td><%#= entry[:service] %></td>
-                <td><%#= entry[:action] %></td>
-              </tr>
-          <%# end %>
-        </table>
--->
+        <% if @presenter.display_historical_datatable? %>
+          <table class="status">
+            <tr>
+              <th><%= t('qa_server.monitor_status.history.authority') %></th>
+              <th><%= t('qa_server.monitor_status.history.days_tested') %></th>
+              <th><%= t('qa_server.monitor_status.history.days_passing') %></th>
+              <th><%= t('qa_server.monitor_status.history.days_failing') %></th>
+              <th><%= t('qa_server.monitor_status.history.percent_failing') %></th>
+            </tr>
+            <% @presenter.historical_summary.each do |entry| %>
+                <tr>
+                  <td><%= @presenter.historical_data_authority_name(entry) %></td>
+                  <td class="status-neutral"><%= @presenter.days_authority_tested(entry) %></td>
+                  <td class="<%= @presenter.passing_style_class(entry) %>"><%= @presenter.days_authority_passing(entry) %></td>
+                  <td class="<%= @presenter.failure_style_class(entry) %>"><%= @presenter.days_authority_failing(entry) %></td>
+                  <td class="<%= @presenter.failure_style_class(entry) %>"><%= @presenter.percent_authority_failing_str(entry) %></td>
+                </tr>
+            <% end %>
+          </table>
+        <% end %>
       </div>
   <% end %>
 </div>

data/config/locales/qa_server.en.yml

@@ -60,9 +60,8 @@ en:
       history:
         title:         History
         since:         'Since %{date} ET'
-        days_failing:  Days Failing
         authority:     Authority
-        subauthority:  Subauthority
-        service:       Service
-        action:        Action
-        url:           Sample URL
+        days_failing:  Days Failing
+        days_passing:  Days Passing
+        days_tested:   Days Tested
+        percent_failing: Percent Failing

data/lib/generators/qa_server/install_generator.rb

@@ -57,5 +57,10 @@ module QaServer
         "    <script src='https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js'></script>\n"
       end
     end
+
+    def create_location_for_charts
+      say_status('info', '  -- creating directory to hold dynamically generated charts', :blue)
+      copy_file 'app/assets/images/qa_server/charts/.keep'
+    end
   end
 end

data/lib/generators/qa_server/templates/config/initializers/qa_server.rb

@@ -1,4 +1,16 @@
 # frozen_string_literal: true
 QaServer.config do |config|
-  # no configurations at this time
+  # Displays a graph of historical test data when true
+  # @param [Boolean] display history graph when true
+  # config.display_historical_graph = false
+
+  # Displays a datatable of historical test data when true
+  # @param [Boolean] display history datatable when true
+  # config.display_historical_datatable = true
+
+  # Additional menu items to add to the main navigation menu's set of left justified menu items
+  # @param [Array<Hash<String,String>>] array of menu items to append with hash label: is menu item label to display and hash url: is URL for the menu item link
+  # config.navmenu_extra_leftitems = [
+  #   { label: 'Your Menu Item Label', url: 'http://your.menu.item/url' }
+  # ]
 end

data/lib/generators/qa_server/templates/config/locales/qa_server.en.yml

@@ -1,7 +1,7 @@
 ---
 en:
   qa_server:
-    application_version: "0.1.0"
+    application_version: "YOUR APPS VERSION"
     application_name:  "My Institution Lookup Service"
     footer:
       copyright_html:  "<strong>Copyright &copy; 2018 Cornell</strong> Licensed under the Apache License, Version 2.0"

data/lib/qa_server/configuration.rb

@@ -1,6 +1,34 @@
 # frozen_string_literal: true
 module QaServer
   class Configuration
-    # no configurations at this time
+    attr_writer :display_historical_graph
+    def display_historical_graph?
+      return @display_historical_graph unless @display_historical_graph.nil?
+      @display_historical_graph = false
+    end
+
+    attr_writer :display_historical_datatable
+    def display_historical_datatable?
+      return @display_historical_datatable unless @display_historical_datatable.nil?
+      @display_historical_datatable = true
+    end
+
+    # Additional menu items to add to the main navigation menu's set of left justified menu items
+    # @param [Array<Hash<String,String>>] array of menu items to append with hash key = menu item label to display and hash value = URL for the menu item link
+    # @example
+    #   [
+    #     { label: 'New Item Label', url: 'http://new.item/one' },
+    #     { label: '2nd New Item Label', url: 'http://new.item/two' }
+    #   ]
+    attr_accessor :navmenu_extra_leftitems
+
+    # Get the one and only instance of the navigation menu presenter used to construct the main navigation menu.
+    # To extend, set additional navigation menu items using #navmenu_extra_leftitems
+    def navmenu_presenter
+      return @navmenu_presenter if @navmenu_presenter.present?
+      @navmenu_presenter ||= QaServer::NavmenuPresenter.new
+      @navmenu_presenter.append_leftmenu_items(navmenu_extra_leftitems)
+      @navmenu_presenter
+    end
   end
 end

data/lib/qa_server/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module QaServer
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/qa_server.gemspec

@@ -31,7 +31,8 @@ Gem::Specification.new do |spec|
   # Produces dashboard charts on monitor status page
   spec.add_dependency 'gruff'
 
-  spec.add_development_dependency 'binding_of_caller', '~> 1.0.0' # rubocop styleguide
+  spec.add_development_dependency 'better_errors' # provide debugging command line in
+  spec.add_development_dependency 'binding_of_caller' # provides deep stack info used by better_errors
   spec.add_development_dependency 'bixby', '~> 1.0.0' # rubocop styleguide
   # spec.add_development_dependency 'capybara', '~> 2.13'
   spec.add_development_dependency 'engine_cart', '~> 2.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qa_server
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - E. Lynette Rayle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-24 00:00:00.000000000 Z
+date: 2018-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,20 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: better_errors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bixby
   requirement: !ruby/object:Gem::Requirement
@@ -202,6 +216,7 @@ files:
 - app/presenters/qa_server/authority_list_presenter.rb
 - app/presenters/qa_server/check_status_presenter.rb
 - app/presenters/qa_server/monitor_status_presenter.rb
+- app/presenters/qa_server/navmenu_presenter.rb
 - app/services/qa_server/authority_lister_service.rb
 - app/services/qa_server/authority_loader_service.rb
 - app/services/qa_server/authority_validator_service.rb
@@ -223,6 +238,7 @@ files:
 - lib/generators/qa_server/config_generator.rb
 - lib/generators/qa_server/install_generator.rb
 - lib/generators/qa_server/models_generator.rb
+- lib/generators/qa_server/templates/app/assets/images/qa_server/charts/.keep
 - lib/generators/qa_server/templates/config/authorities/linked_data/agrovoc_direct.json
 - lib/generators/qa_server/templates/config/authorities/linked_data/agrovoc_ld4l_cache.json
 - lib/generators/qa_server/templates/config/authorities/linked_data/dbpedia_direct.json