Merge pull request #4 from jywarren/no-ambiguous-replaces

v0.0.5, no ambiguous replaces, message fix

Author: jywarren

dist/inlineMarkdownEditor.js

@@ -10236,8 +10236,9 @@ inlineMarkdownEditor = function inlineMarkdownEditor(o) {
   o.isEditable = o.isEditable || require('./isEditable.js');
   o.processSections = require('./processSections.js');
   var el = $(o.selector);
+  o.originalMarkdown = el.html();
   // split by double-newline:
-  var sections = el.html().split('\n\n');
+  var sections = o.originalMarkdown.split('\n\n');
   el.html('');
   o.processSections(sections, o);
   el.show();
@@ -10266,18 +10267,22 @@ module.exports = function insertEditLink(uniqueId, el, form, onEdit, editor) {
 }
 
 },{}],98:[function(require,module,exports){
-module.exports = function isEditable(markdown) {
+module.exports = function isEditable(markdown, originalMarkdown) {
+  originalMarkdown = originalMarkdown || markdown; // optional parameter for checking against original complete text
   // filter? Only p,h1-5,ul?
   var editable = markdown.match(/</) === null; // has tags; exclueds HTML
   editable = editable && markdown.match(/\*\*\*\*/) === null; // no horizontal rules: ****
   editable = editable && markdown.match(/\-\-\-\-/) === null; // no horizontal rules: ----
   editable = editable && markdown !== ''; // no blanks
+  // here we disallow if more than one instance in original string:
+  editable = editable && originalMarkdown.split(markdown).length === 2 // couldn't get match options to work with string
   return editable;
 } 
 
 },{}],99:[function(require,module,exports){
 module.exports = function onComplete(response, markdown, html, el, uniqueId, form, o) {
   if (response === 'true' || response === true) {
+    var message = $('#' + uniqueId + ' .section-message');
     message.html('<i class="fa fa-check" style="color:green;"></i>');
     markdown = changes;
     $('#' + uniqueId + ' textarea').val('');
@@ -10318,7 +10323,7 @@ module.exports = function processSection(markdown, o) {
   var message = $('#' + uniqueId + ' .section-message');
 
   function insertFormIfMarkdown(_markdown, el, uniqueId) {
-    if (o.isEditable(_markdown)) {
+    if (o.isEditable(_markdown, o.originalMarkdown)) {
       var formHtml = o.buildSectionForm(uniqueId, _markdown);
       el.after(formHtml);
       var form = $('#' + uniqueId);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "inline-markdown-editor",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "An inline wysiwyg markdown document editor based on replacing string subsections. WYSIWYG possible via woofmark.",
   "main": "dist/inlineMarkdownEditor.js",
   "scripts": {

spec/javascripts/editor_spec.js

@@ -25,6 +25,12 @@ describe("Editor", function() {
     expect(isEditable('Just a simple string.')).toBe(true);
   });
 
+  it("correctly assesses isEditable when comparing to original full text; no duplicates", function() {
+    var isEditable = editor.options.isEditable
+    expect(isEditable('phrase', 'One phrase, two phrase.')).toBe(false);
+    expect(isEditable('One', 'One phrase, two phrase.')).toBe(true);
+  });
+
   it("generates the right number of sections", function() {
     expect(editor.sections.length).toBe(6);
     expect($('.inline-section').length).toBe(6);

spec/javascripts/replacement_spec.js

@@ -0,0 +1,16 @@
+describe("Replacement functions", function() {
+
+  var editor;
+
+  it("won't generate an editor for an ambiguous (duplicated) section, where replacement server side could apply to the wrong section", function() {
+    fixture = loadFixtures('index.html');
+    var html = "Unique text.\n\nDuplicated text.\n\nDuplicated text."
+    $('.markdown').html(html);
+    editor = inlineMarkdownEditor({
+      replaceUrl: '/wiki/replace/',
+      selector: '.markdown'
+    });
+    expect($('.inline-edit-form textarea').length).toBe(1);
+  });
+
+});

src/inlineMarkdownEditor.js

@@ -7,8 +7,9 @@ inlineMarkdownEditor = function inlineMarkdownEditor(o) {
   o.isEditable = o.isEditable || require('./isEditable.js');
   o.processSections = require('./processSections.js');
   var el = $(o.selector);
+  o.originalMarkdown = el.html();
   // split by double-newline:
-  var sections = el.html().split('\n\n');
+  var sections = o.originalMarkdown.split('\n\n');
   el.html('');
   o.processSections(sections, o);
   el.show();

src/isEditable.js

@@ -1,8 +1,11 @@
-module.exports = function isEditable(markdown) {
+module.exports = function isEditable(markdown, originalMarkdown) {
+  originalMarkdown = originalMarkdown || markdown; // optional parameter for checking against original complete text
   // filter? Only p,h1-5,ul?
   var editable = markdown.match(/</) === null; // has tags; exclueds HTML
   editable = editable && markdown.match(/\*\*\*\*/) === null; // no horizontal rules: ****
   editable = editable && markdown.match(/\-\-\-\-/) === null; // no horizontal rules: ----
   editable = editable && markdown !== ''; // no blanks
+  // here we disallow if more than one instance in original string:
+  editable = editable && originalMarkdown.split(markdown).length === 2 // couldn't get match options to work with string
   return editable;
 } 

src/onComplete.js

@@ -1,5 +1,6 @@
 module.exports = function onComplete(response, markdown, html, el, uniqueId, form, o) {
   if (response === 'true' || response === true) {
+    var message = $('#' + uniqueId + ' .section-message');
     message.html('<i class="fa fa-check" style="color:green;"></i>');
     markdown = changes;
     $('#' + uniqueId + ' textarea').val('');

src/processSection.js

@@ -17,7 +17,7 @@ module.exports = function processSection(markdown, o) {
   var message = $('#' + uniqueId + ' .section-message');
 
   function insertFormIfMarkdown(_markdown, el, uniqueId) {
-    if (o.isEditable(_markdown)) {
+    if (o.isEditable(_markdown, o.originalMarkdown)) {
       var formHtml = o.buildSectionForm(uniqueId, _markdown);
       el.after(formHtml);
       var form = $('#' + uniqueId);