Merge pull request #275 from nexB/243-license-expression

Add support for License Expressions

Author: steven-esser

README.md

@@ -90,7 +90,7 @@ targeted platform.
 
 ## Testing
 
-Test functionality using:
+Test ABCM functionality using:
 
 ```bash
 $ npm test
@@ -109,4 +109,4 @@ If you have a question, a suggestion or find a bug, enter an issue.
 
 [![Gitter chat](https://badges.gitter.im/aboutcode-org/gitter.png)](https://gitter.im/aboutcode-org/discuss)
 
-For questions and chats, you can join the Gitter channel at https://gitter.im/aboutcode-org/discuss
+For questions and chats, you can join the Gitter channel at https://gitter.im/aboutcode-org/discuss

assets/app/js/aboutCodeDB.js

@@ -298,6 +298,7 @@ class AboutCodeDB {
       });
       return this.db.File.bulkCreate(files, options)
         .then(() => this.db.License.bulkCreate(this._addFileIds(files, 'licenses'), options))
+        .then(() => this.db.LicenseExpression.bulkCreate(this._addFileIdsExpressions(files, 'license_expressions'), options))
         .then(() => this.db.Copyright.bulkCreate(this._addFileIds(files, 'copyrights'), options))
         .then(() => this.db.Package.bulkCreate(this._addFileIds(files, 'packages'), options))
         .then(() => this.db.Email.bulkCreate(this._addFileIds(files, 'emails'), options))
@@ -318,8 +319,19 @@ class AboutCodeDB {
       });
     });
   }
+
+  _addFileIdsExpressions(files, attribute) {
+    return $.map(files, (file) => {
+      return $.map(file[attribute] || [], (value) => {
+        return {
+          license_expression: value,
+          fileId: file.id
+        };
+      });
+    });
+  }
 }
 
 AboutCodeDB.MissingFileInfoError = class MissingFileInfoError extends Error {};
 
-module.exports = AboutCodeDB;
+module.exports = AboutCodeDB;

assets/app/js/controllers/aboutCodeClueDataTable.js

@@ -503,6 +503,13 @@ AboutCodeClueDataTable.COPYRIGHT_COLUMNS =
 
 AboutCodeClueDataTable.LICENSE_COLUMNS =
     [
+      {
+        'data': 'license_expressions[<hr/>]',
+        'title': 'License Expressions',
+        'name': 'license_expressions',
+        'bar_chart_class': 'bar-chart-licenses',
+        'visible': false
+      },
       {
         'data': 'license_key[<hr/>]',
         'title': 'License Key',

assets/app/js/controllers/aboutCodeComponentDataTable.js

@@ -132,8 +132,8 @@ class AboutCodeComponentDataTable extends Controller {
         name: 'owner'
       },
       {
-        data: 'licenses[<hr/>].key',
-        title: 'License',
+        data: 'license_expression[<hr/>].license_expression',
+        title: 'License Expression',
         name: 'license_expression'
       },
       {

assets/app/js/controllers/componentDialog.js

@@ -29,7 +29,7 @@ class ComponentDialog extends Controller {
     this.title = this.dialog.find('.modal-title');
     this.status = this.dialog.find('#component-status');
     this.name = this.dialog.find('#component-name');
-    this.license = this.dialog.find('#component-license');
+    this.license_expression = this.dialog.find('#component-license-expression');
     this.owner = this.dialog.find('#component-owner');
     this.copyright = this.dialog.find('#component-copyright');
     this.deployed = this.dialog.find('input[name=component-deployed]');
@@ -100,8 +100,8 @@ class ComponentDialog extends Controller {
           fileId: component.fileId,
           review_status: this.status.val(),
           name: this.name.val(),
-          licenses: $.map(this.license.val() || [], (license) => {
-            return { key: license };
+          license_expression: $.map(this.license_expression.val() || [], (license_expression) => {
+            return { license_expression: license_expression };
           }),
           copyrights: $.map(this.copyright.val() || [], (copyright) => {
             return { statements: copyright.split('\n') };
@@ -147,7 +147,7 @@ class ComponentDialog extends Controller {
           this._setupStatus(component),
           this._setupName(component),
           this._setupVersion(component),
-          this._setupLicenses(component),
+          this._setupLicenseExpression(component),
           this._setupCopyrights(component),
           this._setupOwners(component),
           this._setupLanguage(component),
@@ -190,18 +190,18 @@ class ComponentDialog extends Controller {
       .then((component) => component ? component : { path: path });
   }
 
-  _setupLicenses(component) {
-    const saved = (component.licenses || []).map((license) => license.key);
-    return this._licenseQuery(component.path, 'key')
-      .then((license_keys) => license_keys.concat(saved))
-      .then((license_keys) => {
-        this.license.html('').select2({
-          data: $.unique(license_keys),
+  _setupLicenseExpression(component) {
+    const saved = (component.license_expression || []).map((license_expression) => license_expression);
+    return this._licenseExpressionQuery(component.path, 'license_expression')
+      .then((license_expressions) => license_expressions.concat(saved))
+      .then((license_expressions) => {
+        this.license_expression.html('').select2({
+          data: $.unique(license_expressions),
           multiple: true,
-          placeholder: 'Enter license',
+          placeholder: 'Enter Expression',
           tags: true
         }, true);
-        this.license.val(saved);
+        this.license_expression.val(saved);
       });
   }
 
@@ -401,6 +401,10 @@ class ComponentDialog extends Controller {
   _licenseQuery(path, field) {
     return this.db().findAllUnique(path, field, this.db().db.License);
   }
+
+  _licenseExpressionQuery(path, field) {
+    return this.db().findAllUnique(path, field, this.db().db.LicenseExpression);
+  }
 }
 
-module.exports = ComponentDialog;
+module.exports = ComponentDialog;

assets/app/js/controllers/dejacodeExportDialog.js

@@ -145,4 +145,4 @@ class DejaCodeExportDialog extends Controller {
   }
 }
 
-module.exports = DejaCodeExportDialog;
+module.exports = DejaCodeExportDialog;

assets/app/js/models/component.js

@@ -24,7 +24,7 @@ module.exports = function(sequelize, DataTypes) {
       review_status: DataTypes.STRING,
       name: DataTypes.STRING,
       version: DataTypes.STRING,
-      licenses: jsonDataType('licenses'),
+      license_expression: jsonDataType('license_expression'),
       copyrights: jsonDataType('copyrights'),
       owner: DataTypes.STRING,
       code_type: DataTypes.STRING,
@@ -41,16 +41,11 @@ module.exports = function(sequelize, DataTypes) {
     },
     {
       getterMethods: {
-        license_expression: function()  {
-          return $.map(this.licenses, (license) => {
-            return license.key;
-          }).join(' AND ');
-        },
         copyright: function() {
           return $.map(this.copyrights, (copyright) => {
             return copyright.statements.join(' ');
           }).join('\n');
         }
       }
     });
-};
+};

assets/app/js/models/database.js

@@ -17,6 +17,7 @@
 const headerModel = require('./header');
 const fileModel = require('./file');
 const licenseModel = require('./license');
+const licenseExpressionModel = require('./licenseExpression');
 const copyrightModel = require('./copyright');
 const packageModel = require('./package');
 const emailModel = require('./email');
@@ -29,6 +30,7 @@ module.exports = function(sequelize, DataTypes) {
   this.Header = headerModel(sequelize, DataTypes);
   this.File = fileModel(sequelize, DataTypes);
   this.License = licenseModel(sequelize, DataTypes);
+  this.LicenseExpression = licenseExpressionModel(sequelize, DataTypes);
   this.Copyright = copyrightModel(sequelize, DataTypes);
   this.Package = packageModel(sequelize, DataTypes);
   this.Email = emailModel(sequelize, DataTypes);
@@ -40,6 +42,7 @@ module.exports = function(sequelize, DataTypes) {
   // Define the relations
   this.Header.hasMany(this.File);
   this.File.hasMany(this.License);
+  this.File.hasMany(this.LicenseExpression);
   this.File.hasMany(this.Copyright);
   this.File.hasMany(this.Package);
   this.File.hasMany(this.Email);
@@ -49,6 +52,7 @@ module.exports = function(sequelize, DataTypes) {
   // Include Array for queries
   this.fileIncludes = [
     { model: this.License, separate: true },
+    { model: this.LicenseExpression, separate: true },
     { model: this.Copyright, separate: true },
     { model: this.Package, separate: true },
     { model: this.Email, separate: true },

assets/app/js/models/flatFile.js

@@ -31,6 +31,7 @@ module.exports = function(sequelize, DataTypes) {
       copyright_authors: jsonDataType('copyright_authors'),
       copyright_start_line: jsonDataType('copyright_start_line'),
       copyright_end_line: jsonDataType('copyright_end_line'),
+      license_expressions: jsonDataType('license_expressions'),
       license_key: jsonDataType('license_key'),
       license_score: jsonDataType('license_score'),
       license_short_name: jsonDataType('license_short_name'),
@@ -177,6 +178,7 @@ module.exports = function(sequelize, DataTypes) {
       copyright_authors: getValues(file.copyrights, 'authors'),
       copyright_start_line: getValues(file.copyrights, 'start_line'),
       copyright_end_line: getValues(file.copyrights, 'end_line'),
+      license_expressions: file.license_expressions,
       license_key: getValues(file.licenses, 'key'),
       license_score: getValues(file.licenses, 'score'),
       license_short_name: getValues(file.licenses, 'short_name'),
@@ -301,4 +303,4 @@ function getNestedValues(array, key, nestedKey) {
       return [nestedElem[nestedKey] ? nestedElem[nestedKey] : []];
     });
   });
-}
+}

assets/app/js/models/license.js

@@ -37,4 +37,4 @@ module.exports = function(sequelize, DataTypes) {
     {
       timestamps: false
     });
-};
+};