pretty_diff 0.4.0 → 0.5.0

data/README.rdoc

@@ -20,7 +20,7 @@ http://ilya.sabanin.ru/projects/pretty_diff_example.html
 
 == Features
 
-The library is really easy to read and change. All HTML is concentrated in a single place -- HtmlGenerator; so it's very easy to customize the output to suit your needs.
+The library is really easy to read and change. All HTML is generated by a set of classes called generators, it's very easy to customize the output to suit your needs.
 
 By default PrettyDiff will generate HTML that can be easily colored with the CSS that you can find in the example above.
 

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/lib/pretty_diff/chunk.rb

@@ -13,11 +13,9 @@ class PrettyDiff::Chunk #:nodoc:
   def to_html
     # We have to find lines before we can call line numbers methods.
     find_lines!
-    PrettyDiff::HtmlGenerator.generate_chunk(line_numbers, lines)
+    generator.generate
   end
   
-private
-
   # Return LineNumbers object that represents two columns of numbers
   # that will be displayed on the left of the HTML presentation.
   #
@@ -26,6 +24,12 @@ private
   def line_numbers
     @_line_numbers ||= PrettyDiff::LineNumbers.new(meta_info)
   end
+  
+private
+
+  def generator
+    @_generator ||= PrettyDiff::ChunkGenerator.new(self)
+  end
 
   # Parse the input searching for lines. Initialize Line object for every line.
   # Return an array of Line objects.

data/lib/pretty_diff/diff.rb

@@ -4,40 +4,39 @@ require 'cgi'
 # Main class to interact with. In fact this is the only class you should interact with
 # when using the library.
 # 
-# === Usage example:
+# === Usage example
 #  pretty = PrettyDiff::Diff.new(udiff)
 #  pretty.to_html
 #
 # Keep in mind that Diff will automatically escape all HTML tags from the intput string
 # so that it doesn't interfere with the output.
 #
-# === Behind The Scenes:
-# The Diff class is parsing input string and searching for Chunks.
-# It's then asking HtmlGenerator to generate HTML for those chunks. 
-#
 class PrettyDiff::Diff
   CHUNK_REGEXP = /@@ .+ @@\n/
 
   attr_reader :input
 
   # Create new Diff object. Accept a String in unified diff format.
-  # Will automatically escape HTML tags from it.
   def initialize(unified_diff)
     @input = escape_html(unified_diff)
   end
 
   # Generate HTML presentation. Return a string.
   def to_html    
-    PrettyDiff::HtmlGenerator.generate_diff(chunks)
+    generator.generate
   end
-
-private
-
+  
   # Return an array of Chunk objects that Diff found in the input.
   def chunks
     @_chunks ||= find_chunks(input)
   end
 
+private
+
+  def generator
+    @_generator ||= PrettyDiff::DiffGenerator.new(self)
+  end
+
   # Parse the input for diff chunks and initialize a Chunk object for each of them.
   # Return an array of Chunks.
   def find_chunks(text)

data/lib/pretty_diff/html_generators/chunk_generator.rb

