monkeyhelper-diffrenderer 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+nbproject

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rattle http://www.rattlecentral.com
+
+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.rdoc

@@ -0,0 +1,29 @@
+= DiffRenderer
+
+DiffRenderer creates pretty HTML diffs for text and bits of html documents.
+
+== Example Usage
+
+<pre>
+#!/usr/bin/ruby
+
+require 'rubygems'
+require 'diffrenderer'
+
+old_text = ['This was some text']
+new_text = ['This is some text']
+
+puts DiffRenderer.new(old_text, new_text).to_html
+</pre>
+
+<pre>
+<p>
+  This <span class="removed">was</span> <span class="added">is</span> some text
+</p>
+</pre>
+
+See the examples directory for more details.
+
+== Copyright
+
+Copyright (c) 2009 Rattle http://www.rattlecentral.com. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "diffrenderer"
+    gem.summary = %Q{TODO}
+    gem.email = "robl@monkeyhelper.com"
+    gem.homepage = "http://github.com/monkeyhelper/diffrenderer"
+    gem.authors = ["robl"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "diffrenderer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/diffrenderer.gemspec

@@ -0,0 +1,53 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{diffrenderer}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["robl"]
+  s.date = %q{2009-06-03}
+  s.email = %q{robl@monkeyhelper.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "diffrenderer.gemspec",
+     "examples/diff-html.rb",
+     "examples/diff-text.rb",
+     "lib/diffrenderer.rb",
+     "lib/diffrenderer/paragraph_block.rb",
+     "lib/word_run_diff_lcs.rb",
+     "test/diffrenderer_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/monkeyhelper/diffrenderer}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{TODO}
+  s.test_files = [
+    "test/diffrenderer_test.rb",
+     "test/test_helper.rb",
+     "examples/diff-text.rb",
+     "examples/diff-html.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/examples/diff-html.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/ruby
+
+require 'rubygems'
+require 'diffrenderer'
+
+old_html= <<OLDHTML
+<h2 class="title">Hello, we're Rattle</h2>
+<p class="first">We're not your average digital agency. We don't do marketing, we don't do SEO, and we don't do flim flam. We just research and develop social web stuff that works.</p>
+
+<p>Our expert knowledge allows us to develop the right social web applications for your business and your audience. Clients include the <a href="http://www.rattlecentral.com/case-studies/followme.html">BBC</a>, the <a href="http://www.rattlecentral.com/case-studies/talk-science.html">Science Museum</a>, <a href="http://www.rattlecentral.com/case-studies/a-randomers-guide-to-teenagers.html">Channel 4</a> and <a href="http://www.rattlecentral.com/case-studies/ghd.html">ghd</a>. We've also produced <a href="http://www.rattlecentral.com/case-studies/folksy.html">Folksy</a>, a website for designers and makers.</p>
+OLDHTML
+
+new_html= <<NEWHTML
+<h2 class="title">Hello, we're Rattle</h2>
+<p class="first">We're not your average digital agency. We don't do marketing, we don't do SEO, and we don't do flim flam. We just research and develop social web stuff that works.</p>
+
+<p>Our expert knowledge allows us to develop the right social web applications for your business and your audience. Clients include the <a href="http://www.rattlecentral.com/case-studies/followme.html">BBC</a>, the <a href="http://www.rattlecentral.com/case-studies/talk-science.html">Science Museum</a>, <a href="http://www.rattlecentral.com/case-studies/a-randomers-guide-to-teenagers.html">Channel 4</a> and <a href="http://www.rattlecentral.com/case-studies/ghd.html">ghd</a>. We've also produced <a href="http://www.rattlecentral.com/case-studies/folksy.html">Folksy</a>, a website for designers and makers and we give away code too !</p>
+NEWHTML
+
+
+diffed = DiffRenderer.new(DiffRenderer.process_html(old_html), DiffRenderer.process_html(new_html)).to_html
+
+out = <<HTML
+<html>
+<head>
+<title>DiffRenderer Example</title>
+
+<style type="text/css">
+<!--
+#content {
+        float: left;
+        width: 560px;
+        background: #FFF;
+        margin-bottom: 10px;
+        margin-left: 10px;
+        padding: 1em 20px 0px;
+}
+#content p.added {
+  background: #66ff66;
+  margin-top: 0;
+  margin-left: -0.5em;
+  margin-right: -0.5em;
+  padding: 0.5em;
+}
+#content p.removed {
+  background: #ff6666;
+  text-decoration: line-through;
+  padding: 0.5em;
+  margin-top: 0;
+  margin-left: -0.5em;
+  margin-right: -0.5em;
+}
+#content p.replaced {
+  margin-top: 0;
+  margin-bottom: 0;
+  margin-left: -0.5em;
+  margin-right: -0.5em;
+}
+#content span.added {
+  background: #66ff66;
+  padding: 2px 2px;
+}
+#content span.removed {
+  background: #ff6666;
+  padding: 2px 2px;
+  text-decoration: line-through;
+}
+-->
+</style>
+
+</head>
+
+<body>
+<div id="content">
+#{diffed}
+</div>
+</body>
+</html>
+
+HTML
+
+puts out

