Skip to content

[Logan] Enable diffing of video, math, widgets, iframes, imgs, svgs. #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[Logan] Enable diffing of video, math, widgets, iframes, imgs, svgs. #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 37 additions & 2 deletions js/htmldiff.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
* null otherwise
*/
function is_start_of_atomic_tag(word){
var result = /^<(iframe|object|math|svg|script)/.exec(word);
var result = /^<(iframe|object|math|svg|script|video)/.exec(word);
if (result){
result = result[1];
}
Expand Down Expand Up @@ -99,7 +99,8 @@
* @return {boolean} True if the token can be wrapped inside a tag, false otherwise.
*/
function is_wrappable(token){
return isnt_tag(token) || is_start_of_atomic_tag(token) || is_void_tag(token);
var is_img = /^<img[\s>]/.test(token);
return is_img|| isnt_tag(token) || is_start_of_atomic_tag(token) || is_void_tag(token);
}

/**
Expand Down Expand Up @@ -250,10 +251,44 @@
* @return {string} The identifying key that should be used to match before and after tokens.
*/
function get_key_for_token(token){
// If the token is an image element, grab it's src attribute to include in the key.
var img = /^<img.*src=['"]([^"']*)['"].*>$/.exec(token);
if (img) {
return '<img src="' + img[1] + '">';
}

// If the token is an object element, grab it's data attribute to include in the key.
var object = /^<object.*data=['"]([^"']*)['"]/.exec(token);
if (object) {
return '<object src="' + object[1] + '"></object>';
}

// If it's a video, math or svg element, the entire token should be compared except the
// data-uuid.
if(/^<(svg|math|video)[\s>]/.test(token)) {
var uuid = token.indexOf('data-uuid="');
if (uuid !== -1) {
var start = token.slice(0, uuid);
var end = token.slice(uuid + 44);
return start + end;
} else {
return token;
}
}

// If the token is an iframe element, grab it's src attribute to include in it's key.
var iframe = /^<iframe.*src=['"]([^"']*)['"].*>/.exec(token);
if (iframe) {
return '<iframe src="' + iframe[1] + '"></iframe>';
}

// If token any other element, just grab the tag name.
var tag_name = /<([^\s>]+)[\s>]/.exec(token);
if (tag_name){
return '<' + (tag_name[1].toLowerCase()) + '>';
}

// Otherwise, the token is text, collapse the whitespace.
if (token){
return token.replace(/(\s+|&nbsp;|&#160;)/g, ' ');
}
Expand Down
164 changes: 163 additions & 1 deletion test/diff.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
describe('Diff', function(){
var cut, res;
var cut, res, html_to_tokens, calculate_operations;

beforeEach(function(){
cut = require('../js/htmldiff');
html_to_tokens = cut.html_to_tokens;
calculate_operations = cut.calculate_operations;
});

describe('When both inputs are the same', function(){
Expand Down Expand Up @@ -45,4 +47,164 @@ describe('Diff', function(){
'input<ins class="diff-result"> 2</ins>');
});
}); // describe('When a class name is specified')

describe('Image Differences', function(){
it('show two images as different if their src attributes are different', function() {
var before = html_to_tokens('<img src="a.jpg">');
var after = html_to_tokens('<img src="b.jpg">');
var ops = calculate_operations(before, after);
expect(ops.length).to.equal(1);
expect(ops[0]).to.eql({
action: 'replace',
start_in_before: 0,
end_in_before: 0,
start_in_after: 0,
end_in_after: 0
});
});

it('should show two images are the same if their src attributes are the same', function() {
var before = html_to_tokens('<img src="a.jpg">');
var after = html_to_tokens('<img src="a.jpg" alt="hey!">');
var ops = calculate_operations(before, after);
expect(ops.length).to.equal(1);
expect(ops[0]).to.eql({
action: 'equal',
start_in_before: 0,
end_in_before: 0,
start_in_after: 0,
end_in_after: 0
});
});
}); // describe('Image Differences')

describe('Widget Differences', function(){
it('show two widgets as different if their data attributes are different', function() {
var before = html_to_tokens('<object data="a.jpg"></object>');
var after = html_to_tokens('<object data="b.jpg"></object>');
var ops = calculate_operations(before, after);
expect(ops.length).to.equal(1);
expect(ops[0]).to.eql({
action: 'replace',
start_in_before: 0,
end_in_before: 0,
start_in_after: 0,
end_in_after: 0
});
});

it('should show two widgets are the same if their data attributes are the same', function() {
var before = html_to_tokens('<object data="a.jpg"><param>yo!</param></object>');
var after = html_to_tokens('<object data="a.jpg"></object>');
var ops = calculate_operations(before, after);
expect(ops.length).to.equal(1);
expect(ops[0]).to.eql({
action: 'equal',
start_in_before: 0,
end_in_before: 0,
start_in_after: 0,
end_in_after: 0
});
});
}); // describe('Widget Differences')

describe('Math Differences', function(){
it('should show two math elements as different if their contents are different', function() {
var before = html_to_tokens('<math data-uuid="55784cd906504787a8e459e80e3bb554"><msqrt>' +
'<msup><mi>b</mi><mn>2</mn></msup></msqrt></math>');
var after = html_to_tokens('<math data-uuid="55784cd906504787a8e459e80e3bb554"><msqrt>' +
'<msup><mn>b</mn><mn>5</mn></msup></msqrt></math>');
var ops = calculate_operations(before, after);
expect(ops.length).to.equal(1);
expect(ops[0]).to.eql({
action: 'replace',
start_in_before: 0,
end_in_before: 0,
start_in_after: 0,
end_in_after: 0
});
});

it('should show two math elements as the same if their contents are the same', function() {
var before = html_to_tokens('<math data-uuid="15568cd906504876548459e80e356878"><msqrt>' +
'<msup><mi>b</mi><mn>2</mn></msup></msqrt></math>');
var after = html_to_tokens('<math data-uuid="55784cd906504787a8e459e80e3bb554"><msqrt>' +
'<msup><mi>b</mi><mn>2</mn></msup></msqrt></math>');
var ops = calculate_operations(before, after);
expect(ops.length).to.equal(1);
expect(ops[0]).to.eql({
action: 'equal',
start_in_before: 0,
end_in_before: 0,
start_in_after: 0,
end_in_after: 0
});
});
}); // describe('Math Differences')

describe('Video Differences', function(){
it('show two widgets as different if their data attributes are different', function() {
var before = html_to_tokens('<video data-uuid="0787866ab5494d88b4b1ee423453224b">' +
'<source src="inkling-video:///big_buck_bunny/webm_high" type="video/webm" /></video>');
var after = html_to_tokens('<video data-uuid="0787866ab5494d88b4b1ee423453224b">' +
'<source src="inkling-video:///big_buck_rabbit/mp4" type="video/webm" /></video>');
var ops = calculate_operations(before, after);
expect(ops.length).to.equal(1);
expect(ops[0]).to.eql({
action: 'replace',
start_in_before: 0,
end_in_before: 0,
start_in_after: 0,
end_in_after: 0
});

});

it('should show two widgets are the same if their data attributes are the same', function() {
var before = html_to_tokens('<video data-uuid="65656565655487787484545454548494">' +
'<source src="inkling-video:///big_buck_bunny/webm_high" type="video/webm" /></video>');
var after = html_to_tokens('<video data-uuid="0787866ab5494d88b4b1ee423453224b">' +
'<source src="inkling-video:///big_buck_bunny/webm_high" type="video/webm" /></video>');
var ops = calculate_operations(before, after);
expect(ops.length).to.equal(1);
expect(ops[0]).to.eql({
action: 'equal',
start_in_before: 0,
end_in_before: 0,
start_in_after: 0,
end_in_after: 0
});
});
}); // describe('Video Differences')

describe('iframe Differences', function(){
it('show two widgets as different if their data attributes are different', function() {
var before = html_to_tokens('<iframe src="a.jpg"></iframe>');
var after = html_to_tokens('<iframe src="b.jpg"></iframe>');
var ops = calculate_operations(before, after);
expect(ops.length).to.equal(1);
expect(ops[0]).to.eql({
action: 'replace',
start_in_before: 0,
end_in_before: 0,
start_in_after: 0,
end_in_after: 0
});
});

it('should show two widgets are the same if their data attributes are the same', function() {
var before = html_to_tokens('<iframe src="a.jpg"></iframe>');
var after = html_to_tokens('<iframe src="a.jpg" class="foo"></iframe>');
var ops = calculate_operations(before, after);
expect(ops.length).to.equal(1);
expect(ops[0]).to.eql({
action: 'equal',
start_in_before: 0,
end_in_before: 0,
start_in_after: 0,
end_in_after: 0
});
});
}); // describe('iframe Differences')

}); // describe('Diff')