Merge pull request #284 from nexB/239-display-scancode-options

239 display scancode options

Author: steven-esser

assets/app/css/main.css

@@ -558,3 +558,21 @@ div.dataTables_scrollHead th:first-child {
 .select2-container .select2-search__field{
   width: 100% !important;
 }
+
+/*---------------------------------------
+  ScanCode modal custom
+-----------------------------------------*/
+
+body .modal-scancode {
+  width: 800px;
+}
+#scancode-info {
+  text-align: left;
+}
+#scancode-label {
+  text-align: left;
+  padding: 10px 0px 10px 0px;
+}
+#scancode-display {
+  display: block;
+}

assets/app/js/renderer.js

@@ -162,6 +162,7 @@ $(document).ready(() => {
   ipcRenderer.on('import-JSON', importJson);
   ipcRenderer.on('export-JSON', exportJson);
   ipcRenderer.on('export-JSON-components-only', exportJsonComponents);
+  ipcRenderer.on('get-ScanInfo', getScanInfo);
 
   // Opens the dashboard view when the app is first opened
   showDashboardButton.trigger('click');
@@ -204,6 +205,25 @@ $(document).ready(() => {
     return updateViews();
   }
 
+  // Get the ScanCode version and options data from the DB and populate and open the modal
+  function getScanInfo() {
+    return aboutCodeDB.sync
+      .then((db) => db.Header.findById(1)
+        .then((header) => {
+          const scancode_label = $('#scancode-info').find('#scancode-label');
+          const scancode_display = $('#scancode-info').find('#scancode-display');
+          if (header === null || header.scancode_version === null || header.scancode_options === null) {
+            scancode_label.text('Please import a ScanCode results file or an AboutCode Manager sqlite file to see the scan options.');
+            scancode_display.css('display', 'none');
+          } else {
+            scancode_label.text('This information has been extracted from your imported ScanCode JSON file:');
+            scancode_display.text('ScanCode version: ' + header.scancode_version + '\n\nScanCode options: ' + JSON.stringify(header.scancode_options, null, 2));
+            scancode_display.css('display', 'block');
+          }
+        }))
+      .then($('#myModal').modal('show'));
+  }
+
   /** Loads data for all views based on the current data */
   function updateViews() {
     return aboutCodeDB.sync

index.html

@@ -416,6 +416,27 @@ <h3>Debugging</h3>
         </div>
     </div>
 
+    <!-- ScanCode info modal -->
+    <div class="modal fade" id="myModal" role="dialog" tabindex="-1">
+        <div class="modal-dialog modal-scancode">
+            <div class="modal-content">
+                <div class="modal-header">
+                    <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
+                    <h4 class="modal-title">ScanCode Version and Options</h4>
+                </div>
+                <div class="modal-body">
+                    <div id="scancode-info">
+                        <div id="scancode-label"></div>
+                        <pre id="scancode-display"></pre>
+                    </div>
+                </div>
+                <div class="modal-footer">
+                    <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
+                </div>
+            </div><!-- /.modal-content -->
+        </div><!-- /.modal-dialog -->
+    </div><!-- /.modal -->
+
     <script>require('./assets/app/js/renderer.js');</script>
 </body>
 </html>

main.js

@@ -202,6 +202,11 @@ function getTemplate() {
           label: `AboutCode Manager Version ${packageJson.version}`,
           enabled: false
         },
+        {
+          label: 'Get ScanCode Version and Options',
+          accelerator: 'CmdOrCtrl+G',
+          click: sendEventToRenderer('get-ScanInfo')
+        },
         {
           type: 'separator'
         },