strictdoc 0.0.44a17__tar.gz → 0.0.45__tar.gz

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: strictdoc
-Version: 0.0.44a17
+Version: 0.0.45
 Summary: StrictDoc is open-source software for technical documentation and requirements management.
 Project-URL: Changelog, https://github.com/strictdoc-project/strictdoc/blob/main/CHANGELOG.md
 Project-URL: Homepage, https://strictdoc.readthedocs.io/en/stable/

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/drafts/requirements/20_high_level/21_DO178.sdoc

@@ -23,9 +23,6 @@ ELEMENTS:
   - TITLE: TAGS
     TYPE: String
     REQUIRED: False
-  - TITLE: REFS
-    TYPE: String
-    REQUIRED: False
   - TITLE: TITLE
     TYPE: String
     REQUIRED: False
@@ -38,6 +35,8 @@ ELEMENTS:
   - TITLE: COMMENT
     TYPE: String
     REQUIRED: False
+  RELATIONS:
+  - TYPE: Parent
 
 [FREETEXT]
 This document outlines a set of high-level requirements for StrictDoc, a text-based requirements management system. While StrictDoc already meets many of these requirements, further discussion is needed to clarify any remaining questions. For the outstanding requirements, we can establish a practical implementation plan within the upcoming 2023-2024 StrictDoc roadmap.

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/strictdoc/__init__.py

@@ -1,6 +1,6 @@
 from strictdoc.core.environment import SDocRuntimeEnvironment
 
-__version__ = "0.0.44a17"
+__version__ = "0.0.45"
 
 
 environment = SDocRuntimeEnvironment(__file__)

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/strictdoc/core/traceability_index.py

@@ -670,7 +670,9 @@ class TraceabilityIndex:  # pylint: disable=too-many-public-methods, too-many-in
             f"nodes: {incoming_links_sources_string}."
         )
 
-    def validate_can_create_uid(self, uid: str):
+    def validate_can_create_uid(
+        self, uid: str, existing_node_mid: Optional[MID]
+    ):
         assert isinstance(uid, str), uid
         assert len(uid) > 0, uid
 
@@ -681,6 +683,10 @@ class TraceabilityIndex:  # pylint: disable=too-many-public-methods, too-many-in
         if existing_node_with_uid is None:
             return
 
