markdiff 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e77befcb13e1946b68b5820403d3a3583836fbe8
+  data.tar.gz: 99b131827eece95036986a5f528d96f4ebfb484a
+SHA512:
+  metadata.gz: 5201a42d38ed0d77c37b62171abd3163ef0428cc06648a4024082fc22e36d7a001e0720b8389f178e4720bafe123411f3102289c2ced21dc35ad77bab5222491
+  data.tar.gz: b0267e2e49d7ca40cc8bd7c82c08652bd0ec1786fcd35e01553fa0d77a2707363aa98f52d82be3302bc99381a90bd2e3c35ed6de8f5318b2d2f1eee01b190415

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in markdiff.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 r7kamura
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,13 @@
+# Markdiff
+Rendered Markdown differ.
+
+## Usage
+```rb
+require "markdiff"
+
+differ = Markdiff::Differ.new
+node = differ.render("<p>a</p>", "<p>b</p>")
+node.to_html #=> "<p><del>a</del><ins>b</ins></p>"
+```
+
+See [spec/markdiff/differ_spec.rb](spec/markdiff/differ_spec.rb) for more examples.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/markdiff/differ.rb

@@ -0,0 +1,157 @@
+require "nokogiri"
+require "markdiff/operations/add_child_operation"
+require "markdiff/operations/add_data_before_href_operation"
+require "markdiff/operations/add_data_before_tag_name_operation"
+require "markdiff/operations/add_previous_sibling_operation"
+require "markdiff/operations/remove_operation"
+
+module Markdiff
+  class Differ
+    # Apply a given patch to a given node
+    # @param [Array<Markdiff::Operations::Base>] operations
+    # @param [Nokogiri::XML::Node] node
+    # @return [Nokogiri::XML::Node] Converted node
+    def apply_patch(operations, node)
+      operations.each do |operation|
+        case operation
+        when ::Markdiff::Operations::AddChildOperation
+          operation.target_node.add_child(operation.inserted_node)
+        when ::Markdiff::Operations::AddDataBeforeHrefOperation
+          operation.target_node["data-before-href"] = operation.target_node["href"]
+          operation.target_node["href"] = operation.after_href
+        when ::Markdiff::Operations::AddDataBeforeTagNameOperation
+          operation.target_node["data-before-tag-name"] = operation.target_node.name
+          operation.target_node.name = operation.after_tag_name
+        when ::Markdiff::Operations::AddPreviousSiblingOperation
+          operation.target_node.add_previous_sibling(operation.inserted_node)
+        when ::Markdiff::Operations::RemoveOperation
+          operation.target_node.replace(operation.inserted_node)
+        end
+      end
+      node
+    end
+
+    # Creates a patch from given two nodes
+    # @param [Nokogiri::XML::Node] before_node
+    # @param [Nokogiri::XML::Node] after_node
+    # @return [Array<Markdiff::Operations::Base>] operations
+    def create_patch(before_node, after_node)
+      if before_node.to_html == after_node.to_html
+        []
+      else
+        create_patch_from_children(before_node, after_node)
+      end
+    end
+
+    # Utility method to do both creating and applying a patch
+    # @param [String] before_string
+    # @param [String] after_string
+    # @return [Nokogiri::XML::Node] Converted node
+    def render(before_string, after_string)
+      before_node = ::Nokogiri::HTML.fragment(before_string)
+      after_node = ::Nokogiri::HTML.fragment(after_string)
+      patch = create_patch(before_node, after_node)
+      apply_patch(patch, before_node)
+    end
+
+    private
+
+    # 1. Create identity map and collect patches from descendants
+    #   1-1. Detect exact-matched nodes
+    #   1-2. Detect partial-matched nodes and recursively walk through its children
+    # 2. Create remove operations from identity map
+    # 3. Create insert operations from identity map
+    # 4. Return operations as a patch
+    #
+    # @param [Nokogiri::XML::Node] before_node
+    # @param [Nokogiri::XML::Node] after_node
+    # @return [Array<Markdiff::Operations::Base>] operations
+    def create_patch_from_children(before_node, after_node)
+      operations = []
+      identity_map = {}
+      inverted_identity_map = {}
+
+      # Exactly matching
+      before_node.children.each do |before_child|
+        after_node.children.each do |after_child|
+          if inverted_identity_map[after_child]
+            next
+          end
+          if before_child.to_html == after_child.to_html
+            identity_map[before_child] = after_child
+            inverted_identity_map[after_child] = before_child
+          end
+        end
+      end
+
+      # Partial matching
+      before_node.children.each do |before_child|
+        if identity_map[before_child]
+          next
+        end
+        after_node.children.each do |after_child|
+          next if inverted_identity_map[after_child]
+          next if before_child.text?
+          if before_child.name == after_child.name
+            if detect_href_difference(before_child, after_child)
+              operations << ::Markdiff::Operations::AddDataBeforeHrefOperation.new(after_href: after_child["href"], target_node: before_child)
+            end
+            identity_map[before_child] = after_child
+            inverted_identity_map[after_child] = before_child
+            operations += create_patch(before_child, after_child)
+          elsif detect_heading_level_difference(before_child, after_child)
+            operations << ::Markdiff::Operations::AddDataBeforeTagNameOperation.new(after_tag_name: after_child.name, target_node: before_child)
+            identity_map[before_child] = after_child
+            inverted_identity_map[after_child] = before_child
+          end
+        end
+      end
+
+      before_node.children.each do |before_child|
+        unless identity_map[before_child]
+          operations << ::Markdiff::Operations::RemoveOperation.new(target_node: before_child)
+        end
+      end
+
+      after_node.children.each do |after_child|
+        unless inverted_identity_map[after_child]
+          right_node = after_child.next_sibling
+          loop do
+            case
+            when inverted_identity_map[right_node]
+              operations << ::Markdiff::Operations::AddPreviousSiblingOperation.new(inserted_node: after_child, target_node: inverted_identity_map[right_node])
+              break
+            when right_node.nil?
+              operations << ::Markdiff::Operations::AddChildOperation.new(inserted_node: after_child, target_node: before_node)
+              break
+            else
+              right_node = right_node.next_sibling
+            end
+          end
+        end
+      end
+
+      operations
+    end
+
+    # @param [Nokogiri::XML::Node] before_node
+    # @param [Nokogiri::XML::Node] after_node
+    # @return [false, true] True if given 2 nodes are both hN nodes and have different N (e.g. h1 and h2)
+    def detect_heading_level_difference(before_node, after_node)
+      before_node.name != after_node.name &&
+      %w[h1 h2 h3 h4 h5 h6].include?(before_node.name) &&
+      %w[h1 h2 h3 h4 h5 h6].include?(after_node.name) &&
+      before_node.inner_html == after_node.inner_html
+    end
+
+    # @param [Nokogiri::XML::Node] before_node
+    # @param [Nokogiri::XML::Node] after_node
+    # @return [false, true] True if given 2 nodes are both "a" nodes and have different href attributes
+    def detect_href_difference(before_node, after_node)
+      before_node.name == "a" &&
+      after_node.name == "a" &&
+      before_node["href"] != after_node["href"] &&
+      before_node.inner_html == after_node.inner_html
+    end
+  end
+end

