BC: improv license by jkowalleck · Pull Request #547 · CycloneDX/cyclonedx-javascript-library

jkowalleck · 2023-03-15T08:11:25Z

this is a blob of improvements for license handling.

fixes rework license models #530
fixes feat: complete SPDX expression detection #271

needs to be split and introduced separately,
some might be breaking changes or regressions.

see annotations

HISTORY.md

jkowalleck · 2023-03-15T08:12:04Z

package.json

  "dependencies": {
-    "packageurl-js": ">=0.0.6 <0.0.8 || ^1"
+    "packageurl-js": ">=0.0.6 <0.0.8 || ^1",
+    "spdx-expression-parse": "^3.0.1"


❌ new dep must be communicated in HISTORY

jkowalleck · 2023-03-15T08:12:27Z

src/factories/license.ts

@@ -23,11 +23,19 @@ import { fixupSpdxId } from '../spdx'

 export class LicenseFactory {
  makeFromString (value: string): License {


⚡ behavioral change. breaking change.

jkowalleck · 2023-03-15T08:12:50Z

src/models/license.ts

 import type { Attachment } from './attachment'

 export class LicenseExpression {
  static isEligibleExpression (expression: string | any): boolean {


jkowalleck · 2023-03-15T08:13:22Z

src/models/license.ts

-export interface OptionalNamedLicenseProperties {
-  text?: NamedLicense['text']
-  url?: NamedLicense['url']
+class DisjunctiveLicenseBase {


nonbreaking optimization

jkowalleck · 2023-03-15T08:14:59Z

tests/integration/Factories.LicenseFactory.test.js

 suite('Factories.LicenseFactory', () => {
  test('makeFromString() -> LicenseExpression', () => {
    const sut = new LicenseFactory()
+    const expression = '(MIT OR Apache-2.0)'


fix according to https://spdx.github.io/spdx-spec/v2.3/SPDX-license-list/

tsconfig.json

webpack.config.js

jkowalleck

contains breaking changes

jkowalleck · 2023-03-15T08:26:37Z

src/models/license.ts

+      return false
+    }
+    try {
+      spdxExpressionParse(expression)


behavioral change.
BREAKING CHNAGE ⚡

jkowalleck · 2023-03-16T12:15:40Z

src/factories/license.ts

  }

-  makeDisjunctiveWithName (value: string | any): NamedLicense {
+  makeNamedLicense (value: string | any): NamedLicense {


jkowalleck · 2023-03-16T12:15:49Z

src/factories/license.ts

-    const spdxId = fixupSpdxId(String(value))
-    if (undefined === spdxId) {
-      throw new RangeError('Unsupported SPDX id')
+  makeSpdxLicense (value: string | any): SpdxLicense {


jkowalleck · 2023-03-16T12:16:12Z

src/models/license.ts

+ * You may assert valid objects with {@link Factories.LicenseFactory.makeExpression | Factories.LicenseFactory.makeExpression()}.
+ */
 export class LicenseExpression {
-  static isEligibleExpression (expression: string | any): boolean {


jkowalleck · 2023-03-16T12:16:25Z

src/models/license.ts


  /**
-   * @throws {@link RangeError} if `expression` is not {@link LicenseExpression.isEligibleExpression | eligible}
+   * @throws {@link RangeError} if `expression` is empty string


jkowalleck · 2023-03-16T12:16:31Z

src/models/license.ts


  /**
-   * @throws {@link RangeError} if value is not {@link LicenseExpression.isEligibleExpression | eligible}
+   * @throws {@link RangeError} if `value` is empty string


jkowalleck · 2023-03-16T12:16:54Z

src/models/license.ts


  /**
-   * @throws {@link RangeError} if `id` is not {@link isSupportedSpdxId | supported}
+   * @throws {@link RangeError} if `id` is empy string


codacy-production · 2023-03-25T12:16:19Z

Coverage summary from Codacy

Merging #547 (8f2e1f0) into main (3d3ef13) - See PR on Codacy

Coverage variation	Diff coverage
✅ -0.14% (target: -1.00%)	✅ 94.44% (target: 90.00%)

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (`3d3ef13`)	6675	6568	98.40%
Head commit (`8f2e1f0`)	6728 (+53)	6611 (+43)	98.26% (-0.14%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#547)	108	102	94.44%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings Change summary preferences

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

src/serialize/json/normalize.ts

src/serialize/xml/normalize.ts

jkowalleck · 2023-05-15T14:12:47Z

src/models/license.ts


  /**
-   * @throws {@link RangeError} if value is not {@link isSupportedSpdxId | supported}
+   * @throws {@link RangeError} if `value` is empy string


tsconfig.json

jkowalleck commented Mar 15, 2023

View reviewed changes

jkowalleck added the breaking change label Mar 15, 2023

jkowalleck added this to the v2 milestone Mar 15, 2023

jkowalleck commented Mar 16, 2023

View reviewed changes

jkowalleck force-pushed the improv-license branch 2 times, most recently from 6281c2c to 1f35a28 Compare March 22, 2023 15:22

jkowalleck changed the title ~~Improv license~~ BC: improv license Mar 22, 2023

jkowalleck marked this pull request as ready for review March 27, 2023 22:29

jkowalleck requested a review from a team as a code owner March 27, 2023 22:29

jkowalleck force-pushed the improv-license branch 2 times, most recently from a43f5f1 to dc1f01f Compare April 5, 2023 10:44

jkowalleck added 6 commits May 15, 2023 17:02

several improvs

46115c7

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

foof

18b32e2

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

changes

b584e49

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

changes

d92a188

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

webpack config

87a3753

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

history

381a891

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

jkowalleck force-pushed the improv-license branch from dc1f01f to 2f9bb5e Compare May 15, 2023 15:22

fix

8f2e1f0

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

jkowalleck force-pushed the improv-license branch from 2f9bb5e to 8f2e1f0 Compare May 15, 2023 16:08

jkowalleck commented May 15, 2023

View reviewed changes

jkowalleck merged commit 8c467ee into main May 15, 2023

jkowalleck deleted the improv-license branch May 15, 2023 16:17

		@@ -23,11 +23,19 @@ import { fixupSpdxId } from '../spdx'

		export class LicenseFactory {
		makeFromString (value: string): License {

Uh oh!

Conversation

jkowalleck commented Mar 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jkowalleck Mar 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jkowalleck left a comment

Choose a reason for hiding this comment

Uh oh!

jkowalleck Mar 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codacy-production bot commented Mar 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage summary from Codacy

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

jkowalleck commented Mar 15, 2023 •

edited

Loading

jkowalleck Mar 15, 2023 •

edited

Loading

jkowalleck Mar 15, 2023 •

edited

Loading

codacy-production bot commented Mar 25, 2023 •

edited

Loading