RubyGems - decidim-collaborative_texts - Versions diffs - 0.31.0.rc1 - Mend

decidim-collaborative_texts 0.31.0.rc1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (159) hide show

checksums.yaml +7 -0
data/README.md +24 -0
data/Rakefile +3 -0
data/app/cells/decidim/collaborative_texts/document_cell.rb +23 -0
data/app/cells/decidim/collaborative_texts/document_l_cell.rb +15 -0
data/app/commands/decidim/collaborative_texts/admin/create_document.rb +25 -0
data/app/commands/decidim/collaborative_texts/admin/publish_document.rb +52 -0
data/app/commands/decidim/collaborative_texts/admin/unpublish_document.rb +44 -0
data/app/commands/decidim/collaborative_texts/admin/update_document.rb +101 -0
data/app/commands/decidim/collaborative_texts/admin/update_document_settings.rb +13 -0
data/app/commands/decidim/collaborative_texts/create_suggestion.rb +28 -0
data/app/commands/decidim/collaborative_texts/rollout.rb +50 -0
data/app/controllers/concerns/decidim/collaborative_texts/admin/filterable.rb +23 -0
data/app/controllers/decidim/collaborative_texts/admin/application_controller.rb +15 -0
data/app/controllers/decidim/collaborative_texts/admin/documents_controller.rb +142 -0
data/app/controllers/decidim/collaborative_texts/application_controller.rb +14 -0
data/app/controllers/decidim/collaborative_texts/documents_controller.rb +57 -0
data/app/controllers/decidim/collaborative_texts/suggestions_controller.rb +55 -0
data/app/events/decidim/collaborative_texts/suggestion_accepted_event.rb +6 -0
data/app/forms/decidim/collaborative_texts/admin/document_form.rb +29 -0
data/app/forms/decidim/collaborative_texts/rollout_form.rb +26 -0
data/app/forms/decidim/collaborative_texts/suggestion_form.rb +42 -0
data/app/helpers/decidim/collaborative_texts/application_helper.rb +20 -0
data/app/models/decidim/collaborative_texts/application_record.rb +10 -0
data/app/models/decidim/collaborative_texts/document.rb +78 -0
data/app/models/decidim/collaborative_texts/suggestion.rb +36 -0
data/app/models/decidim/collaborative_texts/version.rb +35 -0
data/app/packs/entrypoints/decidim_collaborative_texts.js +7 -0
data/app/packs/images/decidim/collaborative_texts/decidim_collaborative_texts.svg +1 -0
data/app/packs/src/decidim/collaborative_texts/document.js +168 -0
data/app/packs/src/decidim/collaborative_texts/editor.js +80 -0
data/app/packs/src/decidim/collaborative_texts/init_documents.js +27 -0
data/app/packs/src/decidim/collaborative_texts/manager.js +106 -0
data/app/packs/src/decidim/collaborative_texts/selection.js +106 -0
data/app/packs/src/decidim/collaborative_texts/suggestion.js +243 -0
data/app/packs/src/decidim/collaborative_texts/suggestions_list.js +103 -0
data/app/packs/src/decidim/collaborative_texts/test/document.test.js +83 -0
data/app/packs/src/decidim/collaborative_texts/test/manager.test.js +149 -0
data/app/packs/src/decidim/collaborative_texts/test/selection.test.js +125 -0
data/app/packs/src/decidim/collaborative_texts/test/suggestions.test.js +233 -0
data/app/packs/src/decidim/collaborative_texts/test/toc.test.js +70 -0
data/app/packs/src/decidim/collaborative_texts/toc.js +48 -0
data/app/packs/stylesheets/decidim/collaborative_texts/collaborative_texts.scss +287 -0
data/app/permissions/decidim/collaborative_texts/admin/permissions.rb +28 -0
data/app/permissions/decidim/collaborative_texts/permissions.rb +36 -0
data/app/presenters/decidim/collaborative_texts/admin_log/document_presenter.rb +54 -0
data/app/presenters/decidim/collaborative_texts/admin_log/suggestion_presenter.rb +62 -0
data/app/presenters/decidim/collaborative_texts/admin_log/suggestion_resource_presenter.rb +20 -0
data/app/presenters/decidim/collaborative_texts/admin_log/version_presenter.rb +53 -0
data/app/presenters/decidim/collaborative_texts/official_author_presenter.rb +11 -0
data/app/presenters/decidim/collaborative_texts/suggestion_presenter.rb +57 -0
data/app/views/decidim/collaborative_texts/admin/documents/_actions.html.erb +82 -0
data/app/views/decidim/collaborative_texts/admin/documents/_document-tr.html.erb +15 -0
data/app/views/decidim/collaborative_texts/admin/documents/_documents-thead.html.erb +7 -0
data/app/views/decidim/collaborative_texts/admin/documents/_draft_options.html.erb +6 -0
data/app/views/decidim/collaborative_texts/admin/documents/_form.html.erb +16 -0
data/app/views/decidim/collaborative_texts/admin/documents/_non_draft_options.html.erb +9 -0
data/app/views/decidim/collaborative_texts/admin/documents/_versions.html.erb +18 -0
data/app/views/decidim/collaborative_texts/admin/documents/edit.html.erb +33 -0
data/app/views/decidim/collaborative_texts/admin/documents/edit_settings.html.erb +18 -0
data/app/views/decidim/collaborative_texts/admin/documents/index.html.erb +32 -0
data/app/views/decidim/collaborative_texts/admin/documents/manage_trash.html.erb +19 -0
data/app/views/decidim/collaborative_texts/admin/documents/new.html.erb +18 -0
data/app/views/decidim/collaborative_texts/admin/settings/_form.html.erb +9 -0
data/app/views/decidim/collaborative_texts/documents/_editor_template.html.erb +15 -0
data/app/views/decidim/collaborative_texts/documents/_manager.html.erb +9 -0
data/app/views/decidim/collaborative_texts/documents/_suggestions_box_item_template.html.erb +33 -0
data/app/views/decidim/collaborative_texts/documents/_suggestions_box_template.html.erb +20 -0
data/app/views/decidim/collaborative_texts/documents/index.html.erb +29 -0
data/app/views/decidim/collaborative_texts/documents/show.html.erb +70 -0
data/config/assets.rb +8 -0
data/config/locales/am-ET.yml +1 -0
data/config/locales/ar.yml +1 -0
data/config/locales/bg.yml +1 -0
data/config/locales/bn-BD.yml +1 -0
data/config/locales/bs-BA.yml +1 -0
data/config/locales/ca-IT.yml +154 -0
data/config/locales/ca.yml +154 -0
data/config/locales/cs.yml +122 -0
data/config/locales/da.yml +1 -0
data/config/locales/de.yml +154 -0
data/config/locales/el.yml +1 -0
data/config/locales/en.yml +154 -0
data/config/locales/eo.yml +1 -0
data/config/locales/es-MX.yml +154 -0
data/config/locales/es-PY.yml +154 -0
data/config/locales/es.yml +154 -0
data/config/locales/et.yml +1 -0
data/config/locales/eu.yml +154 -0
data/config/locales/fa-IR.yml +1 -0
data/config/locales/fi-plain.yml +154 -0
data/config/locales/fi.yml +154 -0
data/config/locales/fr-CA.yml +125 -0
data/config/locales/fr.yml +125 -0
data/config/locales/ga-IE.yml +1 -0
data/config/locales/gl.yml +1 -0
data/config/locales/gn-PY.yml +1 -0
data/config/locales/he-IL.yml +1 -0
data/config/locales/hr.yml +1 -0
data/config/locales/hu.yml +1 -0
data/config/locales/id-ID.yml +1 -0
data/config/locales/is-IS.yml +1 -0
data/config/locales/it.yml +1 -0
data/config/locales/ja.yml +153 -0
data/config/locales/ka-GE.yml +1 -0
data/config/locales/kaa.yml +1 -0
data/config/locales/ko.yml +1 -0
data/config/locales/lb.yml +1 -0
data/config/locales/lo-LA.yml +1 -0
data/config/locales/lt.yml +1 -0
data/config/locales/lv.yml +1 -0
data/config/locales/mt.yml +1 -0
data/config/locales/nl.yml +1 -0
data/config/locales/no.yml +6 -0
data/config/locales/oc-FR.yml +1 -0
data/config/locales/om-ET.yml +1 -0
data/config/locales/pl.yml +1 -0
data/config/locales/pt-BR.yml +1 -0
data/config/locales/pt.yml +1 -0
data/config/locales/ro-RO.yml +89 -0
data/config/locales/ru.yml +1 -0
data/config/locales/si-LK.yml +1 -0
data/config/locales/sk.yml +1 -0
data/config/locales/sl.yml +1 -0
data/config/locales/so-SO.yml +1 -0
data/config/locales/sq-AL.yml +1 -0
data/config/locales/sr-CS.yml +1 -0
data/config/locales/sv.yml +117 -0
data/config/locales/sw-KE.yml +1 -0
data/config/locales/th-TH.yml +1 -0
data/config/locales/ti-ER.yml +1 -0
data/config/locales/tr-TR.yml +69 -0
data/config/locales/uk.yml +1 -0
data/config/locales/val-ES.yml +1 -0
data/config/locales/vi.yml +1 -0
data/config/locales/zh-CN.yml +1 -0
data/config/locales/zh-TW.yml +1 -0
data/db/migrate/20250205215038_create_decidim_collaborative_texts_documents.rb +16 -0
data/db/migrate/20250213113536_create_collaborative_texts_versions.rb +13 -0
data/db/migrate/20250227204839_create_collaborative_texts_suggestions.rb +13 -0
data/db/migrate/20250312140133_add_counter_caches_to_collaborative_texts_documents.rb +13 -0
data/db/migrate/20250408205231_add_counter_caches_to_collaborative_text_versions.rb +8 -0
data/decidim-collaborative_texts.gemspec +36 -0
data/lib/decidim/api/document_input_filter.rb +29 -0
data/lib/decidim/api/document_input_sort.rb +14 -0
data/lib/decidim/api/document_type.rb +31 -0
data/lib/decidim/api/documents_type.rb +39 -0
data/lib/decidim/api/suggestion_type.rb +18 -0
data/lib/decidim/api/version_type.rb +21 -0
data/lib/decidim/collaborative_texts/admin.rb +10 -0
data/lib/decidim/collaborative_texts/admin_engine.rb +34 -0
data/lib/decidim/collaborative_texts/api.rb +12 -0
data/lib/decidim/collaborative_texts/component.rb +54 -0
data/lib/decidim/collaborative_texts/engine.rb +28 -0
data/lib/decidim/collaborative_texts/seeds.rb +117 -0
data/lib/decidim/collaborative_texts/test/factories.rb +80 -0
data/lib/decidim/collaborative_texts/version.rb +9 -0
data/lib/decidim/collaborative_texts.rb +13 -0
metadata +233 -0