@@ -0,0 +1,35 @@
+class PrettyDiff::ChunkGenerator
+  
+  attr_reader :chunk
+  
+  def initialize(chunk)
+    @chunk = chunk
+  end
+  
+  def generate
+    start_html +
+    chunk.line_numbers.to_html +
+    code_html(content) +
+    end_html
+  end
+  
+private
+
+  def content
+    chunk.lines.map{|l| l.to_html }.join("\n")
+  end
+
+  def start_html
+    %Q[<tr>]
+  end
+  
+  def code_html(text)
+    %Q[<td class="code"><div class="highlight"><pre>
+#{text}</pre></div></td>]
+  end
+  
+  def end_html
+    %Q[</tr>]
+  end
+  
+end

data/lib/pretty_diff/html_generators/diff_generator.rb

@@ -0,0 +1,28 @@
+class PrettyDiff::DiffGenerator
+  
+  attr_reader :diff
+  
+  def initialize(diff)
+    @diff = diff
+  end
+  
+  def generate
+    chunks_html = diff.chunks.map{|c| c.to_html}.join(chunk_separator_html).to_s
+    intro_html + chunks_html + outro_html
+  end
+
+private
+
+  def intro_html
+    %Q[<table class="highlighttable">]
+  end
+  
+  def chunk_separator_html
+    %Q[<tr class="chunk_separator"><td colspan="3"></td></tr>]
+  end
+  
+  def outro_html
+    %Q[</table>]
+  end
+  
+end

data/lib/pretty_diff/html_generators/line_generator.rb

@@ -0,0 +1,43 @@
+class PrettyDiff::LineGenerator
+  
+  attr_reader :line
+  
+  def initialize(line)
+    @line = line
+  end
+  
+  def generate
+    if line.added?
+      added_html(content)
+    elsif line.deleted?
+      deleted_html(content)
+    else
+      not_modified_html(content)
+    end
+  end
+  
+private
+
+  def content
+    @_content ||= line.format
+  end
+  
+  def wrapper_html
+    %Q[<div>] +
+    yield +
+    %Q[</div>]
+  end
+
+  def added_html(text)
+    wrapper_html { %Q[<span class="gi">#{text}</span>] }
+  end
+
+  def deleted_html(text)
+    wrapper_html { %Q[<span class="gd">#{text}</span>] }
+  end
+
+  def not_modified_html(text)
+    wrapper_html { %Q[#{text}] }
+  end
+  
+end

data/lib/pretty_diff/html_generators/line_numbers_generator.rb

@@ -0,0 +1,28 @@
+class PrettyDiff::LineNumbersGenerator
+  
+  attr_reader :line_numbers
+  
+  def initialize(line_numbers)
+    @line_numbers = line_numbers
+  end
+  
+  def generate
+    column_html(left_column) + column_html(right_column)
+  end
+  
+private
+
+  def left_column
+    line_numbers.left_column.join("\n")
+  end
+  
+  def right_column
+    line_numbers.right_column.join("\n")
+  end
+  
+  def column_html(text)
+    %Q[<td class="linenos"><pre>
+#{text}</pre></td>]
+  end
+  
+end

data/lib/pretty_diff/line.rb

@@ -2,6 +2,7 @@
 # Represent a single line of the diff.
 #
 class PrettyDiff::Line #:nodoc:
+  
   attr_reader :input
   
   def initialize(input)
@@ -10,13 +11,13 @@ class PrettyDiff::Line #:nodoc:
   
   # Generate HTML presentation for a Line. Return a string.
   def to_html
-    PrettyDiff::HtmlGenerator.generate_line(self)
+    generator.generate
   end
   
   # Prepare Line contents for injection into HTML structure.
   # Currently used for replacing Tab symbols with spaces.
   # Return a string.
-  def rendered
+  def format
     input.gsub("\t", '  ')
   end
   
@@ -50,4 +51,11 @@ class PrettyDiff::Line #:nodoc:
   def not_modified?
     status == :not_modified
   end
+  
+private
+
+  def generator
+    @_generator ||= PrettyDiff::LineGenerator.new(self)
+  end
+  
 end

data/lib/pretty_diff/line_numbers.rb

@@ -23,14 +23,7 @@ class PrettyDiff::LineNumbers #:nodoc:
   
   # Generate HTML presentation for a both line numbers columns. Return a string.
   def to_html
-    PrettyDiff::HtmlGenerator.generate_line_numbers(left_column, right_column)
-  end
-  
-private
-  
-  # Search for information about line numbers changes provided by unified diff format.
-  def scan_meta(target)
-    meta_info.scan(target).flatten.first
+    generator.generate
   end
   
   def left_column
@@ -41,6 +34,17 @@ private
     @right_column ||= []
   end
   
+private
+
+  def generator
+    @_generator ||= PrettyDiff::LineNumbersGenerator.new(self)
+  end
+  
+  # Search for information about line numbers changes provided by unified diff format.
+  def scan_meta(target)
+    meta_info.scan(target).flatten.first
+  end
+  
   # Return starting number for the left column according to unified diff information.
   def left_starts_at
     scan_meta(/^@@ -(\d+),/).to_i
@@ -54,7 +58,7 @@ private
   # Increase left column line number by one.
   def increase_left
     left_column  << increase_or_start(:left)
-    right_column << nil    
+    right_column << nil
   end
   
   # Increase right column line number by one.

data/lib/pretty_diff.rb

@@ -1,9 +1,17 @@
 module PrettyDiff #:nodoc:
 end
 
-require 'pretty_diff/support'
-require 'pretty_diff/diff'
-require 'pretty_diff/chunk'
-require 'pretty_diff/line'
-require 'pretty_diff/line_numbers'
-require 'pretty_diff/html_generator'
+def require_local(suffix)
+  require(File.expand_path(File.join(File.dirname(__FILE__), suffix)))
+end
+
+require_local 'pretty_diff/support'
+require_local 'pretty_diff/diff'
+require_local 'pretty_diff/chunk'
+require_local 'pretty_diff/line_numbers'
+require_local 'pretty_diff/line'
+
+require_local 'pretty_diff/html_generators/diff_generator'
+require_local 'pretty_diff/html_generators/chunk_generator'
+require_local 'pretty_diff/html_generators/line_generator'
+require_local 'pretty_diff/html_generators/line_numbers_generator'

data/pretty_diff.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pretty_diff}
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ilya Sabanin"]
-  s.date = %q{2010-01-20}
+  s.date = %q{2010-01-24}
   s.description = %q{PrettyDiff is a highly customizable library for creating fully featured HTML
                        listings out of unified diff format strings.
                        Include copy/paste-safe line numbers and built-in syntax highlighting.}
@@ -28,7 +28,10 @@ Gem::Specification.new do |s|
      "lib/pretty_diff.rb",
      "lib/pretty_diff/chunk.rb",
      "lib/pretty_diff/diff.rb",
-     "lib/pretty_diff/html_generator.rb",
+     "lib/pretty_diff/html_generators/chunk_generator.rb",
+     "lib/pretty_diff/html_generators/diff_generator.rb",
+     "lib/pretty_diff/html_generators/line_generator.rb",
+     "lib/pretty_diff/html_generators/line_numbers_generator.rb",
      "lib/pretty_diff/line.rb",
      "lib/pretty_diff/line_numbers.rb",
      "lib/pretty_diff/support.rb",

data/test/chunk_test.rb

@@ -32,5 +32,6 @@ class ChunkTest < Test::Unit::TestCase
     should "find correct amount of lines" do
       assert @chunk.lines.size == 8
     end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pretty_diff
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Ilya Sabanin
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-20 00:00:00 +07:00
+date: 2010-01-24 00:00:00 +07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,7 +44,10 @@ files:
 - lib/pretty_diff.rb
 - lib/pretty_diff/chunk.rb
 - lib/pretty_diff/diff.rb
-- lib/pretty_diff/html_generator.rb
+- lib/pretty_diff/html_generators/chunk_generator.rb
+- lib/pretty_diff/html_generators/diff_generator.rb
+- lib/pretty_diff/html_generators/line_generator.rb
+- lib/pretty_diff/html_generators/line_numbers_generator.rb
 - lib/pretty_diff/line.rb
 - lib/pretty_diff/line_numbers.rb
 - lib/pretty_diff/support.rb

data/lib/pretty_diff/html_generator.rb

@@ -1,91 +0,0 @@
-#
-# This is where all HTML stuff is kept. The module is responsible for converting
-# various PrettyDiff classes into HTML.
-# 
-# By customizing this file you can suit the output precisely to your needs.
-#
-# By default all HTML is generated with a built-in support for coloring using a
-# CSS file that's available here:
-#
-# http://ilya.sabanin.ru/projects/pretty_diff_example.html
-#
-module PrettyDiff::HtmlGenerator #:nodoc:
-  extend self
-  
-  def intro
-    %Q[<table class="highlighttable">]
-  end
-
-  def chunk_start
-    %Q[<tr>]
-  end
-  
-  def line_numbers_column(text)
-    %Q[<td class="linenos"><pre>
-#{text}</pre></td>]
-  end
-  
-  def code(text)
-    %Q[<td class="code"><div class="highlight"><pre>
-#{text}</pre></div></td>]
-  end
-  
-  def added_line(text)
-    %Q[<div><span class="gi">#{text}</span></div>]
-  end
-
-  def deleted_line(text)
-    %Q[<div><span class="gd">#{text}</span></div>]
-  end
-
-  def not_modified_line(text)
-    %Q[<div>#{text}</div>]
-  end
-
-  def chunk_end
-    %Q[</tr>]
-  end
-  
-  def chunk_separator
-    %Q[<tr class="chunk_separator"><td colspan="3"></td></tr>]
-  end
-  
-  def outro
-    %Q[</table>]
-  end
-  
-  def generate_diff(chunks)
-    chunks_html = chunks.map{|c| c.to_html}.join(chunk_separator).to_s
-    intro + chunks_html + outro
-  end
-  
-  def generate_chunk(numbers, lines)
-    lines_html = lines.map{|l| l.to_html }.join("\n")
-    chunk_start +
-    numbers.to_html +
-    code(lines_html) +
-    chunk_end
-  end
-  
-  def generate_line_numbers(left, right)
-    [left, right].each do |column|
-      column.map! do |num|
-        if num.nil? then '' else %Q{<a href="#">#{num}</a>} end
-      end
-    end
-    line_numbers_column(left.join("\n")) +
-    line_numbers_column(right.join("\n"))
-  end
-  
-  def generate_line(obj)
-    content = obj.rendered
-    if obj.added?
-      added_line(content)
-    elsif obj.deleted?
-      deleted_line(content)
-    else
-      not_modified_line(content)
-    end
-  end
-  
-end