+        if existing_node_mid is not None:
+            if existing_node_with_uid.mid == existing_node_mid:
+                return
+
         raise SingleValidationError(
             "UID uniqueness validation error: "
             "There is already an existing node "

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/strictdoc/core/transforms/section.py

@@ -96,7 +96,7 @@ class UpdateSectionCommand:
         if len(form_object.section_uid) > 0:
             try:
                 traceability_index.validate_can_create_uid(
-                    form_object.section_uid
+                    form_object.section_uid, section.mid
                 )
             except SingleValidationError as validation_error_:
                 errors["section_uid"].append(validation_error_.args[0])

strictdoc-0.0.45/strictdoc/export/html/_static/controllers/copy_to_clipboard_button_controller.js

@@ -0,0 +1,90 @@
+Stimulus.register("copy_to_clipboard_button", class extends Controller {
+  connect() {
+    this.element.className = 'with_faded_button';
+
+    const clip = this.element.innerText.trim();
+
+    const copyIcon = this._createIcon(this._copyIconSVG());
+    const doneIcon = this._createIcon(this._doneIconSVG());
+    const button = this._createButton(copyIcon, doneIcon);
+
+    this.element.style.position = 'relative';
+    this.element.prepend(button);
+
+    // Add event listener
+    button.addEventListener("click", function(event){
+      event.preventDefault();
+      _updateClipboard(clip, _confirmIcon(button, copyIcon, doneIcon))
+    });
+  }
+
+  _createButton(copyIcon, doneIcon) {
+    const button = document.createElement("div");
+    button.title = "Click to copy";
+    button.className = 'action_button';
+    button.style.cssText += this._buttonCSS();
+    doneIcon.style.display = 'none';
+    button.append(copyIcon, doneIcon,);
+    return button
+  }
+
+  _buttonCSS() {
+    return `
+      position: absolute;
+      right: 4px;
+      top: 4px;
+      /* line-height: 0; */
+    `;
+  }
+
+  _createIcon(iconSVG) {
+    const icon = document.createElement('span');
+    icon.style.display = 'contents';
+    icon.innerHTML = iconSVG;
+    return icon
+  }
+
+  _copyIconSVG() {
+    return `<svg class="svg_icon" width="16px" height="16px" viewBox="0 0 16 16">
+      <g id="copyIconSVG">
+        <path d="M8,2 L12,2 C13,2 14,3 14,4 L14,8 C14,9 13,10 12,10 L8,10 C7,10 6,9 6,8 L6,4 C6,3 7,2 8,2 Z"/>
+        <path d="M10,12 C10,13 9,14 8,14 L4,14 C3,14 2,13 2,12 L2,8 C2,7 3,6 4,6"/>
+      </g>
+    </svg>`
+  }
+
+  _doneIconSVG() {
+    return `<svg class="svg_icon" width="16px" height="16px" viewBox="0 0 16 16">
+      <path d="M2.5,8.5 C2.5,8.5 3.5,9.5 6,12 C11,7 13.5,4.5 13.5,4.5"/>
+    </svg>`
+  }
+});
+
+function _updateClipboard(newClip, callback) {
+  navigator.clipboard.writeText(newClip).then(() => {
+    /* clipboard successfully set */
+    () => callback();
+    console.info('clipboard successfully set: ', newClip);
+  }, () => {
+    /* clipboard write failed */
+    console.warn('clipboard write failed');
+  });
+}
+
+function _confirmIcon(button, copyIcon, doneIcon) {
+  // initial opacity
+  let op = 1;
+  button.style.opacity = 1;
+
+  copyIcon.style.display = 'none';
+  doneIcon.style.display = 'contents';
+  const fadeTimer = setInterval(() => {
+      if (op <= 0.1){
+          clearInterval(fadeTimer);
+          copyIcon.style.display = 'contents';
+          doneIcon.style.display = 'none';
+          button.style.opacity = '';
+      }
+      op -= op * 0.1;
+  }, 30);
+}

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/strictdoc/export/html/_static/element.css

@@ -180,6 +180,18 @@ sdoc-node-controls .action_button {
   vertical-align: top;
 }
 
+/* used by copy_to_clipboard controller */
+
+/* TODO improve class name .with_faded_button */
+.with_faded_button > .action_button {
+  transition: .5s ease-out;
+  opacity: 0;
+}
+
+.with_faded_button:hover > .action_button {
+  opacity: 1;
+}
+
 /* ANCHOR */
 
 sdoc-anchor {

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/strictdoc/export/html/_static/layout.css

@@ -70,28 +70,44 @@
   font-weight: bold;
 }
 
-/* connection_status */
+/* messages */
 
-.connection_status {
+.mars {
   position: fixed;
   z-index: 1111;
-  top: 50%;
-  left: 2rem;
-  right: 2rem;
-  /* left: 1rem; */
-
-  /* background: rgba(255, 255, 255, 0.6);
-  -webkit-backdrop-filter: blur(8px);
-  box-shadow: 0 8px 24px rgba(0,0,0,.3);
-  backdrop-filter: blur(8px); */
+  top: 0;
+  bottom: 0;
+  left: 0;
+  right: 0;
+  pointer-events: none;
+
+  display: flex;
+  justify-content: center;
+  /* align-items: flex-end */
+  align-items: center;
+
+  padding: calc(var(--base-rhythm)*10);
+}
 
-  box-shadow: 0 8px 32px rgba(0,0,0,.3);
-  background: #fff;
+/* <sdoc-toast> */
 
-  border-radius: 2rem;
+sdoc-toast {
+  pointer-events: initial;
   text-align: center;
+  border-radius: var(--base-rhythm);
+  box-shadow: 0 8px 32px rgba(0,0,0,.3);
+  background: var(--color-bg-ui);
+  color: var(--color-fg-secondary-invert);
 }
 
-.connection_status:not(:empty) {
+sdoc-toast:not(:empty) {
   padding: .75rem 2rem;
 }
+
+sdoc-toast a:link {
+  color: var(--color-bg-contrast);
+}
+
+sdoc-toast a:hover {
+  color: var(--color-fg-accent);
+}

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/strictdoc/export/html/templates/base.jinja.html

@@ -30,7 +30,9 @@
 
 <body data-viewtype="{%- block viewtype -%}{%- endblock viewtype -%}" data-turbo="false">
 
+<div class="mars">
   {%- include "websocket.jinja.html" -%}
+</div>
 
   <div class="layout" id="layout">
 

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/strictdoc/export/html/templates/components/node/index.jinja

@@ -21,14 +21,18 @@
   <sdoc-node
     {%- if project_config.is_running_on_server %}
       data-editable_node="on"
+      {%- if sdoc_entity.is_section %}
       data-controller="anchor_controller"
+      {%- endif %}
     {%- endif %}
     node-role="{{ sdoc_entity.get_type_string() }}"
     data-testid="node-{{ sdoc_entity.get_type_string() }}"
   >
 
+    {%- if sdoc_entity.is_section %}
     {# anchor #}
     {% include "components/anchor/index.jinja" %}
+    {%- endif %}
 
     {# sdoc_entity #}
     {% block sdoc_entity %}

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/strictdoc/export/html/templates/components/requirement/comments/index.jinja

@@ -3,7 +3,10 @@
 {%- if requirement.comments %}
   {%- for comment in requirement.comments %}
     <sdoc-requirement-field-label>comment:</sdoc-requirement-field-label>
-    <sdoc-requirement-field data-field-label="comment">
+    <sdoc-requirement-field
+      data-field-label="comment"
+      data-controller="copy_to_clipboard_button"
+    >
       {{ renderer.render_comment(comment) }}
     </sdoc-requirement-field>
   {%- endfor %}

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/strictdoc/export/html/templates/components/requirement/meta/index.jinja

@@ -1,8 +1,10 @@
 {%- if requirement.has_meta -%}
   {% for meta_field in requirement.enumerate_meta_fields(skip_multi_lines=True) %}
     <sdoc-requirement-field-label>{{ meta_field[0] }}:</sdoc-requirement-field-label>
-    <sdoc-requirement-field data-field-type="singleline" data-field-label="{{ meta_field[0] }}">
-      {{ meta_field[1] }}
-    </sdoc-requirement-field>
+    <sdoc-requirement-field
+      data-field-type="singleline"
+      data-field-label="{{ meta_field[0] }}"
+      data-controller="copy_to_clipboard_button"
+    >{{ meta_field[1] }}</sdoc-requirement-field>
   {% endfor %}
 {%- endif %}

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/strictdoc/export/html/templates/components/requirement/multiline/index.jinja

@@ -1,8 +1,12 @@
 {# multiline fields #}
+{# goes through all UNRESERVED fields #}
 {%- if requirement.has_meta %}
   {% for meta_field in requirement.enumerate_meta_fields(skip_single_lines=True) %}
     <sdoc-requirement-field-label>{{ meta_field[0] }}:</sdoc-requirement-field-label>
-    <sdoc-requirement-field data-field-label="{{ meta_field[0] }}">
+    <sdoc-requirement-field
+      data-field-label="{{ meta_field[0] }}"
+      data-controller="copy_to_clipboard_button"
+    >
       {{ renderer.render_meta_value(meta_field[1]) }}
     </sdoc-requirement-field>
   {%- endfor %}

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/strictdoc/export/html/templates/components/requirement/rationale/index.jinja

@@ -1,6 +1,9 @@
 {%- if requirement.rationale -%}
   <sdoc-requirement-field-label>rationale:</sdoc-requirement-field-label>
-  <sdoc-requirement-field data-field-label="rationale">
+  <sdoc-requirement-field
+    data-field-label="rationale"
+    data-controller="copy_to_clipboard_button"
+  >
     {{ renderer.render_requirement_rationale(requirement) }}
   </sdoc-requirement-field>
 {%- endif -%}

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/strictdoc/export/html/templates/components/requirement/statement/index.jinja

@@ -7,7 +7,10 @@
   {%- else -%}
     {# default with label #}
     <sdoc-requirement-field-label>statement:</sdoc-requirement-field-label>
-    <sdoc-requirement-field data-field-label="statement">
+    <sdoc-requirement-field
+      data-field-label="statement"
+      data-controller="copy_to_clipboard_button"
+    >
       {{ renderer.render_requirement_statement(requirement) }}
     </sdoc-requirement-field>
   {%- endif -%}

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/strictdoc/export/html/templates/components/requirement/title/index.jinja

@@ -1,5 +1,5 @@
 {%- if requirement.reserved_title %}
-  <sdoc-requirement-title>
+  <sdoc-requirement-title data-controller="copy_to_clipboard_button">
     {# title number #}
     {%- if title_number is true -%}
       {%- if requirement.context.title_number_string %}

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/strictdoc/export/html/templates/components/requirement/uid/index.jinja

@@ -1,5 +1,5 @@
 {%- if requirement.reserved_uid %}
-  <sdoc-requirement-uid>
+  <sdoc-requirement-uid data-controller="copy_to_clipboard_button">
   {{ requirement.reserved_uid }}
   </sdoc-requirement-uid>
 {%- endif -%}

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/strictdoc/export/html/templates/components/section/h/index.jinja

@@ -1,6 +1,7 @@
 {# title // required field for section #}
 <sdoc-section-title
   data-level="{{ section.context.title_number_string }}"
+  data-controller="copy_to_clipboard_button"
 >
   {%  set h_level = section.ng_level + 1
       if section.ng_level < 6

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/strictdoc/export/html/templates/components/section/text/index.jinja

@@ -1,7 +1,7 @@
 {# TODO: change to 'text' #}
 {%- if section.free_texts -%}
   {%- for free_text in section.free_texts -%}
-  <sdoc-section-text>
+  <sdoc-section-text data-controller="copy_to_clipboard_button">
     {{ renderer.render_free_text(document_type, free_text) }}
   </sdoc-section-text>
   {%- endfor -%}

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/strictdoc/export/html/templates/components/section/title/index.jinja

@@ -1,6 +1,7 @@
 {# title // required field for section #}
 <sdoc-section-title
   data-level="{{ section.context.title_number_string }}"
+  data-controller="copy_to_clipboard_button"
 >
     {%- if section.context.title_number_string -%}
       {{ section.context.title_number_string }}.&nbsp;

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/strictdoc/export/html/templates/components/section/uid/index.jinja

@@ -1,6 +1,6 @@
 {%- if section.reserved_uid is not none and section.reserved_uid|length > 0 -%}
 <sdoc-meta>
   <sdoc-meta-label>UID:</sdoc-meta-label>
-  <sdoc-meta-field>{{ section.reserved_uid }}</sdoc-meta-field>
+  <sdoc-meta-field data-controller="copy_to_clipboard_button">{{ section.reserved_uid }}</sdoc-meta-field>
 </sdoc-meta>
 {%- endif %}

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/strictdoc/export/html/templates/screens/document/document/index.jinja

@@ -30,6 +30,7 @@
   <script type="module" src="{{ link_renderer.render_static_url('controllers/modal_controller.js') }}"></script>
   <script type="module" src="{{ link_renderer.render_static_url('controllers/scroll_into_view_controller.js') }}"></script>
   <script type="module" src="{{ link_renderer.render_static_url('controllers/tabs_controller.js') }}"></script>
+  <script type="module" src="{{ link_renderer.render_static_url('controllers/copy_to_clipboard_button_controller.js') }}"></script>
   {%- endif -%}
 
   {%- if project_config.is_activated_mathjax() -%}

{strictdoc-0.0.44a17 → strictdoc-0.0.45}/strictdoc/export/html/templates/websocket.jinja.html

@@ -1,7 +1,7 @@
 {%- if project_config.is_running_on_server -%}
 
 {# It is important that there are no spaces within this element #connection_status: #}
-<div id="connection_status" class="connection_status"></div>
+<sdoc-toast id="connection_status"></sdoc-toast>
 
 <script>
   var clientId = Date.now();