document_generator 0.0.2

data/lib/document_generator/version.rb

@@ -0,0 +1,3 @@
+module DocumentGenerator
+  VERSION = '0.0.2'
+end

data/spec/lib/document_generator/cli_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module DocumentGenerator
+  describe CLI do
+    describe '.start' do
+      context 'when a url is supplied' do
+        let(:args) { %w(--url http://some.repo.url) }
+        let(:repository) { instance_double('Repository') }
+
+        it 'sends the :generate message to a new Repository' do
+          expect(Repository).to receive(:new).with('http://some.repo.url').and_return repository
+          expect(repository).to receive(:generate)
+
+          CLI.start(args)
+        end
+
+      end
+      context 'when no args are supplied' do
+        let(:args) { [] }
+
+        it 'raises a MissingArgument error' do
+          expect { CLI.start(args) }.to raise_error(OptionParser::MissingArgument)
+        end
+      end
+    end
+  end
+end

data/spec/lib/document_generator/commit_spec.rb

@@ -0,0 +1,243 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+describe DocumentGenerator::Commit do
+  let(:commit) { described_class.new(base_url, git_commit) }
+  let(:git_commit) { double(message: message, sha: sha) }
+  let(:base_url) { 'http://github.com/stevenhallen/document_generator' }
+  let(:message) { 'Some commit message' }
+  let(:sha) { 'da39a3ee5e6b4b0d3255bfef95601890afd80709' }
+
+  describe '#diff_files' do
+    let(:git_commit) { double(parent: parent) }
+
+    context 'when the git_commit has a parent' do
+      let(:parent) { double().as_null_object }
+      let(:git_diff) { %w(1 2 3) }
+      let(:wrapped_git_diff) do
+        git_diff.map do |git_diff_file|
+          DocumentGenerator::DiffFile.new(git_diff_file)
+        end
+      end
+
+      before { parent.should_receive(:diff).with(git_commit).and_return git_diff }
+
+      it 'is an array of wrapped diff files' do
+        expect(commit.diff_files).to be_an(Array)
+      end
+
+      it 'has three items' do
+        expect(commit.diff_files).to have(3).items
+      end
+
+      it 'is an array of DiffFiles wrapping each git diff file' do
+        commit.diff_files.zip(wrapped_git_diff).each do |actual, expected|
+          expect(actual).to be_a(DocumentGenerator::DiffFile)
+          expect(actual.git_diff_file).to eq expected.git_diff_file
+        end
+      end
+    end
+
+    context 'when the git_commit does not have a parent' do
+      let(:parent) {nil}
+
+      it 'is empty' do
+        expect(commit.diff_files).to be_empty
+      end
+    end
+  end
+
+  describe '#relative_filename' do
+    it 'is the filename' do
+      expect(commit.relative_filename).to eq 'some-commit-message.md'
+    end
+  end
+
+  describe '#create' do
+    let(:parent) { double().as_null_object }
+    let(:git_commit) { double(parent: parent, message: message, sha: sha) }
+    let(:content) { File.open(commit.relative_filename).read }
+    let(:sha) { 'da39a3ee5e6b4b0d3255bfef95601890afd80709' }
+
+    context 'when the commit is the first commit (i.e., it has no parent)' do
+      let(:parent) { nil }
+      let(:message) { 'first commit' }
+      let(:expected_content) do
+        <<-EOF
+---
+layout: default
+title: first commit
+---
+
+<h1 id="main">first commit</h1>
+
+### Additional Resources
+
+* [Changes in this step in `diff` format](http://github.com/stevenhallen/commit/da39a3ee5e6b4b0d3255bfef95601890afd80709)
+
+EOF
+
+      end
+
+      it 'writes the expected content to the file' do
+        commit.create
+        expect(content).to eq expected_content
+      end
+    end
+
+    context 'when the commit has a diff from its parent' do
+      before do
+        expect(parent).to receive(:diff).with(git_commit).and_return git_diff_files
+        expect(DocumentGenerator::DiffFile).to receive(:new).and_return diff_file
+      end
+
+      let(:message) { 'some commit message' }
+      let(:diff_file) { double(content: 'the diff_file content').as_null_object }
+      let(:git_diff_file) { double().as_null_object }
+      let(:git_diff_files) { [git_diff_file] }
+      let(:expected_content) do
+        <<-EOF
+---
+layout: default
+title: some commit message
+---
+
+<h1 id="main">some commit message</h1>
+the diff_file content
+### Additional Resources
+
+* [Changes in this step in `diff` format](http://github.com/stevenhallen/commit/da39a3ee5e6b4b0d3255bfef95601890afd80709)
+
+EOF
+      end
+
+      it 'writes the expected content to the file' do
+        commit.create
+        expect(content).to eq expected_content
+      end
+    end
+  end
+
+  describe '#header' do
+    context 'when the commit message has one line' do
+      let(:message) {'This is one line'}
+      let(:expected_header) do
+<<-EXPECTED
+---
+layout: default
+title: This is one line
+---
+
+<h1 id="main">This is one line</h1>
+EXPECTED
+      end
+
+      it 'uses the entire commit message' do
+        expect(commit.header).to eq expected_header
+      end
+    end
+
+    context 'when the commit message has more than one line' do
+      let(:message) {"This is one line\nThis is a second line."}
+      let(:expected_header) do
+<<-EXPECTED
+---
+layout: default
+title: This is one line
+---
+
+<h1 id="main">This is one line</h1>
+EXPECTED
+      end
+
+      it 'uses the first line of the commit message' do
+        expect(commit.header).to eq expected_header
+      end
+    end
+  end
+
+  describe '#additional' do
+    let(:expected_additional) do
+<<-EXPECTED_ADDITIONAL
+
+### Additional Resources
+
+* [Changes in this step in `diff` format](http://github.com/stevenhallen/commit/da39a3ee5e6b4b0d3255bfef95601890afd80709)
+
+EXPECTED_ADDITIONAL
+    end
+
+    it 'includes a link to the commit' do
+      expect(commit.additional).to eq expected_additional
+    end
+  end
+
+  describe '#details_of_commit_message' do
+    context 'when the commit message is one line' do
+      let(:message) { 'One line' }
+
+      it 'is nil' do
+        expect(commit.details_of_commit_message).to be_nil
+      end
+    end
+
+    context 'when the commit message is multiple lines' do
+      let(:message) { "One line\nTwo lines\nThree and more" }
+
+      it 'is not empty' do
+        expect(commit.details_of_commit_message).to eq "Two lines\nThree and more"
+      end
+    end
+  end
+
+  describe '#basename_prefix' do
+    context 'when the commit message contains non word characters' do
+      let(:message) { 'Message with non->word characters!'}
+
+      it 'strips non word characters' do
+        expect(commit.basename_prefix).to eq 'message-with-non-word-characters'
+      end
+    end
+
+    context 'when the commit message contains an underscore' do
+      let(:message) { 'Message with an_underscore!'}
+
+      it 'replaces underscores with dashes' do
+        expect(commit.basename_prefix).to eq 'message-with-an-underscore'
+      end
+    end
+
+    context 'when the commit message contains non normalized space' do
+      let(:message) { 'Message with non     normalized space'}
+
+      it 'normalizes whitespace' do
+        expect(commit.basename_prefix).to eq 'message-with-non-normalized-space'
+      end
+    end
+
+    context 'when the commit message contains unicode' do
+      let(:message) { 'Message with unicode‽'}
+
+      it 'removes unicode characters' do
+        expect(commit.basename_prefix).to eq 'message-with-unicode'
+      end
+    end
+  end
+
+  describe '#filename' do
+    let(:message) { 'Simple commit message' }
+
+    it 'appends .md to the basename_prefix' do
+      expect(commit.filename).to eq 'simple-commit-message.md'
+    end
+  end
+
+  describe '#link' do
+    let(:message) { 'Simple commit message' }
+
+    it 'links to the filename' do
+      expect(commit.link).to eq "<li><a href='simple-commit-message.html'>Simple commit message</a></li>"
+    end
+  end
+end

data/spec/lib/document_generator/diff_file_spec.rb

@@ -0,0 +1,438 @@
+require 'spec_helper'
+
+describe DocumentGenerator::DiffFile do
+  let(:diff_file) { described_class.new(git_diff_file) }
+  let(:git_diff_file) { double(type: type, patch: patch, path: file_name) }
+
+  context 'when the git diff represents a new file' do
+    let(:type) { 'new' }
+    let(:file_name) { '/spec/support/capybara.rb' }
+
+    let(:patch) do
+<<-PATCH
+diff --git a/spec/support/capybara.rb b/spec/support/capybara.rb
+new file mode 100644
+index 0000000..12cefac
+--- /dev/null
++++ b/spec/support/capybara.rb
+@@ -0,0 +1 @@
++Capybara.javascript_driver = :webkit
+
+PATCH
+    end
+
+    let(:ending) do
+<<-EXPECTED
+ Capybara.javascript_driver = :webkit
+EXPECTED
+    end
+
+    let(:expected_content) do
+<<-EXPECTED_CONTENT
+Create file `/spec/support/capybara.rb`
+
+Add
+<pre><code> Capybara.javascript_driver = :webkit</code></pre>
+
+
+EXPECTED_CONTENT
+    end
+
+    describe '#patch_heading' do
+      it 'has correct type and path' do
+        expect(diff_file.patch_heading).to eq "Create file `#{file_name}`"
+      end
+    end
+
+    describe '#content' do
+      it 'contains the expected content' 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 ending.rstrip
+      end
+    end
+
+    describe '#action_type' do
+      it 'outputs correct phrase for action_type' do
+        expect(diff_file.action_type).to eq "Create file"
+      end
+    end
+
+    describe '#markdown_outputs' do
+      it 'has correct markdown outputs' do
+        expect(diff_file.markdown_outputs.first.description).to eq "Add"
+        expect(diff_file.markdown_outputs.first.escaped_content).to eq CGI.escapeHTML(" Capybara.javascript_driver = :webkit")
+      end
+    end
+  end
+
+  context 'when the git diff represents a changed file' do
+    let(:type) { 'modified' }
+    let(:file_name) { '/app/views/posts/new.html.erb' }
+
+    let(:patch) do
+<<-PATCH
+diff --git a/app/views/posts/new.html.erb b/app/views/posts/new.html.erb
+index 58053b0..ca57827 100644
+--- a/app/views/posts/new.html.erb
++++ b/app/views/posts/new.html.erb
+@@ -1,13 +1,13 @@
+<h1>New Post</h1>
+
+-<%= form_for :post do |f| %>
++<%= form_for :post, url: posts_path do |f| %>
+ <p>
+   <%= f.label :title %><br>
+   <%= f.text_field :title %>
+ </p>
+
+ <p>
+   <%= f.label :text %><br>
+   <%= f.text_area :text %>
+ </p>
+PATCH
+    end
+
+    let(:ending) do
+<<-EXPECTED
+<h1>New Post</h1>
+
+ <%= form_for :post, url: posts_path do |f| %>
+ <p>
+   <%= f.label :title %><br>
+   <%= f.text_field :title %>
+ </p>
+
+ <p>
+   <%= f.label :text %><br>
+   <%= f.text_area :text %>
+ </p>
+EXPECTED
+    end
+
+    let(:expected_content) do
+<<-EXPECTED_CONTENT
+Update file `/app/views/posts/new.html.erb`
+
+Change
+ <%= form_for :post do |f| %>
+
+
+To
+ <%= form_for :post, url: posts_path do |f| %>
+
+
+Becomes
+ <h1>New Post</h1>
+
+ <%= form_for :post, url: posts_path do |f| %>
+ <p>
+   <%= f.label :title %><br>
+   <%= f.text_field :title %>
+ </p>
+
+ <p>
+   <%= f.label :text %><br>
+   <%= f.text_area :text %>
+ </p>
+
+
+EXPECTED_CONTENT
+    end
+
+
+    describe '#patch_heading' do
+      it 'has correct type and path' do
+        expect(diff_file.patch_heading).to eq "Update file `#{file_name}`"
+      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.strip))
+      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.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| %>")
+      end
+    end
+
+    describe '#patch_heading' do
+      let(:patch) { double(path: 'foo') }
+      it 'has correct type and path' do
+        expect(diff_file.patch_heading).to eq "Update file `#{file_name}`"
+      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' }
+
+    let(:patch) do
+<<-PATCH
+diff --git a/spec/controllers/posts_controller_spec.rb b/spec/controllers/posts_controller_spec.rb
+index f531cdc..1982a3e 100644
+--- a/spec/controllers/posts_controller_spec.rb
++++ b/spec/controllers/posts_controller_spec.rb
+@@ -2,9 +2,9 @@ require 'spec_helper'
+describe PostsController do
+
+-  describe GET new do
++  describe GET new do
+   it returns http success do
+-      get new
++      get new
+     response.should be_success
+   end
+ end
+PATCH
+    end
+
+    let(:ending) do
+<<-ENDING
+describe PostsController do
+
+   describe GET new do
+   it returns http success do
+       get new
+     response.should be_success
+   end
+ end
+ENDING
+    end
+
+    let(:expected_content) do
+<<-EXPECTED_CONTENT
+Update file `/spec/controllers/posts_controller_spec.rb`
+
+Change
+<pre><code>   describe GET new do</code></pre>
+
+
+To
+<pre><code>   describe GET new do</code></pre>
+
+
+Change
+<pre><code>       get new</code></pre>
+
+
+To
+<pre><code>       get new</code></pre>
+
+
+Becomes
+<pre><code>describe PostsController do
+&nbsp;
+   describe GET new do
+   it returns http success do
+       get new
+     response.should be_success
+   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.strip))
+      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 ["   describe GET new do"]
+
+        expect(diff_file.markdown_outputs[1].description).to eq "To"
+        expect(diff_file.markdown_outputs[1].content).to eq ["   describe GET new do"]
+
+        expect(diff_file.markdown_outputs[2].description).to eq "Change"
+        expect(diff_file.markdown_outputs[2].content).to eq ["       get new"]
+
+        expect(diff_file.markdown_outputs[3].description).to eq "To"
+        expect(diff_file.markdown_outputs[3].content).to eq ["       get new"]
+      end
+    end
+  end
+
+  context 'when the git diff file has just a remove' do
+    let(:type) { 'modified' }
+    let(:file_name) { '/config/routes.rb' }
+
+    let(:patch) do
+<<-PATCH
+diff --git a/config/routes.rb b/config/routes.rb
+index d81896f..9595f17 100644
+--- a/config/routes.rb
++++ b/config/routes.rb
+@@ -1,10 +1,9 @@
+Blog::Application.routes.draw do
+-  get "welcome/index"
+   # The priority is based upon order of creation: first created -> highest priority.
+   # See how all your routes lay out with "rake routes".
+PATCH
+    end
+
+    let(:ending) do
+<<-EXPECTED
+Blog::Application.routes.draw do
+   # The priority is based upon order of creation: first created -> highest priority.
+   # See how all your routes lay out with "rake routes".
+EXPECTED
+    end
+
+    describe '#ending_code' do
+      it 'contains the ending_code' do
+        expect(diff_file.ending_code).to eq CGI.escapeHTML(ending.strip)
+      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 "Remove"
+        expect(diff_file.markdown_outputs.first.content).to eq ["   get \"welcome/index\""]
+      end
+    end
+  end
+
+  context 'when the patch contains one line' do
+    let(:type) { 'new' }
+    let(:file_name) { '/spec/support/capybara.rb' }
+
+    let(:patch) do
+<<-PATCH
+diff --git a/spec/support/capybara.rb b/spec/support/capybara.rb
+new file mode 100644
+index 0000000..12cefac
+--- /dev/null
++++ b/spec/support/capybara.rb
+@@ -0,0 +1 @@
++Capybara.javascript_driver = :webkit
+PATCH
+    end
+
+    let(:expected_content) do
+<<-EXPECTED_CONTENT
+Create file `/spec/support/capybara.rb`
+
+Add
+<pre><code> Capybara.javascript_driver = :webkit</code></pre>
+
+
+EXPECTED_CONTENT
+    end
+
+    describe '#content' do
+      it 'does not contain Becomes content' do
+        expect(diff_file.content).to eq expected_content
+      end
+    end
+  end
+
+  context 'when the patch contains multiple new lines' do
+    let(:type) { 'new' }
+    let(:file_name) { '/spec/support/capybara.rb' }
+
+    let(:patch) do
+<<-PATCH
+diff --git a/spec/support/capybara.rb b/spec/support/capybara.rb
+new file mode 100644
+index 0000000..12cefac
+--- /dev/null
++++ b/spec/support/capybara.rb
+@@ -0,0 +1 @@
++this
++that
++other
+PATCH
+    end
+
+    let(:expected_content) do
+<<-EXPECTED_CONTENT
+Create file `/spec/support/capybara.rb`
+
+Add
+
+ Capybara.javascript_driver = :webkit
+
+
+EXPECTED_CONTENT
+    end
+
+    describe '#markdown_outputs' do
+      it 'has correct markdown outputs' do
+        expect(diff_file.markdown_outputs.size).to eq 1
+      end
+    end
+  end
+
+  context 'when the patch type is deleted' do
+    let(:type) { 'deleted' }
+    let(:file_name) { '/app/helpers/welcome_helper.rb' }
+
+    let(:patch) do
+<<-PATCH
+diff --git a/app/helpers/welcome_helper.rb b/app/helpers/welcome_helper.rb
+deleted file mode 100644
+index eeead45..0000000
+--- a/app/helpers/welcome_helper.rb
++++ /dev/null
+@@ -1,2 +0,0 @@
+-module WelcomeHelper
+-end
+PATCH
+    end
+
+    let(:expected_content) do
+<<-EXPECTED_CONTENT
+Remove file `/app/helpers/welcome_helper.rb`
+
+EXPECTED_CONTENT
+    end
+
+    describe '#content' do
+      it 'has correct markdown outputs' do
+        expect(diff_file.content).to eq expected_content
+      end
+    end
+  end
+end