unified_diff 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,6 +1,10 @@
 = unified_diff
 
-Description goes here.
+unified_diff is a simple library to parse unified diffs into clean ruby objects. 
+
+Simply UnifiedDiff.parse(diff_contents) and you'll get back a Diff object with metadata from your diff as well as a list of chunks accesible via Diff#chunks.
+
+More features to follow.
 
 == Contributing to unified_diff
  

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/unified_diff/chunk.rb

@@ -1,30 +1,56 @@
 module UnifiedDiff
   class Chunk
-    attr_reader :old_range,:new_range,:raw_lines
+    attr_reader :original_range,:modified_range,:raw_lines
+
+    # Create a new chunk with the specified modified and original ranges
+    #
+    # @param [Hash] A hash with keys for original and modified line range
+    # @return [Array] the lines in the modified version of the chunk
     def initialize(ranges)
-      @old_range = ranges[:old]
-      @new_range = ranges[:new]
+      @original_range = ranges[:original]
+      @modified_range = ranges[:modified]
       @raw_lines = []
     end
 
+   
+    # Return an array of lines that are present in the modified version of the chunk
+    #
+    # @return [Array] the lines in the modified version of the chunk
+    def modified_lines
+      @raw_lines.select {|line| line[0] == ' ' || line[0] == '+' }.map {|line| line[1..-1] }
+    end
+
+    # Return an array of lines that are present in the original version of the chunk
+    #
+    # @return [Array] the lines in the original version of the chunk
+    def original_lines
+      @raw_lines.select {|line| line[0] == ' ' || line[0] == '-' }.map {|line| line[1..-1] }
+    end
+
+  private
+   # Insert a new addition line into the list of lines for this chunk
+    #
+    # @param [String] the line to be inserted (without '+' tag)
+    # @return [Array] the new list of raw lines
     def insert_addition(line)
       @raw_lines << "+#{line}"
     end
 
+    # Insert a new removal line into the list of lines for this chunk
+    #
+    # @param [String] the line to be inserted (without '-' tag)
+    # @return [Array] the new list of raw lines
     def insert_removal(line)
       @raw_lines << "-#{line}"
     end
 
+    # Insert a new unchanged line into the list of lines for this chunk
+    #
+    # @param [String] the line to be inserted (without ' ' tag)
+    # @return [Array] the new list of raw lines
     def insert_unchanged(line)
       @raw_lines << " #{line}"
     end
 
-    def new_lines
-      @raw_lines.select {|line| line[0] == ' ' || line[0] == '+' }.map {|line| line[1..-1] }
-    end
-
-    def old_lines
-      @raw_lines.select {|line| line[0] == ' ' || line[0] == '-' }.map {|line| line[1..-1] }
-    end
   end
 end

data/lib/unified_diff/diff.rb

@@ -1,7 +1,7 @@
 require 'time'
 module UnifiedDiff
   class Diff
-    attr_reader :original, :old_file, :old_timestamp, :new_file, :new_timestamp, :chunks
+    attr_reader :original, :original_file, :original_timestamp, :modified_file, :modified_timestamp, :chunks
     class UnifiedDiffException < Exception; end
 
     FILE_PATTERN =      /(.*)\t'{2}?(.*)'{2}?/
@@ -24,18 +24,18 @@ module UnifiedDiff
       @original.each_line do |line|
         case line
         when OLD_FILE_PATTERN
-          @old_file, @old_timestamp = $1, Time.parse($2)
+          @original_file, @original_timestamp = $1, Time.parse($2)
         when NEW_FILE_PATTERN
-          @new_file, @new_timestamp = $1, Time.parse($2)
+          @modified_file, @modified_timestamp = $1, Time.parse($2)
         when CHUNK_PATTERN
-          @working_chunk = Chunk.new(:old => ($1.to_i..$2.to_i), :new => ($3.to_i..$4.to_i))
+          @working_chunk = Chunk.new(original: ($1.to_i..$2.to_i), modified: ($3.to_i..$4.to_i))
           @chunks << @working_chunk
         when ADDED_PATTERN
-          @working_chunk.insert_addition($1)
+          @working_chunk.send(:insert_addition, $1)
         when REMOVED_PATTERN
-          @working_chunk.insert_removal($1)
+          @working_chunk.send(:insert_removal, $1)
         when UNCHANGED_PATTERN
-          @working_chunk.insert_unchanged($1)
+          @working_chunk.send(:insert_unchanged, $1)
         else
           raise UnifiedDiffException.new("Unknown Line Type for Line:\n#{line}")
         end

data/test/test_chunk.rb

@@ -2,32 +2,32 @@ require 'helper'
 
 class TestChunk < MiniTest::Unit::TestCase
   def setup
-    @chunk = UnifiedDiff::Chunk.new(old: (1..2), new: (1..3))
+    @chunk = UnifiedDiff::Chunk.new(original: (1..2), modified: (1..3))
   end
 
   def test_ranges_accessible
