document_generator 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de49609b9ec62e17f7f8d95b88d69c8a4194a314
-  data.tar.gz: 846bd6739f10d942ecbee3902efdc6ea6d35cc34
+  metadata.gz: 6871a1067a242543d48a66cd7475e79ece9521d2
+  data.tar.gz: 23a5d3e5ab9d5f8f57e3bac358082529f77b4dcf
 SHA512:
-  metadata.gz: e285f29e9753553baf53644d3869a35302e6f4ed6931654bf736cb2c70626bbe0d860d52a7e710ef03bf7422c1235ed51e6d919bdaa425d90a71b8e7b240124c
-  data.tar.gz: bc5b333e213733c5ccb604869414690531ea75d6fb34295a35bb3dbe3c99797e70191f776c6009efe6b9d6698ef6db3a25242b0ee8454753bb900eca98fc6752
+  metadata.gz: d958dede20b91df5423a6ffe35243a30b52a498e02254737230ecb833ec2898322aa75165b0d5f41945f6fad4f7ebd17c97508e047c98110368fec0b18519f08
+  data.tar.gz: 720106b2000cb8707243a9bbfae1291e9fba2919171989130d15fdc4f8a903418d90552c7d49cc345138ad5a7fc2857c0e373152b370dc15285da265fd84d45d

data/.ruby-version

@@ -1 +1 @@
-ruby-2.0.0-p247
+ruby-2.0.0-p353

data/assets/_layouts/default.html

@@ -24,7 +24,7 @@
       h3 {
         font-size: 16px;
       }
-      h1, h2, h3 {
+      h1, h2 {
         text-transform: uppercase;
       }
     </style>

data/document_generator.gemspec

@@ -28,4 +28,5 @@ DOCUMENT_GENERATOR
   spec.add_development_dependency 'rspec', '~> 2.14'
   spec.add_development_dependency 'rspec-fire', '~> 1.3'
   spec.add_development_dependency 'simplecov', '~> 0.7'
+  spec.add_development_dependency 'pry'
 end

data/lib/document_generator/diff_file.rb

@@ -12,40 +12,44 @@ module DocumentGenerator
       @git_diff_file = git_diff_file
     end
 
-    def git_diff_file_lines
-      git_diff_file.patch.split("\n")
-    end
-
     def patch_heading
       "#{action_type} `#{git_diff_file.path}`"
     end
 
+    def git_diff_file_hunks
+      hunks = git_diff_file.patch.split(/@@.*@@.*\n/)
+      hunks.shift # Shift to pop first element off array which is just git diff header info
+      hunks
+    end
+
+    def git_diff_lines_for(hunk)
+      hunk.split("\n")
+    end
+
     def content
       if type == 'deleted'
-        return patch_heading + "\n\n"
+        return "####{patch_heading}\n\n"
       end
 
       temp = []
-      temp << patch_heading
+      temp << "####{patch_heading}"
 
-      if markdown_outputs.any?
-        markdown_outputs.each do |output|
+      outputs = markdown_outputs
+      if outputs.any?
+        outputs.each do |output|
           if output.escaped_content.length > 0
             temp << "\n\n"
             temp << output.description
             temp << "\n<pre><code>"
-            temp << output.escaped_content
+            if output.description == "Becomes"
+              temp << output.content.join("\n") + "\n"
+            else
+              temp << output.escaped_content
+            end
             temp << "</code></pre>\n"
           end
         end
-      end
 
-      if git_diff_file.type == "modified"
-        temp << "\n\n"
-        temp << "Becomes"
-        temp << "\n<pre><code>"
-        temp << ending_code
-        temp << "\n</code></pre>\n"
       end
 
       temp << "\n\n"
@@ -53,10 +57,18 @@ module DocumentGenerator
       temp.join
     end
 
-    def ending_code
+    def ending_code # The escaped end result code for the whole diff file returned as a string
+      clean_hunks = []
+      git_diff_file_hunks.each do |hunk|
+        clean_hunks << ending_code_for(hunk).join("\n")
+      end
+      Output.no_really_escape(CGI.escapeHTML(clean_hunks.join("\n")))
+    end
+
+    def ending_code_for(hunk) # The unescaped end result code for a particular hunk returned as array
       clean_lines = []
-      git_diff_file_lines[code_line_start..-1].each_with_index do |line, index|
 
+      git_diff_lines_for(hunk).each_with_index do |line, index|
         if (line[0]) == "-" || ignore_line?(line)
           next
         end
@@ -64,9 +76,10 @@ module DocumentGenerator
         if (line[0]) == "+"
           line = remove_first_character(line)
         end
+        line = CGI.unescapeHTML(line) # Shouldn't be necessary?
         clean_lines << line
       end
-      Output.no_really_escape(CGI.escapeHTML(clean_lines.join("\n")))
+      clean_lines
     end
 
     def action_type
@@ -75,63 +88,81 @@ module DocumentGenerator
         deleted: 'Remove file' }.fetch(type.to_sym, type)
     end
 
-    def markdown_outputs # returns an array of outputs
+    def markdown_outputs
+      outputs = []
+      git_diff_file_hunks.each do |hunk|
+        outputs << markdown_outputs_for(hunk)
+      end
+      outputs.flatten
+    end
+
+    def markdown_outputs_for(hunk) # returns an array of outputs for a particular hunk
       outputs = []
-      last_line = 0
-      git_diff_file_lines.each_with_index do |line, index|
-        next if index < code_line_start
+      last_line = -1
+      git_diff_lines_for(hunk).each_with_index do |line, index|
         next if index <= last_line
         case line.strip[0]
 
         when "+"
-          last_line = last_same_line(index)
+          last_line = last_same_line(index, hunk)
           output = Output.new
           output.description = "Add"
-          output.content = line_block(index, last_line)
+          output.content = line_block(index, last_line, hunk)
           outputs << output
         when "-"
-          if line_sign(index + 1) == "+"
+          if line_sign(index + 1, hunk) == "+"
             output = Output.new
             output.description = "Change"
-            output.content = line_block(index, last_same_line(index))
+            output.content = line_block(index, last_same_line(index, hunk), hunk)
             outputs << output
-            last_line = last_same_line(last_same_line(index) + 1)
+            last_line = last_same_line(last_same_line(index, hunk) + 1, hunk)
+
             output = Output.new
             output.description = "To"
-            output.content = line_block(last_same_line(index) + 1, last_line)
+            output.content = line_block(last_same_line(index, hunk) + 1, last_line, hunk)
             outputs << output
+            last_line = last_same_line(last_same_line(index, hunk) + 1, hunk)
           else
             output = Output.new
             output.description = "Remove"
-            last_line = last_same_line(index)
-            output.content = line_block(index, last_line)
+            last_line = last_same_line(index, hunk)
+            output.content = line_block(index, last_line, hunk)
             outputs << output
           end
         end
+      end
 
+      if git_diff_file.type == 'modified'
+        output = Output.new
+        output.description = "Becomes"
+        output.content = ending_code_for(hunk)
+        outputs << output
       end
+
       outputs
     end
 
-  private
+
+
+    private
 
     def ignore_line?(line)
       line.strip == 'No newline at end of file'
     end
 
-    def last_same_line(line_index)
-      starting_sign = line_sign(line_index)
+    def last_same_line(line_index, hunk)
+      starting_sign = line_sign(line_index, hunk)
 
-      git_diff_file_lines[line_index..-1].each_with_index do |line, index|
-        if line_sign(index + 1 + line_index) != starting_sign
+      git_diff_lines_for(hunk)[line_index..-1].each_with_index do |line, index|
+        if line_sign(index + 1 + line_index, hunk) != starting_sign
           return (index + line_index)
         end
       end
     end
 
-    def line_block(beginning, ending)
+    def line_block(beginning, ending, hunk)
       lines = []
-      git_diff_file_lines[beginning..ending].each do |line|
+      git_diff_lines_for(hunk)[beginning..ending].each do |line|
         if ["+", "-"].include?(line[0..0])
           line = remove_first_character(line)
         end
@@ -142,18 +173,12 @@ module DocumentGenerator
       lines
     end
 
-    def line_sign(line_number)
-      (git_diff_file_lines[line_number] || '').strip[0]
+    def line_sign(line_number, hunk)
+      (git_diff_lines_for(hunk)[line_number] || '').strip[0]
     end
 
     def remove_first_character(line)
       " " + line[1..-1]
     end
-
-    def code_line_start
-      git_diff_file_lines.each_with_index do |line, index|
-        return (index + 1) if line[0..1] == "@@"
-      end
-    end
   end
 end

data/lib/document_generator/output.rb

@@ -14,6 +14,10 @@ module DocumentGenerator
       end.join("\n")
     end
 
+    def self.no_really_unescape(value)
+      value.gsub(' ', ' ')
+    end
+
     def escaped_content
       temp = []
       content.each do |line|

data/lib/document_generator/version.rb

@@ -1,3 +1,3 @@
 module DocumentGenerator
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/spec/lib/document_generator/diff_file_spec.rb

@@ -29,7 +29,7 @@ EXPECTED
 
     let(:expected_content) do
 <<-EXPECTED_CONTENT
-Create file `/spec/support/capybara.rb`
+###Create file `/spec/support/capybara.rb`
 
 Add
 <pre><code> Capybara.javascript_driver = :webkit</code></pre>
@@ -168,8 +168,11 @@ EXPECTED_CONTENT
         expect(diff_file.markdown_outputs.first.description).to eq "Change"
         expect(diff_file.markdown_outputs.first.escaped_content).to eq CGI.escapeHTML(" <%= form_for :post do |f| %>")
 
-        expect(diff_file.markdown_outputs.last.description).to eq "To"
-        expect(diff_file.markdown_outputs.last.escaped_content).to eq CGI.escapeHTML(" <%= form_for :post, url: posts_path do |f| %>")
+        expect(diff_file.markdown_outputs[1].description).to eq "To"
+        expect(diff_file.markdown_outputs[1].escaped_content).to eq CGI.escapeHTML(" <%= form_for :post, url: posts_path do |f| %>")
+
+        expect(diff_file.markdown_outputs[2].description).to eq "Becomes"
+        expect(diff_file.markdown_outputs[2].escaped_content).to eq diff_file.ending_code
       end
     end
 
@@ -181,6 +184,139 @@ EXPECTED_CONTENT
     end
   end
 
+  context 'when the git diff file has two changes in different hunks' do
+    let(:type) { 'modified' }
+    let(:file_name) { '/spec/controllers/posts_controller_spec.rb' }
+
+    let(:patch) do
+<<-PATCH
+stuffasdfasdfadasdfasd
+asdadsfasdfasdf
+asdfasdfasdfasdf
+@@ -5,7 +5,7 @@
+   describe 'GET #new' do
+     it "returns http success" do
+       get :new
+-      response.should be_success
++      expect(response).to be_success
+     end
+   end
+
+@@ -19,7 +19,7 @@
+   describe 'GET #index' do
+     it "returns http success" do
+       get :index
+-      response.should be_success
++      expect(response).to be_success
+     end
+   end
+ end
+PATCH
+    end
+
+    let(:ending) do
+<<-ENDING
+   describe 'GET #new' do
+     it "returns http success" do
+       get :new
+       expect(response).to be_success
+     end
+   end
+   describe 'GET #index' do
+     it "returns http success" do
+       get :index
+       expect(response).to be_success
+     end
+   end
+ end
+ENDING
+    end
+
+    let(:expected_content) do
+<<-EXPECTED_CONTENT
+###Update file `/spec/controllers/posts_controller_spec.rb`
+
+Change
+<pre><code>       response.should be_success</code></pre>
+
+
+To
+<pre><code>       expect(response).to be_success</code></pre>
+
+
+Becomes
+<pre><code>   describe 'GET #new' do
+     it "returns http success" do
+       get :new
+       expect(response).to be_success
+     end
+   end
+</code></pre>
+
+
+Change
+<pre><code>       response.should be_success</code></pre>
+
+
+To
+<pre><code>       expect(response).to be_success</code></pre>
+
+
+Becomes
+<pre><code>   describe 'GET #index' do
+     it "returns http success" do
+       get :index
+       expect(response).to be_success
+     end
+   end
+ end
+</code></pre>
+
+
+EXPECTED_CONTENT
+    end
+
+    describe '#content' do
+      it 'includes the Becomes section' do
+        expect(diff_file.content).to eq expected_content
+      end
+    end
+
+    describe '#ending_code' do
+      it 'contains the ending_code' do
+        expect(diff_file.ending_code).to eq DocumentGenerator::Output.no_really_escape(CGI.escapeHTML(ending.rstrip))
+      end
+    end
+
+    describe '#action_type' do
+      it 'outputs correct phrase for action_type' do
+        expect(diff_file.action_type).to eq "Update file"
+      end
+    end
+
+    describe '#markdown_outputs' do
+      it 'has correct markdown outputs' do
+        expect(diff_file.markdown_outputs.first.description).to eq "Change"
+        expect(diff_file.markdown_outputs.first.content).to eq ["       response.should be_success"]
+
+        expect(diff_file.markdown_outputs[1].description).to eq "To"
+        expect(diff_file.markdown_outputs[1].content).to eq ["       expect(response).to be_success"]
+
+        expect(diff_file.markdown_outputs[2].description).to eq "Becomes"
+        expect(diff_file.markdown_outputs[2].content).to eq ["   describe 'GET #new' do", "     it \"returns http success\" do", "       get :new", "       expect(response).to be_success", "     end", "   end"]
+
+        expect(diff_file.markdown_outputs[3].description).to eq "Change"
+        expect(diff_file.markdown_outputs[3].content).to eq ["       response.should be_success"]
+
+        expect(diff_file.markdown_outputs[4].description).to eq "To"
+        expect(diff_file.markdown_outputs[4].content).to eq ["       expect(response).to be_success"]
+
+        expect(diff_file.markdown_outputs[5].description).to eq "Becomes"
+        expect(diff_file.markdown_outputs[5].content).to eq ["   describe 'GET #index' do", "     it \"returns http success\" do", "       get :index", "       expect(response).to be_success", "     end", "   end", " end"]
+      end
+    end
+  end
+
   context 'when the git diff file has two changes' do
     let(:type) { 'modified' }
     let(:file_name) { '/spec/controllers/posts_controller_spec.rb' }
@@ -220,7 +356,7 @@ ENDING
 
     let(:expected_content) do
 <<-EXPECTED_CONTENT
-Update file `/spec/controllers/posts_controller_spec.rb`
+###Update file `/spec/controllers/posts_controller_spec.rb`
 
 Change
 <pre><code>   describe GET new do</code></pre>
@@ -240,7 +376,7 @@ To
 
 Becomes
 <pre><code>describe PostsController do
-&nbsp;
+
    describe GET new do
    it returns http success do
        get new
@@ -284,6 +420,9 @@ EXPECTED_CONTENT
 
         expect(diff_file.markdown_outputs[3].description).to eq "To"
         expect(diff_file.markdown_outputs[3].content).to eq ["       get new"]
+
+        expect(diff_file.markdown_outputs[4].description).to eq "Becomes"
+        expect(diff_file.markdown_outputs[4].content).to eq ["describe PostsController do", "", "   describe GET new do", "   it returns http success do", "       get new", "     response.should be_success", "   end", " end"]
       end
     end
   end
@@ -352,7 +491,7 @@ PATCH
 
     let(:expected_content) do
 <<-EXPECTED_CONTENT
-Create file `/spec/support/capybara.rb`
+###Create file `/spec/support/capybara.rb`
 
 Add
 <pre><code> Capybara.javascript_driver = :webkit</code></pre>
@@ -424,7 +563,7 @@ PATCH
 
     let(:expected_content) do
 <<-EXPECTED_CONTENT
-Remove file `/app/helpers/welcome_helper.rb`
+###Remove file `/app/helpers/welcome_helper.rb`
 
 EXPECTED_CONTENT
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: document_generator
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - wiscoDude
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-27 00:00:00.000000000 Z
+date: 2014-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -110,6 +110,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   Generate documentation from a git repository.
 email:
@@ -163,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Generate documentation from a git repository.