data/app/packs/src/decidim/collaborative_texts/test/manager.test.js ADDED Viewed

@@ -0,0 +1,149 @@
+/* eslint-disable prefer-reflect */
+/* global global, jest, process */
+import Manager from "src/decidim/collaborative_texts/manager";
+// Create the configuration object to make the configurations available for the tests
+window.Decidim = {}
+class DummyDialog {
+  constructor(element) { this.element = element; }
+  open() { this.element.dataset.dialogOpen = true; }
+  close() { this.element.dataset.dialogOpen = null; }
+}
+describe("Manager", () => {
+  const content = `
+  <body>
+    <div class="collaborative-texts-manager hidden">
+      <div>
+        <button data-collaborative-texts-manager-rollout="true">Rollout</button>
+        <button data-collaborative-texts-manager-consolidate="true">Consolidate</button>
+        <button data-collaborative-texts-manager-cancel="true">Cancel</button>
+      </div>
+      <div class="collaborative-texts-manager-counters">
+        Applied: <span class="collaborative-texts-manager-applied"></span>
+        Pending: <span class="collaborative-texts-manager-pending"></span>
+      </div>
+    </div>
+    <div data-collaborative-texts-document="true"
+        data-collaborative-texts-i18n='{}'
+        data-collaborative-texts-suggestions-url="#"
+        data-collaborative-texts-rollout-url="rolloutUrl">
+      <h2 id="node-1">This is a collaborative text</h2><p>Some content</p>
+      <div class="collaborative-texts-ignored"><h2>Ignored content</h2></div>
+      <div class="collaborative-texts-changes"><h2 id="node-2">This is another title</h2><ul><li>More content</li><li>Event more content</li></ul></div>
+    </div>
+    <div id="confirm-modal" data-dialog="confirm-modal">
+      <div id="confirm-modal" data-dialog="confirm-modal">
+        <div id="confirm-modal-content">
+          <div data-dialog-container>
+            <div data-confirm-modal-content></div>
+          </div>
+          <div data-dialog-actions>
+            <button data-confirm-cancel data-dialog-close="confirm-modal">Cancel</button>
+            <button data-confirm-ok>Ok</button>
+          </div>
+        </div>
+      </div>
+    </div>
+  </body>
+`;
+  let manager = null;
+  let doc = null;
+  let suggestions = [
+    {
+      id: 1,
+      title: "Suggestion 1",
+      status: "pending",
+      restore: jest.fn()
+    },
+    {
+      id: 2,
+      title: "Suggestion 2",
+      status: "applied",
+      restore: jest.fn()
+    }
+  ];
+  const fetchResult = {
+    redirect: "#redirect-somewhere"
+  }
+  global.fetch = jest.fn(() =>
+    Promise.resolve({
+      ok: true,
+      json: () => Promise.resolve(fetchResult)
+    })
+  );
+  beforeEach(() => {
+    window.Decidim.currentDialogs = {
+      "confirm-modal": new DummyDialog(document.querySelector("#confirm-modal"))
+    };
+    document.body.innerHTML = content;
+    delete global.window.location;
+    global.window = Object.create(window);
+    global.window.location = {
+      href: "test-url"
+    };
+    doc = {
+      doc: document.querySelector("[data-collaborative-texts-document]"),
+      suggestionsList: {
+        suggestions: suggestions,
+        getApplied: () => {
+          return suggestions.filter((suggestion) => suggestion.status === "applied");
+        },
+        getPending: () => {
+          return suggestions.filter((suggestion) => suggestion.status === "pending");
+        }
+      },
+      i18N: {
+        rolloutConfirm: "Confirm rollout",
+        consolidateConfirm: "Confirm consolidate"
+      }
+    }
+    manager = new Manager(doc);
+  });
+  it("shows the manager", () => {
+    manager.show();
+    expect(manager.div.classList.contains("hidden")).toBe(false);
+  });
+  it("hides the manager", () => {
+    manager.hide();
+    expect(manager.div.classList.contains("hidden")).toBe(true);
+  });
+  it("updates the counters", () => {
+    manager.updateCounters(1, 2);
+    expect(manager.counters.applied[0].textContent).toBe("1");
+    expect(manager.counters.pending[0].textContent).toBe("2");
+  });
+  it("cancels the suggestions", () => {
+    manager.cancel();
+    expect(suggestions[0].restore).toHaveBeenCalled();
+    expect(suggestions[1].restore).toHaveBeenCalled();
+    expect(manager.div.classList.contains("hidden")).toBe(true);
+  });
+  it("gets a new body with applied changes", () => {
+    const cleanedBody = manager.cleanBody();
+    expect(cleanedBody).toBe("<h2 id=\"node-1\">This is a collaborative text</h2><p>Some content</p><h2 id=\"node-2\">This is another title</h2><ul><li>More content</li><li>Event more content</li></ul>");
+  });
+  it("rollouts the suggestions", async () => {
+    const rolloutButton = manager.rolloutButton;
+    rolloutButton.click();
+    window.document.querySelector("[data-confirm-ok]").click();
+    await new Promise(process.nextTick);
+    expect(global.location.href).toBe(fetchResult.redirect);
+  });
+});