-    assert_equal (1..2), @chunk.old_range
-    assert_equal (1..3), @chunk.new_range
+    assert_equal (1..2), @chunk.original_range
+    assert_equal (1..3), @chunk.modified_range
   end
 
   def test_raw_lines_accessible_in_order
-    @chunk.insert_unchanged("foo")
-    @chunk.insert_addition( "bar")
-    @chunk.insert_removal(  "baz")
+    @chunk.send(:insert_unchanged,"foo")
+    @chunk.send(:insert_addition, "bar")
+    @chunk.send(:insert_removal,  "baz")
     assert_equal [" foo","+bar","-baz"], @chunk.raw_lines
   end
 
-  def test_old_lines
-    @chunk.insert_unchanged("foo")
-    @chunk.insert_removal("bar")
-    @chunk.insert_addition("baz")
-    assert_equal %w{foo bar}, @chunk.old_lines
+  def test_original_lines
+    @chunk.send(:insert_unchanged,"foo")
+    @chunk.send(:insert_removal,"bar")
+    @chunk.send(:insert_addition,"baz")
+    assert_equal %w{foo bar}, @chunk.original_lines
   end
 
-  def test_new_lines
-    @chunk.insert_unchanged("foo")
-    @chunk.insert_removal("bar")
-    @chunk.insert_addition("baz")
-    assert_equal %w{foo baz}, @chunk.new_lines
+  def test_modified_lines
+    @chunk.send(:insert_unchanged,"foo")
+    @chunk.send(:insert_removal,"bar")
+    @chunk.send(:insert_addition,"baz")
+    assert_equal %w{foo baz}, @chunk.modified_lines
   end
 end

data/test/test_unified_diff.rb

@@ -3,8 +3,8 @@ require 'helper'
 class TestUnifiedDiff < MiniTest::Unit::TestCase
   def setup
     diff = <<-DIFF.unindent
-      --- old.txt	2011-05-31 11:14:13.000000000 -0500
-      +++ new.txt	2011-05-31 11:14:44.000000000 -0500
+      --- original.txt	2011-05-31 11:14:13.000000000 -0500
+      +++ modified.txt	2011-05-31 11:14:44.000000000 -0500
       @@ -1,5 +1,5 @@
        foo
        bar
@@ -20,20 +20,20 @@ class TestUnifiedDiff < MiniTest::Unit::TestCase
     assert_equal UnifiedDiff::Diff, @diff.class
   end
 
-  def test_parses_old_information
-    assert_equal "old.txt", @diff.old_file
-    assert_equal Time.parse('2011-05-31 11:14:13.000000000 -0500'), @diff.old_timestamp
+  def test_parses_original_information
+    assert_equal "original.txt", @diff.original_file
+    assert_equal Time.parse('2011-05-31 11:14:13.000000000 -0500'), @diff.original_timestamp
   end
 
-  def test_parses_new_filename
-    assert_equal "new.txt", @diff.new_file
-    assert_equal Time.parse('2011-05-31 11:14:44.000000000 -0500'), @diff.new_timestamp
+  def test_parses_modified_filename
+    assert_equal "modified.txt", @diff.modified_file
+    assert_equal Time.parse('2011-05-31 11:14:44.000000000 -0500'), @diff.modified_timestamp
   end
 
   def test_parses_chunk_header
     @chunk = @diff.chunks.first
-    assert_equal (1..5), @chunk.old_range
-    assert_equal (1..5), @chunk.new_range
+    assert_equal (1..5), @chunk.original_range
+    assert_equal (1..5), @chunk.modified_range
   end
 
   def test_parses_unchanged_line
@@ -54,8 +54,8 @@ class TestUnifiedDiff < MiniTest::Unit::TestCase
 
   def test_raises_on_invalid_line
     diff = <<-DIFF.unindent
-      --- old.txt	2011-05-31 11:14:13.000000000 -0500
-      +++ new.txt	2011-05-31 11:14:44.000000000 -0500
+      --- original.txt	2011-05-31 11:14:13.000000000 -0500
+      +++ modified.txt	2011-05-31 11:14:44.000000000 -0500
       @@ -1,1 +1,1 @@
       &foo
     DIFF
@@ -64,8 +64,8 @@ class TestUnifiedDiff < MiniTest::Unit::TestCase
 
   def test_parses_multiple_chunks
     diff = <<-DIFF.unindent
-      --- old.txt	2011-05-31 11:14:13.000000000 -0500
-      +++ new.txt	2011-05-31 11:14:44.000000000 -0500
+      --- original.txt	2011-05-31 11:14:13.000000000 -0500
+      +++ modified.txt	2011-05-31 11:14:44.000000000 -0500
       @@ -1,1 +1,1 @@
        -foo
        +bar

data/unified_diff.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{unified_diff}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Ryan Neufeld}]

metadata

@@ -2,7 +2,7 @@
 name: unified_diff
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Ryan Neufeld