data/lib/markdiff/operations/add_child_operation.rb

@@ -0,0 +1,12 @@
+require "markdiff/operations/base"
+
+module Markdiff
+  module Operations
+    class AddChildOperation < Base
+      # @return [String]
+      def inserted_node
+        "<ins>#{@inserted_node}</ins>"
+      end
+    end
+  end
+end

data/lib/markdiff/operations/add_data_before_href_operation.rb

@@ -0,0 +1,14 @@
+require "markdiff/operations/base"
+
+module Markdiff
+  module Operations
+    class AddDataBeforeHrefOperation < Base
+      attr_reader :after_href
+
+      def initialize(after_href:, **args)
+        super(**args)
+        @after_href = after_href
+      end
+    end
+  end
+end

data/lib/markdiff/operations/add_data_before_tag_name_operation.rb

@@ -0,0 +1,14 @@
+require "markdiff/operations/base"
+
+module Markdiff
+  module Operations
+    class AddDataBeforeTagNameOperation < Base
+      attr_reader :after_tag_name
+
+      def initialize(after_tag_name:, **args)
+        super(**args)
+        @after_tag_name = after_tag_name
+      end
+    end
+  end
+end

data/lib/markdiff/operations/add_previous_sibling_operation.rb

@@ -0,0 +1,12 @@
+require "markdiff/operations/base"
+
+module Markdiff
+  module Operations
+    class AddPreviousSiblingOperation < Base
+      # @return [String]
+      def inserted_node
+        "<ins>#{@inserted_node}</ins>"
+      end
+    end
+  end
+end

data/lib/markdiff/operations/base.rb

@@ -0,0 +1,15 @@
+module Markdiff
+  module Operations
+    class Base
+      # @return [Nokogiri::XML::Node]
+      attr_reader :target_node
+
+      # @param [Nokogiri::XML::Node, nil] inserted_node
+      # @param [Nokogiri::XML::Node] target_node
+      def initialize(inserted_node: nil, target_node:)
+        @inserted_node = inserted_node
+        @target_node = target_node
+      end
+    end
+  end
+end

data/lib/markdiff/operations/remove_operation.rb

@@ -0,0 +1,12 @@
+require "markdiff/operations/base"
+
+module Markdiff
+  module Operations
+    class RemoveOperation < Base
+      # @return [String]
+      def inserted_node
+        "<del>#{@target_node}</del>"
+      end
+    end
+  end
+end

data/lib/markdiff/version.rb

@@ -0,0 +1,3 @@
+module Markdiff
+  VERSION = "0.1.0"
+end

data/lib/markdiff.rb

@@ -0,0 +1,2 @@
+require "markdiff/differ"
+require "markdiff/version"

data/markdiff.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "markdiff/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "markdiff"
+  spec.version       = Markdiff::VERSION
+  spec.authors       = ["Ryo Nakamura"]
+  spec.email         = ["r7kamura@gmail.com"]
+  spec.summary       = "Rendered Markdown differ."
+  spec.homepage      = "https://github.com/r7kamura/markdiff"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.start_with?("spec/") }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "pry", "0.10.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "3.4.0"
+  spec.add_runtime_dependency "nokogiri"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: markdiff
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/markdiff.rb
+- lib/markdiff/differ.rb
+- lib/markdiff/operations/add_child_operation.rb
+- lib/markdiff/operations/add_data_before_href_operation.rb
+- lib/markdiff/operations/add_data_before_tag_name_operation.rb
+- lib/markdiff/operations/add_previous_sibling_operation.rb
+- lib/markdiff/operations/base.rb
+- lib/markdiff/operations/remove_operation.rb
+- lib/markdiff/version.rb
+- markdiff.gemspec
+homepage: https://github.com/r7kamura/markdiff
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Rendered Markdown differ.
+test_files: []
+has_rdoc: