unified 1.0.0

data/spec/diff_spec.rb

@@ -0,0 +1,203 @@
+require "unified/diff"
+require "spec_helper"
+
+describe "Unified::Diff" do
+
+  def lines
+    [" Line 1", "+Line 2", "-Line 3"]
+  end
+
+  def chunk(orig = 1, mod = 1, lines = lines)
+    Unified::Chunk.new(original: orig, modified: mod, lines: lines, section_header: "A header")
+  end
+
+  def diff(lines = lines)
+    Unified::Diff.new original_filename: "Original", modified_filename: "Modified",
+                      original_revision: "OrigRev",  modified_revision: "ModRev",
+                      chunks: [chunk(1, 1, lines), chunk(25, 25, lines), chunk(50, 50, lines)]
+  end
+
+  describe ".parse!" do
+    it "parses all valid diff files" do
+      valid_diffs.each do |content|
+        expect { Unified::Diff.parse!(content) }.not_to raise_error
+      end
+    end
+
+    it "returns a Unified::Diff object" do
+      valid_diffs.each do |content|
+        expect(Unified::Diff.parse!(content)).to be_a_kind_of Unified::Diff
+      end
+    end
+
+    it "raises a Unified::ParseError for invalid diffs" do
+      invalid_diffs.each do |content|
+        expect { Unified::Diff.parse!(content) }.to raise_error(Unified::ParseError)
+      end
+    end
+
+    it "provides a line number and character for invalid diffs" do
+      invalid_diffs.each do |content|
+        begin
+          Unified::Diff.parse!(content)
+        rescue Unified::ParseError =>  e
+          e.message.should match /line \d+/
+          e.message.should match /char \d+/
+        end
+      end
+    end
+  end
+
+  describe "#original_filename" do
+    it "returns the correct value" do
+      diff.original_filename.should == "Original"
+    end
+  end
+
+  describe "#modified_filename" do
+    it "returns the correct value" do
+      diff.modified_filename.should == "Modified"
+    end
+  end
+
+  describe "#original_revision" do
+    it "returns the correct value" do
+      diff.original_revision.should == "OrigRev"
+    end
+  end
+
+  describe "#modified_revision" do
+    it "returns the correct value" do
+      diff.modified_revision.should == "ModRev"
+    end
+  end
+
+  describe "#chunks" do
+    it "returns the correct number of chunks" do
+      diff.chunks.size.should == 3
+    end
+    it "returns chunk objects" do
+      diff.chunks.each do |chunk|
+        chunk.should be_a_kind_of Unified::Chunk
+      end
+    end
+  end
+
+  describe "#number_of_added_lines" do
+    it "returns the correct value" do
+      diff.number_of_added_lines.should == 3
+    end
+  end
+
+  describe "#number_of_deleted_lines" do
+    it "returns the correct value" do
+      diff.number_of_deleted_lines.should == 3
+    end
+  end
+
+  describe "#number_of_unchanged_lines" do
+    it "returns the correct value" do
+      diff.number_of_unchanged_lines.should == 3
+    end
+  end
+
+  describe "#number_of_modified_lines" do
+    it "returns the number of additions plus the number of deletions" do
+      diff.number_of_modified_lines.should == 6
+    end
+  end
+
+  describe "#total_number_of_lines" do
+    it "returns the total number of lines" do
+      diff.total_number_of_lines.should == 9
+    end
+  end
+
+  describe "#proportion_of_deleted_lines" do
+    it "returns 0 when there are no deleted lines" do
+      lines = [" Line 1", "+Line 2"]
+      diff(lines).proportion_of_deleted_lines.should == 0
+    end
+
+    it "returns 100 when there are only deleted lines" do
+      lines = ["-Line 1", "-Line 2"]
+      diff(lines).proportion_of_deleted_lines.should == 100
+    end
+
+    it "returns 50 when there are equal added and deleted lines" do
+      lines = ["-Line 1", "+Line 2", " Line 3"]
+      diff(lines).proportion_of_deleted_lines.should == 50
+    end
+
+    it "rounds to the nearest integer when the lines are not evenly divisible" do
+      lines = ["-Line 1", "-Line 2", "+Line 3"]
+      diff(lines).proportion_of_deleted_lines.should == 67
+    end
+  end
+
+  describe "#proportion_of_added_lines" do
+    it "returns 0 when there are no added lines" do
+      lines = [" Line 1", "-Line 2"]
+      diff(lines).proportion_of_added_lines.should == 0
+    end
+
+    it "returns 100 when there are only added lines" do
+      lines = ["+Line 1", "+Line 2"]
+      diff(lines).proportion_of_added_lines.should == 100
+    end
+
+    it "returns 50 when there are equal added and added lines" do
+      lines = ["-Line 1", "+Line 2", " Line 3"]
+      diff(lines).proportion_of_added_lines.should == 50
+    end
+
+    it "rounds to the nearest integer when the lines are not evenly divisible" do
+      lines = ["-Line 1", "-Line 2", "+Line 3"]
+      diff(lines).proportion_of_added_lines.should == 33
+    end
+  end
+
+  describe "#each_chunk" do
+    it "iterates once for every chunk" do
+      index = 0
+      diff.each_chunk do
+        index += 1
+      end
+
+      index.should == 3
+    end
+
+    it "passes a chunk to the block" do
+      diff.each_chunk do |chunk|
+        expect(chunk).to be_a_kind_of Unified::Chunk
+      end
+    end
+  end
+
+  describe "#header" do
+    it "returns a valid diff header" do
+      diff.header.should == "--- Original\tOrigRev\n+++ Modified\tModRev"
+    end
+  end
+
+  describe "#to_s" do
+    it "returns the full diff output" do
+      diff.to_s.should ==  <<-EOF.strip
+--- Original\tOrigRev
++++ Modified\tModRev
+@@ -1,2 +1,2 @@ A header
+ Line 1
++Line 2
+-Line 3
+@@ -25,2 +25,2 @@ A header
+ Line 1
++Line 2
+-Line 3
+@@ -50,2 +50,2 @@ A header
+ Line 1
++Line 2
+-Line 3
+EOF
+    end
+  end
+end

data/spec/examples/invalid/no_chunk_header.diff

@@ -0,0 +1,10 @@
+--- Original	2013-03-23 21:06:27.000000000 +0000
++++ Original	2013-03-23 21:06:48.000000000 +0000
+ Line 1
+ Line 2
+ Line 3
+-Line 5
+-Line 6
+-Line 7
++Line 4
++Line 5

data/spec/examples/invalid/no_modifications.diff

@@ -0,0 +1,11 @@
+--- Original	2013-03-23 21:06:27.000000000 +0000
++++ Original	2013-03-23 21:06:48.000000000 +0000
+@@ -1,4 +1,4 @@
+Line 1
+Line 2
+Line 3
+Line 5
+Line 6
+Line 7
+Line 4
+Line 5

data/spec/examples/invalid/no_modified_file_header.diff

@@ -0,0 +1,6 @@
+--- Original	2013-03-23 21:06:48.000000000 +0000
+@@ -1,4 +1,4 @@
+-Line1
++Line 1
+-Line 3
+-Line 4

data/spec/examples/invalid/no_original_file_header.diff

@@ -0,0 +1,6 @@
++++ Modified	2013-03-23 21:06:48.000000000 +0000
+@@ -1,4 +1,4 @@
+-Line1
++Line 1
+-Line 3
+-Line 4

data/spec/examples/valid/commit_revision.diff

@@ -0,0 +1,5 @@
+--- File1	(revision 815)
++++ File1a	(working copy)
+@@ -1 +1 @@
+-testing1
++tester1

data/spec/examples/valid/modified_filename.diff

@@ -0,0 +1,7 @@
+--- Original	2013-03-23 21:06:27.000000000 +0000
++++ Modified	2013-03-23 21:06:48.000000000 +0000
+@@ -1,4 +1,4 @@
+-Line1
++Line 1
+-Line 3
+-Line 4

data/spec/examples/valid/more_additions.diff

@@ -0,0 +1,7 @@
+--- File1	(revision 815)
++++ File1a	(working copy)
+@@ -1,4 +1,4 @@
+-testing1
++tester1
++One
++Two

data/spec/examples/valid/more_deletions.diff

@@ -0,0 +1,10 @@
+--- Original	2013-03-23 21:06:27.000000000 +0000
++++ Original	2013-03-23 21:06:48.000000000 +0000
+@@ -1,6 +1,4 @@
+ Line 1
+ Line 2
+ Line 3
+-Line 5
+-Line 6
+-Line 7
++Line 4

data/spec/examples/valid/multi_chunk.diff

@@ -0,0 +1,19 @@
+--- multi_chunk	2013-03-24 14:38:43.000000000 +0000
++++ multi_chunk	2013-03-24 14:38:52.000000000 +0000
+@@ -1,7 +1,7 @@
+ Line 1
+ Line 2
+ Line 3
+-Line4
++Line 4
+ Line 5
+ Line 6
+ Line 7
+@@ -15,6 +15,6 @@
+ Line 15
+ Line 16
+ Line 17
+-Line18
++Line 18
+ Line 19
+ Line 20

data/spec/examples/valid/new_file.diff

@@ -0,0 +1,8 @@
+--- spec/factories/diffs/new_file.diff	2013-03-30 21:32:55.000000000 +0000
++++ spec/factories/diffs/new_file.diff	2013-03-30 21:32:44.000000000 +0000
+@@ -0,0 +1,5 @@
++This is a new file
++And these are
++all
++new
++lines

data/spec/examples/valid/no_newline.diff

@@ -0,0 +1,29 @@
+--- a/app/controllers/api/v1/code_reviews_controller.rb
++++ b/app/controllers/api/v1/code_reviews_controller.rb
+@@ -1,24 +1,24 @@
+ module Api
+   module V1
+     class CodeReviewsController < ApplicationController
+       respond_to :json
+ 
+       def create
+         @review = CodeReview.create raw: params[:content]
+         render :json => {
+           url: code_review_path(@review),
+           expires_at: @review.expires_at
+         }
+       end
+ 
+       def show
+-        @review = CodeReview.not_expired.find_by_secure_hash! params[:id]
++        @review = CodeReview.not_expired.find_by_token! params[:id]
+         sleep 0.5 and raise ActiveRecord::RecordNotFound if @review.nil?
+         render :json => {
+           content: @review.raw,
+           expires_at: @review.expires_at
+         }
+       end
+     end
+   end
+ end
+

data/spec/examples/valid/null_git.diff

@@ -0,0 +1,8 @@
+--- /dev/null
++++ /a/new/file
+@@ -0,0 +1,5 @@
++This is a new file
++And these are
++all
++new
++lines

data/spec/examples/valid/removed_file.diff

@@ -0,0 +1,8 @@
+--- spec/factories/diffs/new_file.diff	2013-03-31 13:56:25.000000000 +0100
++++ spec/factories/diffs/new_file.diff	2013-03-31 14:05:49.000000000 +0100
+@@ -1,5 +0,0 @@
+-This is a removed file
+-And these are
+-all
+-removed
+-lines

data/spec/examples/valid/simple.diff

@@ -0,0 +1,11 @@
+--- Original	2013-03-23 21:06:27.000000000 +0000
++++ Original	2013-03-23 21:06:48.000000000 +0000
+@@ -1,6 +1,5 @@ A section heading
+ Line 1
+ Line 2
+ Line 3
+-Line 5
+-Line 6
+-Line 7
++Line 4
++Line 5

data/spec/examples/valid/simple_git.diff

@@ -0,0 +1,29 @@
+--- a/app/controllers/api/v1/code_reviews_controller.rb
++++ b/app/controllers/api/v1/code_reviews_controller.rb
+@@ -1,24 +1,24 @@
+ module Api
+   module V1
+     class CodeReviewsController < ApplicationController
+       respond_to :json
+ 
+       def create
+         @review = CodeReview.create raw: params[:content]
+         render :json => {
+           url: code_review_path(@review),
+           expires_at: @review.expires_at
+         }
+       end
+ 
+       def show
+-        @review = CodeReview.not_expired.find_by_secure_hash! params[:id]
++        @review = CodeReview.not_expired.find_by_token! params[:id]
+         sleep 0.5 and raise ActiveRecord::RecordNotFound if @review.nil?
+         render :json => {
+           content: @review.raw,
+           expires_at: @review.expires_at
+         }
+       end
+     end
+   end
+ end
+

data/spec/line_spec.rb

@@ -0,0 +1,45 @@
+require 'unified/line'
+
+describe "Unified::Line" do
+  it "extends from String" do
+    line = Unified::Line.new "A line"
+    line.should respond_to(:gsub)
+    line.should respond_to(:size)
+  end
+
+  context "additional methods" do
+    let(:addition) { Unified::Line.new "+An addition" }
+    let(:deletion) { Unified::Line.new "-A deletion" }
+    let(:unchanged) { Unified::Line.new " Unchanged" }
+
+    describe "#addition?" do
+      it "is true when a line begins with '+'" do
+        addition.addition?.should be_true
+      end
+      it "is false when a line doesn't begin with '-'" do
+        deletion.addition?.should be_false
+        unchanged.addition?.should be_false
+      end
+    end
+
+    describe "#deletion?" do
+      it "is true when a line begins with '-'" do
+        deletion.deletion?.should be_true
+      end
+      it "is false when a line doesn't begin with '-'" do
+        addition.deletion?.should be_false
+        unchanged.deletion?.should be_false
+      end
+    end
+
+    describe "#unchanged?" do
+      it "is true when a line begins with ' '" do
+        unchanged.unchanged?.should be_true
+      end
+      it "is false when a line doesn't begin with ' '" do
+        addition.unchanged?.should be_false
+        deletion.unchanged?.should be_false
+      end
+    end
+  end
+end