data/examples/diff-text.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/ruby
+
+require 'rubygems'
+require 'diffrenderer'
+
+old_text = ['This was some text']
+new_text = ['This is some text']
+
+diffed = DiffRenderer.new(old_text, new_text).to_html
+
+out = <<HTML
+<html>
+<head>
+<title>DiffRenderer Example</title>
+
+<style type="text/css">
+<!--
+#content {
+        float: left;
+        width: 560px;
+        background: #FFF;
+        margin-bottom: 10px;
+        margin-left: 10px;
+        padding: 1em 20px 0px;
+}
+#content p.added {
+  background: #66ff66;
+  margin-top: 0;
+  margin-left: -0.5em;
+  margin-right: -0.5em;
+  padding: 0.5em;
+}
+#content p.removed {
+  background: #ff6666;
+  text-decoration: line-through;
+  padding: 0.5em;
+  margin-top: 0;
+  margin-left: -0.5em;
+  margin-right: -0.5em;
+}
+#content p.replaced {
+  margin-top: 0;
+  margin-bottom: 0;
+  margin-left: -0.5em;
+  margin-right: -0.5em;
+}
+#content span.added {
+  background: #66ff66;
+  padding: 2px 2px;
+}
+#content span.removed {
+  background: #ff6666;
+  padding: 2px 2px;
+  text-decoration: line-through;
+}
+-->
+</style>
+
+</head>
+
+<body>
+<div id="content">
+#{diffed}
+</div>
+</body>
+</html>
+
+HTML
+
+puts out

data/lib/diffrenderer.rb

@@ -0,0 +1,49 @@
+require 'rubygems'
+gem 'diff-lcs', '~> 1.1', '>= 1.1.2'
+require 'diff/lcs'
+require 'hpricot'
+require 'pp'
+
+require 'word_run_diff_lcs'
+
+%w(paragraph_block).each do |file|
+  require File.join(File.dirname(__FILE__), 'diffrenderer', file)
+end
+
+class DiffRenderer
+
+  UNWANTED_TAGS = %w[ a ul ol ].freeze
+
+  def initialize(paragraph_list_a, paragraph_list_b)
+    @paragraph_list_a, @paragraph_list_b = paragraph_list_a, paragraph_list_b
+  end
+
+  def to_html
+    diff = Diff::LCS.sdiff(@paragraph_list_a,@paragraph_list_b)
+    diff.map { |context_change| ParagraphBlock.new(context_change) }.join
+  end
+
+  def self.process_html(h)
+    doc = Hpricot(h)
+
+    UNWANTED_TAGS.each { |tag| (doc / tag).remove }
+    (doc / "p").map { |elem|
+      # Silence "nested" <p> tags as Hpricot does not implicitly close <p> tags
+      (elem / "p").each do |e|
+        class << e; def inner_text; nil; end; end
+      end
+
+      text = elem.inner_text.strip
+
+      (elem / "p").each do |e|
+        class << e; remove_method :inner_text; end
+      end
+      text
+    }.reject { |text|
+      text == ""
+    }
+  end
+
+end
+
+

data/lib/diffrenderer/paragraph_block.rb