data/app/packs/src/decidim/collaborative_texts/test/selection.test.js ADDED Viewed

@@ -0,0 +1,125 @@
+/* global global, jest */
+import Document from "src/decidim/collaborative_texts/document";
+import Selection from "src/decidim/collaborative_texts/selection";
+import Editor from "src/decidim/collaborative_texts/editor";
+describe("Selection", () => {
+  let i18n = {test: "test"};
+  let suggestionsUrl = "http://example.com/suggestions";
+  let rolloutUrl = "http://example.com/rollout";
+  const content = `
+    <body>
+      <div class="collaborative-texts-alert hidden">
+        <div></div>
+      </div>
+      <div data-collaborative-texts-document="true"
+         data-collaborative-texts-suggestions-editor-template="#collaborative-texts-editor-template"
+         data-collaborative-texts-suggestions-box-template="#collaborative-texts-suggestions-box-template"
+         data-collaborative-texts-suggestions-box-item-template="#collaborative-texts-suggestions-box-item-template"
+         data-collaborative-texts-i18n='${JSON.stringify(i18n)}'
+         data-collaborative-texts-suggestions-url="${suggestionsUrl}"
+         data-collaborative-texts-rollout-url="${rolloutUrl}">
+        <h2>This is a collaborative text</h2>
+        <p>Some content</p>
+        <h2>This is another title</h2>
+        <ul><li>More content</li><li>Event more content</li></ul>
+      </div>
+      <script type="text/template" class="decidim-template" id="collaborative-texts-editor-template">
+        <div class="collaborative-texts-editor-header">
+          <button class="collaborative-texts-button-cancel">Cancel</button>
+        </div>
+        <div class="collaborative-texts-editor-profile">Profile</div>
+        <div class="collaborative-texts-editor-container"></div>
+        <div class="collaborative-texts-editor-menu">
+          <button class="collaborative-texts-button-save" disabled>Send suggestion</button>
+        </div>
+      </script>
+  </body>
+  `;
+  let doc = null;
+  let selection = null;
+  global.document.getSelection = jest.fn(() => ({
+    rangeCount: 1,
+    getRangeAt: jest.fn(() => ({
+      intersectsNode: jest.fn((node) => node === doc.nodes[1]),
+      commonAncestorContainer: {
+        closest: jest.fn(() => null)
+      }
+    })),
+    removeAllRanges: jest.fn(),
+    addRange: jest.fn(),
+    focusNode: null,
+    anchorNode: null
+  }));
+  let fetchResult = [];
+  global.fetch = jest.fn(() =>
+    Promise.resolve({
+      json: () => Promise.resolve(fetchResult),
+      ok: true
+    })
+  );
+  beforeEach(async () => {
+    document.body.innerHTML = content;
+    doc = new Document(document.querySelector("[data-collaborative-texts-document]"));
+    // await new Promise(process.nextTick);
+    selection = new Selection(doc);
+  });
+  it("Creates a selection", () => {
+    expect(selection.blocked).toBe(false);
+    expect(selection.doc).toBe(doc);
+    selection.detectNodes();
+    expect(selection.nodes.length).toBe(2);
+    expect(selection.nodes[1]).toEqual(doc.nodes[1]);
+    expect(selection.firstNode).toBe(doc.nodes[1]);
+    expect(selection.lastNode).toBe(doc.nodes[1]);
+    expect(selection.wrapper).toBe(null);
+    expect(selection.editor).toBe(null);
+    expect(selection.changed()).not.toBe(true);
+  });
+  it("Shows the editor", () => {
+    selection.detectNodes();
+    selection.wrap().showEditor()
+    expect(selection.changed()).toBe(false);
+    expect(selection.blocked).toBe(true);
+    expect(selection.wrapper.classList.contains("collaborative-texts-selection")).toBe(true);
+    expect(selection.editor).toBeInstanceOf(Editor);
+    expect(selection.editor.container.innerHTML).toContain("<p id=\"ct-node-2\">Some content</p>");
+    selection.editor.container.innerHTML = "<p>Another content</p>";
+    selection.editor.container.dispatchEvent(new Event("input"));
+    expect(selection.changed()).toBe(true);
+    expect(selection.editor.saveButton.disabled).toBe(false);
+  });
+  it("Scrolls into view", () => {
+    selection.detectNodes();
+    selection.wrap().showEditor();
+    selection.editor.editor.scrollIntoView = jest.fn();
+    selection.scrollIntoView();
+    expect(selection.editor.editor.scrollIntoView).toHaveBeenCalledWith({ behavior: "smooth", block: "nearest" });
+  });
+  it("saves the changes", () => {
+    const spy = jest.spyOn(selection.doc.doc, "dispatchEvent");
+    selection.detectNodes();
+    selection.wrap().showEditor();
+    selection.editor.container.innerHTML = "<p>Another content</p>";
+    selection.editor.container.dispatchEvent(new Event("input"));
+    selection.editor.saveButton.click();
+    expect(spy.mock.calls[0][0].type).toBe("collaborative-texts:suggest");
+    expect(spy.mock.calls[0][0].detail.nodes[1]).toEqual(doc.nodes[1]);
+    expect(spy.mock.calls[0][0].detail.firstNode).toBe(doc.nodes[1]);
+    expect(spy.mock.calls[0][0].detail.lastNode).toBe(doc.nodes[1]);
+    expect(spy.mock.calls[0][0].detail.replaceNodes).toEqual(selection.editor.container.childNodes);
+    expect(spy.mock.calls[0][0].detail.nodes[1].id).toBe("ct-node-2");
+    expect(spy.mock.calls[0][0].detail.nodes[1].textContent).toBe("Some content");
+    expect(spy.mock.calls[0][0].detail.replaceNodes[0].textContent).toBe("Another content");
+  });
+});

data/app/packs/src/decidim/collaborative_texts/test/suggestions.test.js ADDED Viewed

@@ -0,0 +1,233 @@
+/* eslint-disable prefer-reflect */
+/* global global, jest, process */
+import Document from "src/decidim/collaborative_texts/document";
+import SuggestionsList from "src/decidim/collaborative_texts/suggestions_list";
+import Suggestion from "src/decidim/collaborative_texts/suggestion";
+describe("SuggestionsList", () => {
+  let i18n = {test: "test"};
+  let suggestionsUrl = "http://example.com/suggestions";
+  let rolloutUrl = "http://example.com/rollout";
+  const content = `
+    <body>
+      <div class="collaborative-texts-alert hidden">
+        <div></div>
+      </div>
+      <div data-collaborative-texts-document="true"
+         data-collaborative-texts-suggestions-editor-template="#collaborative-texts-editor-template"
+         data-collaborative-texts-suggestions-box-template="#collaborative-texts-suggestions-box-template"
+         data-collaborative-texts-suggestions-box-item-template="#collaborative-texts-suggestions-box-item-template"
+         data-collaborative-texts-i18n='${JSON.stringify(i18n)}'
+         data-collaborative-texts-suggestions-url="${suggestionsUrl}"
+         data-collaborative-texts-rollout-url="${rolloutUrl}">
+        <h2>This is a collaborative text</h2>
+        <p>Some content</p>
+        <h2>This is another title</h2>
+        <ul><li>More content</li><li>Event more content</li></ul>
+      </div>
+      <div class="collaborative-texts-manager hidden">
+        <div>
+          <button data-collaborative-texts-manager-rollout="true">Rollout</button>
+          <button data-collaborative-texts-manager-consolidate="true">Consolidate</button>
+          <button data-collaborative-texts-manager-cancel="true">Cancel</button>
+        </div>
+        <div class="collaborative-texts-manager-counters">
+          Applied: <span class="collaborative-texts-manager-applied"></span>
+          Pending: <span class="collaborative-texts-manager-pending"></span>
+        </div>
+      </div>
+      <script type="text/template" class="decidim-template" id="collaborative-texts-suggestions-box-template">
+        <div data-controller="accordion" id="collaborative-texts-box-{{ID}}">
+          <button data-controls="panel-box-{{ID}}" aria-label="<%= t("decidim.collaborative_texts.document.toggle") %>" aria-expanded="false">
+            <span>
+            </span>
+            <span>
+              <span class="collaborative-texts-suggestions-box-items-count"></span>
+            </span>
+          </button>
+          <div class="collaborative-texts-suggestions-box-items" id="panel-box-{{ID}}" aria-hidden="true"></div>
+        </div>
+      </script>
+      <script type="text/template" class="decidim-template" id="collaborative-texts-suggestions-box-item-template">
+        <div class="collaborative-texts-suggestions-box-item-header">
+          <div>{{PROFILE}}</div>
+          <div class="relative">
+            <button class="collaborative-texts-suggestions-box-item-dropdown"
+                    id="dropdown-trigger-{{ID}}"
+                    data-controller="dropdown"
+                    data-target="dropdown-menu-{{ID}}"
+                    data-auto-close="true">
+            </button>
+            <div class="collaborative-texts-suggestions-box-header-menu" id="dropdown-menu-{{ID}}" role="menu" aria-labelledby="dropdown-trigger-{{ID}}" aria-hidden="true">
+              <ul role="menu">
+                <li role="menuitem">
+                  <button class="button-apply">Apply</button>
+                  <button class="button-restore">Restore</button>
+                </li>
+              </ul>
+            </div>
+          </div>
+        </div>
+        <div class="collaborative-texts-suggestions-box-item-text"></div>
+      </script>
+    </body>
+  `;
+  let suggestionsList = null;
+  let doc = null;
+  let suggestion = null;
+  let firstSuggestion = null;
+  let fetchResult = [
+    {
+      "changeset": {
+        "original": ["some content"],
+        "replace": ["This is another replacement"],
+        "firstNode": 2,
+        "lastNode": 2
+      },
+      "status": "pending",
+      "profileHtml": "<div>Profile</div>",
+      "summary": "This is another summary"
+    }, {
+      "changeset": {
+        "original": ["some content"],
+        "replace": ["This is a replacement"],
+        "firstNode": 2,
+        "lastNode": 2
+      },
+      "status": "pending",
+      "profileHtml": "<div>Profile</div>",
+      "summary": "This is a summary"
+    }
+  ];
+  global.fetch = jest.fn(() =>
+    Promise.resolve({
+      json: () => Promise.resolve(fetchResult)
+    })
+  );
+  global.matchMedia = jest.fn(() => ({
+    matches: false,
+    addListener: jest.fn(),
+    removeListener: jest.fn()
+  }));
+  global.setTimeout = jest.fn((fn) => {
+    fn();
+    return 1;
+  });
+  global.clearTimeout = jest.fn(() => {
+    return 1;
+  });
+  beforeEach(async () => {
+    document.body.innerHTML = content;
+    doc = new Document(document.querySelector("[data-collaborative-texts-document]"));
+    suggestionsList = new SuggestionsList(doc);
+    doc.suggestionsList = suggestionsList;
+    await new Promise(process.nextTick);
+    firstSuggestion = suggestionsList.suggestions[0];
+    suggestion = suggestionsList.suggestions[1];
+    jest.spyOn(suggestion, "setPosition");
+  });
+  it("fetches suggestions", () => {
+    expect(suggestionsList.nodes).toBe(suggestionsList.document.nodes);
+    expect(suggestionsList.doc.innerHTML).toContain("collaborative-texts-suggestions-box");
+    expect(suggestionsList.doc.innerHTML).toContain("This is a summary");
+    expect(suggestionsList.suggestions.length).toBe(2);
+    expect(suggestion).toBeInstanceOf(Suggestion);
+    expect(suggestion.valid).toBe(true);
+    expect(suggestion.nodes.length).toBe(1);
+    expect(suggestion.firstNode).toBe(suggestionsList.nodes[1]);
+    expect(suggestion.lastNode).toBe(suggestionsList.nodes[1]);
+    expect(suggestion.replace).toEqual(["This is a replacement"]);
+    expect(suggestion.applied).toBe(false);
+    expect(suggestion.nodes[0].classList.contains("collaborative-texts-hidden")).toBe(false);
+    expect(suggestionsList.defaultSuggestions()).not.toContain(suggestion);
+    expect(suggestionsList.defaultSuggestions()).toContain(firstSuggestion);
+  });
+  it("applies a suggestion", () => {
+    const spy = jest.spyOn(doc.doc, "dispatchEvent");
+    suggestion.apply();
+    expect(spy.mock.calls[0][0].type).toBe("collaborative-texts:applied");
+    expect(spy.mock.calls[0][0].detail.suggestion).toBe(suggestion);
+    expect(suggestion.setPosition).toHaveBeenCalled();
+    expect(suggestion.applied).toBe(true);
+    expect(suggestion.changesWrapper).toBeInstanceOf(HTMLElement);
+    expect(suggestion.item.classList.contains("applied")).toBe(true);
+    expect(suggestion.nodes[0].classList.contains("collaborative-texts-hidden")).toBe(true);
+    expect(suggestion.changesWrapper.textContent).toBe("This is a replacement");
+    expect(suggestionsList.getApplied().length).toBe(1);
+    expect(suggestionsList.getPending().length).toBe(1);
+    expect(doc.doc.innerHTML).toContain("This is a replacement");
+    expect(doc.doc.querySelector(".collaborative-texts-hidden").innerHTML).toContain("Some content");
+    expect(suggestionsList.defaultSuggestions()).toContain(suggestion);
+    expect(suggestionsList.defaultSuggestions()).not.toContain(firstSuggestion);
+  });
+  it("restores a suggestion", () => {
+    const spy = jest.spyOn(doc.doc, "dispatchEvent");
+    suggestion.apply();
+    expect(spy.mock.calls[0][0].type).toBe("collaborative-texts:applied");
+    expect(spy.mock.calls[0][0].detail.suggestion).toBe(suggestion);
+    expect(suggestion.setPosition).toHaveBeenCalled();
+    suggestion.restore();
+    expect(spy.mock.calls[1][0].type).toBe("collaborative-texts:restored");
+    expect(spy.mock.calls[1][0].detail.suggestion).toBe(suggestion);
+    expect(suggestion.setPosition).toHaveBeenCalled();
+    expect(suggestion.applied).toBe(false);
+    expect(suggestion.changesWrapper).toBe(null);
+    expect(suggestion.item.classList.contains("applied")).toBe(false);
+    expect(suggestion.nodes[0].classList.contains("collaborative-texts-hidden")).toBe(false);
+    expect(suggestion.nodes[0].textContent).toBe("Some content");
+    expect(suggestionsList.getApplied().length).toBe(0);
+    expect(suggestionsList.getPending().length).toBe(2);
+    expect(doc.doc.innerHTML).toContain("Some content");
+    expect(doc.doc.innerHTML).not.toContain("This is a replacement");
+    expect(suggestionsList.defaultSuggestions()).not.toContain(suggestion);
+    expect(suggestionsList.defaultSuggestions()).toContain(firstSuggestion);
+  });
+  it("restores a suggestion and removes the changes wrapper", () => {
+    suggestion.apply();
+    suggestionsList.restore([]);
+    expect(suggestion.applied).toBe(true);
+    suggestionsList.restore([suggestion.nodes[0]], [suggestion]);
+    expect(suggestion.applied).toBe(true);
+    suggestionsList.restore([suggestion.nodes[0]]);
+    expect(suggestion.applied).toBe(false);
+    expect(suggestionsList.defaultSuggestions()).not.toContain(suggestion);
+    expect(suggestionsList.defaultSuggestions()).toContain(firstSuggestion);
+  });
+  it("highlights a suggestion on mouseover", () => {
+    suggestion.highlight();
+    expect(suggestion.highlightWrapper).toBeInstanceOf(HTMLElement);
+    expect(suggestion.highlightWrapper.textContent).toBe("This is a replacement");
+    expect(doc.doc.querySelector(".collaborative-texts-highlight-hidden").innerHTML).toContain("Some content");
+    expect(doc.doc.querySelector(".collaborative-texts-highlight").innerHTML).toContain("This is a replacement");
+  });
+  it("blurs a suggestion on mouseout", () => {
+    suggestion.highlight();
+    suggestion.blur();
+    expect(suggestion.highlightWrapper).toBe(null);
+    expect(doc.doc.querySelector(".collaborative-texts-hidden")).toBe(null);
+    expect(doc.doc.querySelector(".collaborative-texts-highlight")).toBe(null);
+  });
+});

data/app/packs/src/decidim/collaborative_texts/test/toc.test.js ADDED Viewed

@@ -0,0 +1,70 @@
+/* global jest */
+import Toc from "src/decidim/collaborative_texts/toc";
+describe("Toc", () => {
+  const content = `
+  <body>
+    <div class="collaborative-texts-toc" data-collaborative-texts-toc="collaborative-text">
+      <ul class="spinner-container"></ul>
+    </div>
+    <div data-collaborative-texts-document="true"
+        data-collaborative-texts-i18n='{}'
+        data-collaborative-texts-suggestions-url="#"
+        data-collaborative-texts-rollout-url="#">
+      <h2 id="node-1">This is a collaborative text</h2>
+      <p>Some content</p>
+      <div class="collaborative-texts-changes">
+        <h2 id="node-2">This is another title</h2>
+        <ul><li>More content</li><li>Event more content</li></ul>
+      </div>
+    </div>
+  </body>
+`;
+  let toc = null;
+  let doc = null;
+  beforeEach(() => {
+    document.body.innerHTML = content;
+    doc = document.querySelector("[data-collaborative-texts-document]");
+    toc = new Toc(document.querySelector("[data-collaborative-texts-toc]"), doc);
+  });
+  it("filters text nodes and adds ids", () => {
+    expect(toc.headings().length).toBe(2);
+    expect(toc.headings()[0].id).toBe("node-1");
+    expect(toc.headings()[0].textContent).toBe("This is a collaborative text");
+    expect(toc.headings()[1].id).toBe("node-2");
+    expect(toc.headings()[1].textContent).toBe("This is another title");
+  });
+  it("renders the toc", () => {
+    toc.render();
+    expect(toc.ul.children.length).toBe(2);
+    expect(toc.ul.children[0].textContent).toBe("This is a collaborative text");
+    expect(toc.ul.children[1].textContent).toBe("This is another title");
+  });
+  it("scrolls to the heading on click", () => {
+    toc.render();
+    const entry = toc.ul.children[0];
+    const scrollIntoViewMock = jest.fn();
+    toc.headings()[0].scrollIntoView = scrollIntoViewMock;
+    entry.click();
+    expect(window.location.hash).toBe("#node-1");
+    expect(toc.headings()[0].scrollIntoView).toHaveBeenCalledWith({ behavior: "smooth" });
+  });
+  it("binds applied event", () => {
+    doc.dispatchEvent(new Event("collaborative-texts:applied"));
+    expect(toc.ul.children.length).toBe(2);
+  });
+  it("binds restored event", () => {
+    doc.dispatchEvent(new Event("collaborative-texts:restored"));
+    expect(toc.ul.children.length).toBe(2);
+  });
+});

