@lblod/ember-rdfa-editor-lblod-plugins 2.0.1 → 2.1.0

package/CHANGELOG.md

@@ -18,6 +18,23 @@
 
 
 
+
+## 2.1.0 (2023-02-06)
+
+#### :rocket: Enhancement
+* [#98](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/pull/98) Improve citation plugin regex and improve citation type matching ([@elpoelma](https://github.com/elpoelma))
+
+#### :bug: Bug Fix
+* [#96](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/pull/96) Fix insert-citation button not being enabled in correct context. ([@elpoelma](https://github.com/elpoelma))
+* [#100](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/pull/100) Prevent splitting of besluit related nodes ([@elpoelma](https://github.com/elpoelma))
+* [#97](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/pull/97) Fix: disallow splitting of besluit node ([@elpoelma](https://github.com/elpoelma))
+
+#### :house: Internal
+* [#99](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/pull/99) Update editor to 2.1.0 ([@elpoelma](https://github.com/elpoelma))
+
+#### Committers: 1
+- Elena Poelman ([@elpoelma](https://github.com/elpoelma))
+
 ## 2.0.1 (2023-02-06)
 
 #### :bug: Bug Fix

package/addon/components/citation-plugin/citation-insert.ts

@@ -12,16 +12,20 @@ import {
   Decision,
 } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin/utils/vlaamse-codex';
 import { citedText } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin/utils/cited-text';
-import { CitationPlugin } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin';
+import {
+  CitationPlugin,
+  CitationPluginConfig,
+} from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin';
 import {
   LEGISLATION_TYPE_CONCEPTS,
   LEGISLATION_TYPES,
 } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin/utils/legislation-types';
 import { unwrap } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/option';
+import { findParentNodeOfType } from '@curvenote/prosemirror-utils';
 
 interface Args {
   controller: ProseController;
-  widgetArgs: { plugin: CitationPlugin };
+  widgetArgs: { plugin: CitationPlugin; config: CitationPluginConfig };
 }
 
 export default class EditorPluginsCitationInsertComponent extends Component<Args> {
@@ -30,6 +34,10 @@ export default class EditorPluginsCitationInsertComponent extends Component<Args
   @tracked text = '';
   @tracked legislationType: string | null = null;
 
+  get config() {
+    return this.args.widgetArgs.config;
+  }
+
   get selectedLegislationTypeUri(): string {
     return this.selectedLegislationType.value;
   }
@@ -52,13 +60,25 @@ export default class EditorPluginsCitationInsertComponent extends Component<Args
   }
 
   get disableInsert() {
-    if (!this.activeRanges || this.controller.inEmbeddedView) {
+    if (this.controller.inEmbeddedView) {
       return true;
     }
-    const { from } = this.controller.state.selection;
-    return !this.activeRanges.some(
-      ([start, end]) => from > start && from < end
-    );
+    const { selection } = this.controller.state;
+    if (this.config.type === 'ranges') {
+      const ranges = this.config.activeInRanges(this.controller.state);
+      for (const range of ranges) {
+        if (selection.from > range[0] && selection.from < range[1]) {
+          return false;
+        }
+      }
+      return true;
+    } else {
+      const nodeTypes = this.config.activeInNodeTypes(
+        this.controller.schema,
+        this.controller.state
+      );
+      return !findParentNodeOfType([...nodeTypes])(selection);
+    }
   }
 
   get plugin() {

package/addon/plugins/citation-plugin/index.ts

@@ -19,31 +19,77 @@ import { changedDescendants } from '@lblod/ember-rdfa-editor-lblod-plugins/utils
 
 const BASIC_MULTIPLANE_CHARACTER = '\u0021-\uFFFF'; // most of the characters used around the world
 
-// Regex nicely structured:
-// (
-//   (
-//     \w*decreet |
-//     omzendbrief |
-//     verdrag |
-//     grondwetswijziging |
-//     samenwerkingsakkoord |
-//     \w*wetboek |
-//     protocol |
-//     besluit[^\S\n]van[^\S\n]de[^\S\n]vlaamse[^\S\n]regering |
-//     geco[öo]rdineerde wetten |
-//     \w*wet |
-//     koninklijk[^\S\n]?besluit |
-//     ministerieel[^\S\n]?besluit |
-//     genummerd[^\S\n]?koninklijk[^\S\n]?besluit
-//   )
-//   [^\S\n]*
-//   (
-//     ([^\S\n] | [\u0021-\uFFFF\d;:'"()&\-_]){3,}
-//   )?
-// )
+/**
+ * regex for non-newline whitespace
+ */
 const NNWS = '[^\\S\\n]';
+
+/**
+ * match for a "decree"
+ */
+const DECREE = `\\w*decreet`;
+
+/**
+ * literally "letter that gets sent around"
+ */
+const MEMO = `omzendbrief`;
+const TREATY = `verdrag`;
+const CONSTITUTION_CHANGE = `grondwetswijziging`;
+/**
+ * literally "agreement to collaborate"
+ */
+const COLLAB = `samenwerkingsakkoord`;
+/**
+ * Literally "book of law", I suppose that's called a codex?
+ */
+const BOOK = `\\w*wetboek`;
+const PROTOCOL = `protocol`;
+/**
+ * match for the literal "of the flemish government"
+ */
+const VVR = `${NNWS}van${NNWS}de${NNWS}vlaamse${NNWS}regering`;
+/**
+ * match for the literal "decision of the flemish government"
+ */
+const FLEMGOV = `besluit${VVR}`;
+/**
+ * match for "coordinated laws"
+ * whatever that may be
+ */
+const COORD = `geco[öo]rdineerde${NNWS}wetten`;
+/**
+ * Matches any kind of law
+ */
+const LAW = `\\w*wet`;
+/**
+ * match for the literal "royal decision"
+ * "royal decree" might be a more meaningful translation to english, but don't read too much into these
+ * translations anyway
+ */
+const ROYAL = `koninklijk${NNWS}?besluit`;
+/**
+ * same thing as above, but for ministers
+ */
+const MINISTERIAL = `ministerieel${NNWS}?besluit`;
+/**
+ * match for "enumerated royal decision"
+ * no, we don't know the difference either
+ */
+const ENUM_ROYAL = `genummerd${NNWS}?${ROYAL}`;
+
+/**
+ * The type of citation that we need to search for
+ */
+const TYPE = `${DECREE}|${MEMO}|${TREATY}|${CONSTITUTION_CHANGE}|${COLLAB}|${BOOK}|${PROTOCOL}|${FLEMGOV}|${COORD}|${LAW}|${ROYAL}|${MINISTERIAL}|${ENUM_ROYAL}`;
+/**
+ * The monster regex that makes the citation plugin trigger.
+ * In restructuring, I've made sure that I didn't abstract away any of the capturing groups,
+ * only their content, so you can still see what's going on
+ *
+ * This regex uses named capturing groups, that's the "?<name>" syntax for easy parsing later
+ */
 export const CITATION_REGEX = new RegExp(
-  `((?<type>\\w*decreet|omzendbrief|verdrag|grondwetswijziging|samenwerkingsakkoord|\\w*wetboek|protocol|besluit${NNWS}van${NNWS}de${NNWS}vlaamse${NNWS}regering|geco[öo]rdineerde${NNWS}wetten|\\w*wet|koninklijk${NNWS}?besluit|ministerieel${NNWS}?besluit|genummerd${NNWS}?koninklijk${NNWS}?besluit|\\w*${NNWS}?besluit)${NNWS}*(?<searchTerms>(${NNWS}|[${BASIC_MULTIPLANE_CHARACTER};:'"()&-_]){3,})?)`,
+  `((?<type>${TYPE})${NNWS}*(?<searchTerms>(${NNWS}|[${BASIC_MULTIPLANE_CHARACTER};:'"()&-_]){3,})?)`,
   'uidg'
 );
 export type CitationSchema = Schema<string, 'citation'>;
@@ -116,6 +162,7 @@ export function setupCitationPlugin(
         desiredLocation: 'insertSidebar',
         componentName: 'citation-plugin/citation-insert',
         widgetArgs: {
+          config,
           plugin,
         },
       },

package/addon/plugins/citation-plugin/utils/legislation-types.ts

@@ -16,8 +16,9 @@ const LEGISLATION_TYPES = {
   samenwerkingsakkoord:
     'https://data.vlaanderen.be/id/concept/AardWetgeving/Samenwerkingsakkoord',
   wetboek: 'https://data.vlaanderen.be/id/concept/AardWetgeving/Wetboek',
+  // do not change this url without doublechecking, yes they actually did encode the ö in the url
   'gecoördineerde wetten':
-    'https://data.vlaanderen.be/id/concept/AardWetgeving/GecoordineerdeWetten',
+    'https://data.vlaanderen.be/id/concept/AardWetgeving/Geco%C3%B6rdineerde+Wet',
   'bijzondere wet':
     'https://data.vlaanderen.be/id/concept/AardWetgeving/BijzondereWet',
   'genummerd koninklijk besluit':

package/addon/plugins/citation-plugin/utils/process-match.ts

@@ -1,5 +1,5 @@
 import { isBlank } from '@ember/utils';
-import { LEGISLATION_TYPES, LegislationKey } from './legislation-types';
+import { LEGISLATION_TYPES } from './legislation-types';
 import { unwrap } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/option';
 
 const STOP_WORDS = ['het', 'de', 'van', 'tot', 'dat'];
@@ -46,7 +46,7 @@ export default function processMatch(
     )
     .join(' ');
   if (type) {
-    let typeLabel: LegislationKey;
+    let typeLabel: string;
     if (/\w+decreet/i.test(type)) {
       typeLabel = 'decreet';
       cleanedSearchTerms = `${type} ${cleanedSearchTerms}`;
@@ -59,19 +59,23 @@ export default function processMatch(
       typeLabel = 'wetboek';
     } else if (/geco[oö]rdineerde[^\S\n]wetten/i.test(type)) {
       typeLabel = 'gecoördineerde wetten';
-    } else if (/grondwetswijziging/i.test(type)) {
+    } else if (/grondwets?wijziging/i.test(type)) {
       typeLabel = 'grondwetswijziging';
     } else if (/grondwet/i.test(type)) {
       typeLabel = 'grondwet';
+    } else if (/bijzondere wet/i.test(type)) {
+      typeLabel = 'bijzondere wet';
     } else if (/\w+wet/i.test(type)) {
       typeLabel = 'wet';
       cleanedSearchTerms = `${type} ${cleanedSearchTerms}`;
     } else if (/wet/i.test(type)) {
       typeLabel = 'wet';
     } else {
-      typeLabel = 'decreet';
+      typeLabel = type.toLowerCase().trim();
     }
-    const typeUri = LEGISLATION_TYPES[typeLabel];
+    const typeUri =
+      (LEGISLATION_TYPES as Record<string, string>)[typeLabel] ||
+      LEGISLATION_TYPES['decreet'];
     return {
       text: cleanedSearchTerms,
       legislationTypeUri: typeUri,

package/addon/plugins/standard-template-plugin/utils/nodes.ts

@@ -20,6 +20,7 @@ export const title: NodeSpec = {
   content: 'paragraph+',
   inline: false,
   defining: true,
+  canSplit: false,
   attrs: {
     ...rdfaAttrs,
     property: {
@@ -49,6 +50,7 @@ export const description: NodeSpec = {
   group: 'block',
   content: 'block+',
   inline: false,
+  canSplit: false,
   attrs: {
     ...rdfaAttrs,
     property: {
@@ -78,6 +80,7 @@ export const motivering: NodeSpec = {
   group: 'block',
   content: 'block+',
   inline: false,
+  canSplit: false,
   attrs: {
     ...rdfaAttrs,
     property: {
@@ -107,6 +110,7 @@ export const article_container: NodeSpec = {
   group: 'block',
   content: '(block|besluit_article)+',
   inline: false,
+  canSplit: false,
   attrs: {
     ...rdfaAttrs,
     property: {
@@ -301,6 +305,8 @@ export const besluit: NodeSpec = {
   content: 'block*title?block*description?block*motivering?block*',
   inline: false,
   defining: true,
+  isolating: true,
+  canSplit: false,
   attrs: {
     ...rdfaAttrs,
     property: {

package/components/citation-plugin/citation-insert.d.ts

@@ -1,11 +1,12 @@
 import Component from '@glimmer/component';
 import { ProseController } from '@lblod/ember-rdfa-editor';
 import { Article, Decision } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin/utils/vlaamse-codex';
-import { CitationPlugin } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin';
+import { CitationPlugin, CitationPluginConfig } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin';
 interface Args {
     controller: ProseController;
     widgetArgs: {
         plugin: CitationPlugin;
+        config: CitationPluginConfig;
     };
 }
 export default class EditorPluginsCitationInsertComponent extends Component<Args> {
@@ -13,6 +14,7 @@ export default class EditorPluginsCitationInsertComponent extends Component<Args
     legislationTypeUri: string;
     text: string;
     legislationType: string | null;
+    get config(): CitationPluginConfig;
     get selectedLegislationTypeUri(): string;
     get selectedLegislationType(): {
         label: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lblod/ember-rdfa-editor-lblod-plugins",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Ember addon providing lblod specific plugins for the ember-rdfa-editor",
   "keywords": [
     "ember-addon",
@@ -63,7 +63,7 @@
     "@embroider/test-setup": "^1.6.0",
     "@glimmer/component": "^1.1.2",
     "@glimmer/tracking": "^1.1.2",
-    "@lblod/ember-rdfa-editor": "^2.0.1",
+    "@lblod/ember-rdfa-editor": "^2.1.0",
     "@rdfjs/types": "^1.1.0",
     "@release-it-plugins/lerna-changelog": "^5.0.0",
     "@tsconfig/ember": "^1.0.1",
@@ -152,7 +152,7 @@
     "node": "12.* || 14.* || >= 16"
   },
   "volta": {
-    "node": "16.18.1"
+    "node": "18.14.0"
   },
   "ember": {
     "edition": "octane"

package/plugins/citation-plugin/index.d.ts

@@ -1,4 +1,11 @@
 import { Decoration, DecorationSet, EditorState, InlineDecorationSpec, MarkSpec, NodeType, ProsePlugin, Schema, WidgetSpec } from '@lblod/ember-rdfa-editor';
+/**
+ * The monster regex that makes the citation plugin trigger.
+ * In restructuring, I've made sure that I didn't abstract away any of the capturing groups,
+ * only their content, so you can still see what's going on
+ *
+ * This regex uses named capturing groups, that's the "?<name>" syntax for easy parsing later
+ */
 export declare const CITATION_REGEX: RegExp;
 export type CitationSchema = Schema<string, 'citation'>;
 export interface CitationDecorationSpec extends InlineDecorationSpec {