@@ -0,0 +1,168 @@
+class DiffRenderer
+
+  class ParagraphBlock
+    def self.new(context_change)
+      case context_change.action
+        when "=" then PlainParagraph
+        when "-" then RemovedParagraph
+        when "+" then AddedParagraph
+        when "!" then ChangedParagraph
+      end.new(context_change)
+    end
+
+    class HtmlParagraph
+      def initialize(content, class_string = "")
+        @content = content
+        @class_string = class_string
+      end
+
+      def to_s
+        str = "<p#{@class_string}>\n"
+        str << "  " << @content
+        str << "\n</p>\n"
+      end
+    end
+
+    class BaseParagraph
+      def initialize(context_change)
+        @context_change = context_change
+      end
+
+      def to_s
+        HtmlParagraph.new(content, html_class_string).to_s
+      end
+    end
+    class PlainParagraph < BaseParagraph
+      def html_class_string
+        ""
+      end
+
+      def content
+        @context_change.old_element
+      end
+    end
+
+    class ClassfulParagraph < BaseParagraph
+      def html_class_string
+        %Q{ class="#{classes.join(" ")}"}
+      end
+    end
+
+    class DeletedParagraph < ClassfulParagraph
+      def content
+        @context_change.old_element
+      end
+    end
+
+    class RemovedParagraph < DeletedParagraph
+      def classes
+        %w[ removed ]
+      end
+    end
+
+    class ReplacedParagraph < DeletedParagraph
+      def classes
+        %w[ removed replaced ]
+      end
+    end
+
+    class AddedParagraph < ClassfulParagraph
+      def classes
+        %w[ added ]
+      end
+      def content
+        @context_change.new_element
+      end
+    end
+
+    class ChangedParagraph
+      include WordRunDiffLCS
+
+      class HtmlText
+        class HtmlSpan
+          def initialize(content, class_string)
+            @content = content
+            @class_string = class_string
+          end
+
+          def to_s
+            %Q{<span class="#@class_string">#@content</span>}
+          end
+        end
+
+        def initialize(context_change)
+          @context_change = context_change
+        end
+
+        def to_s
+          case @context_change.action
+            when "=" then old_text
+            when "-" then removed_span
+            when "+" then added_span
+            when "!" then "#{removed_span} #{added_span}"
+          end.to_s
+        end
+
+        private
+
+        def old_text
+          @context_change.old_element
+        end
+        def removed_span
+          HtmlSpan.new(@context_change.old_element, "removed")
+        end
+
+        def added_span
+          HtmlSpan.new(@context_change.new_element, "added")
+        end
+      end
+
+      def initialize(context_change)
+        @context_change = context_change
+      end
+
+      def to_s
+        if significant_change? && !all_additions_or_removals?
+          removed_paragraph = ReplacedParagraph.new(@context_change)
+          added_paragraph = AddedParagraph.new(@context_change)
+          removed_paragraph.to_s + added_paragraph.to_s
+        else
+          words = word_run_level_sdiff.map { |context_change|
+            HtmlText.new(context_change)
+          }
+          HtmlParagraph.new(words.join(" ")).to_s
+        end
+      end
+
+      private
+
+      WORD_CHANGE_THRESHOLD = 0.25
+
+      def significant_change?
+        count = word_level_sdiff.count { |context_change| context_change.action != "=" }
+        count.to_f / word_level_sdiff.length > WORD_CHANGE_THRESHOLD
+      end
+
+      def all_additions_or_removals?
+        word_level_sdiff.all? { |context_change| context_change.action =~ /^[+=]$/ } ||
+          word_level_sdiff.all? { |context_change| context_change.action =~ /^[-=]$/ }
+      end
+
+                def word_run_level_sdiff
+        word_run_sdiff = WordRunContextChangeSequence.new
+
+        word_level_sdiff.each do |context_change|
+          word_run_sdiff << context_change
+        end
+
+        word_run_sdiff
+      end
+
+      def word_level_sdiff
+        Diff::LCS.sdiff(@context_change.old_element.split, @context_change.new_element.split)
+      end
+    end
+  end
+
+end
+

data/lib/word_run_diff_lcs.rb

@@ -0,0 +1,57 @@
+module WordRunDiffLCS
+  
+  class WordRunContextChange
+    attr_reader :action, :old_element, :new_element
+
+    def initialize(change_context)
+      @action = change_context.action
+      @old_element = change_context.old_element
+      @new_element = change_context.new_element
+    end
+
+    def merge!(change_context)
+      return false unless merge_possible_with?(change_context)
+      @old_element << " #{change_context.old_element}" if change_context.old_element
+      @new_element << " #{change_context.new_element}" if change_context.new_element
+      true
+    end
+
+    private
+
+    def merge_possible_with?(other)
+      return true if action == other.action
+      return true if action == "!" && other.action != "="
+      false
+    end
+  end
+
+  class WordRunContextChangeSequence
+    def initialize
+      @word_run_context_changes = [ ]
+    end
+
+    def <<(diff_lcs_context_change)
+      word_run_context_change = WordRunContextChange.new(diff_lcs_context_change)
+
+      if empty?
+        @word_run_context_changes << word_run_context_change
+      else
+        @word_run_context_changes << word_run_context_change unless last.merge!(word_run_context_change)
+      end
+    end
+    def map(&block)
+      @word_run_context_changes.map(&block)
+    end
+
+    private
+
+    def empty?
+      @word_run_context_changes.empty?
+    end
+
+    def last
+      @word_run_context_changes.last
+    end
+  end
+
+end

data/test/diffrenderer_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class DiffRendererTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'diffrenderer'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: monkeyhelper-diffrenderer
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- robl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-03 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: robl@monkeyhelper.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- diffrenderer.gemspec
+- examples/diff-html.rb
+- examples/diff-text.rb
+- lib/diffrenderer.rb
+- lib/diffrenderer/paragraph_block.rb
+- lib/word_run_diff_lcs.rb
+- test/diffrenderer_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/monkeyhelper/diffrenderer
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: 
+- test/diffrenderer_test.rb
+- test/test_helper.rb
+- examples/diff-text.rb
+- examples/diff-html.rb