data/app/packs/src/decidim/collaborative_texts/toc.js ADDED Viewed

@@ -0,0 +1,48 @@
+export default class Toc {
+  constructor(toc, doc) {
+    this.toc = toc;
+    this.doc = doc;
+    this.ul = toc.getElementsByTagName("ul")[0];
+    this._bindEvents();
+  }
+  headings() {
+    this.nodes = [];
+    this.doc.querySelectorAll("*> h2:not(.collaborative-texts-hidden), *> div.collaborative-texts-changes> h2").forEach((node) => {
+      if (node.nodeName === "H2") {
+        this.nodes.push(node);
+      }
+    });
+    return this.nodes;
+  }
+  render() {
+    this.ul.innerHTML = "";
+    this.ul.classList.remove("spinner-container");
+    this.headings().forEach((heading) => {
+      this.ul.appendChild(this.createEntry(heading));
+    });
+  }
+  createEntry(heading) {
+    let entry = window.document.createElement("li");
+    entry.textContent = heading.textContent;
+    entry.addEventListener("click", this._onClick.bind(this));
+    return entry;
+  }
+  _onClick(event) {
+    event.preventDefault();
+    let entry = event.currentTarget;
+    let heading = this.headings().find((el) => el.textContent === entry.textContent);
+    if (heading) {
+      history.replaceState(null, null, `#${heading.id}`);
+      heading.scrollIntoView({ behavior: "smooth" });
+    }
+  }
+  _bindEvents() {
+    this.doc.addEventListener("collaborative-texts:applied", this.render.bind(this));
+    this.doc.addEventListener("collaborative-texts:restored", this.render.bind(this));
+  }
+}