renderer_test.rb in bookingit-0.1.0

- old
+ new

@@ -12,23 +12,52 @@
 
   def teardown
     remove_entry @tempdir
   end
 
+  def renderer(options={})
+    options = OpenStruct.new(:rendering_config => { basedir: @tempdir }.merge(options))
+    Bookingit::Renderer.new(options)
+  end
+
   test_that "block_code can read a file URL and guess ruby" do
     Given a_file_with_extension(".rb") 
     When render_file_url_code_block
     Then {
-      assert_equal %{<pre><code class="language-ruby">#{@code}</code></pre>},@html
+      assert_equal %{<article class='code-listing'><pre><code class="language-ruby">#{@code}</code></pre><footer><h1>#{@relative_path}</h1></footer></article>},@html
     }
   end
 
+  test_that "block_code can read a file URL and guess ruby from Gemfile" do
+    Given a_file_named("Gemfile") 
+    When render_file_url_code_block
+    Then {
+      assert_equal %{<article class='code-listing'><pre><code class="language-ruby">#{@code}</code></pre><footer><h1>Gemfile</h1></footer></article>},@html
+    }
+  end
+
+  test_that "block_code can read a file URL and be OK if it cannot guess" do
+    Given a_file_with_extension(".blah") 
+    When render_file_url_code_block
+    Then {
+      assert_equal %{<article class='code-listing'><pre><code class="">#{@code}</code></pre><footer><h1>#{@relative_path}</h1></footer></article>},@html
+    }
+  end
+
+  test_that "we can tell the renderer about other languages and extensions" do
+    Given a_file_with_extension(".blah") 
+    When render_file_url_code_block(languages: { '.blah' => 'blahscript' })
+    Then {
+      assert_equal %{<article class='code-listing'><pre><code class="language-blahscript">#{@code}</code></pre><footer><h1>#{@relative_path}</h1></footer></article>},@html
+    }
+  end
+
   test_that "block_code can read a file URL and guess scala" do
     Given a_file_with_extension(".scala") 
     When render_file_url_code_block
     Then {
-      assert_equal %{<pre><code class="language-scala">#{@code}</code></pre>},@html
+      assert_equal %{<article class='code-listing'><pre><code class="language-scala">#{@code}</code></pre><footer><h1>#{@relative_path}</h1></footer></article>},@html
     }
   end
 
   test_that "it HTML-escapes" do
     Given a_file_with_extension_and_contents('.html',%{<!DOCTYPE html>
@@ -39,26 +68,26 @@
   </body>
 </html>
 })
     When render_file_url_code_block
     Then {
-      assert_equal %{<pre><code class="language-html">&lt;!DOCTYPE html&gt;
+      assert_equal %{<article class='code-listing'><pre><code class="language-html">&lt;!DOCTYPE html&gt;
 &lt;html&gt;
   &lt;body&gt;
     &lt;h1&gt;HELLO!&lt;/h1&gt;
     &lt;h2&gt;&amp;amp; Goodbye&lt;/h2&gt;
   &lt;/body&gt;
 &lt;/html&gt;
-</code></pre>},@html
+</code></pre><footer><h1>#{@relative_path}</h1></footer></article>},@html
     }
   end
 
   test_that "a git url without a SHA1 or tag raises" do
     Given a_git_repo_with_file("foo.rb")
     When {
       @code = -> {
-        Bookingit::Renderer.new.block_code(@file_git_url,nil)
+        renderer.block_code(@file_git_url,nil)
       }
     }
     Then {
       assert_raises RuntimeError,&@code
     }
@@ -66,49 +95,102 @@
 
   test_that "a git url with a SHA1 gets that version" do
     Given a_git_repo_with_two_verions_of_file("foo.rb")
     When {
       @parsed_versions = Hash[@versions.map { |sha1,_|
-        [sha1, Bookingit::Renderer.new.block_code(@file_git_url + "##{sha1}",nil)]
+        [sha1, renderer.block_code(@file_git_url + "##{sha1}",nil)]
       }]
     }
     Then {
       @parsed_versions.each do |sha1,code|
-        assert_equal %{<pre><code class="language-ruby">#{@versions[sha1]}\n</code></pre>},code,"For SHA: #{sha1}"
+        assert_equal %{<article class='code-listing'><pre><code class="language-ruby">#{@versions[sha1]}\n</code></pre><footer><h1>foo.rb</h1></footer></article>},code,"For SHA: #{sha1}"
       end
     }
   end
 
   test_that "a git url with a tag gets that version" do
     Given a_git_repo_with_two_tagged_verions_of_file("foo.rb")
     When {
       @parsed_versions = Hash[@versions.map { |tagname,_|
-        [tagname, Bookingit::Renderer.new.block_code(@file_git_url + "##{tagname}",nil)]
+        [tagname, renderer.block_code(@file_git_url + "##{tagname}",nil)]
       }]
     }
     Then {
       @parsed_versions.each do |tagname,code|
-        assert_equal %{<pre><code class="language-ruby">#{@versions[tagname]}\n</code></pre>},code,"For Tag: #{tagname}"
+        assert_equal %{<article class='code-listing'><pre><code class="language-ruby">#{@versions[tagname]}\n</code></pre><footer><h1>foo.rb</h1></footer></article>},code,"For Tag: #{tagname}"
       end
     }
   end
 
   test_that "a git url with a diff spec shows the diff instead" do
     Given a_git_repo_with_two_tagged_verions_of_file("foo.rb")
     When {
       url = @file_git_url + "#" + @versions.keys[0] + ".." + @versions.keys[1]
-      @html = Bookingit::Renderer.new.block_code(url,nil)
+      @html = renderer.block_code(url,nil)
     }
     Then {
-      assert_match /<pre><code class=\"language-diff\">diff --git/,@html
+      assert_match /<article class=\'code-listing\'><pre><code class=\"language-diff\">diff --git/,@html
       assert_match /a\/foo.rb b\/foo.rb/,@html
       assert_match /index [a-z0-9]+..[a-z0-9]+ 100644/,@html
       assert_match /\-\-\- a\/foo.rb/,@html
       assert_match /\+\+\+ b\/foo.rb/,@html
     }
   end
 
+  test_that "a git url with a compact diff spec shows the diff, too" do
+    Given a_git_repo_with_two_tagged_verions_of_file("foo.rb")
+    When {
+      url = @file_git_url + "#.." + @versions.keys[1]
+      @html = renderer.block_code(url,nil)
+    }
+    Then {
+      assert_match /<article class=\'code-listing\'><pre><code class=\"language-diff\">diff --git/,@html
+      assert_match /a\/foo.rb b\/foo.rb/,@html
+      assert_match /index [a-z0-9]+..[a-z0-9]+ 100644/,@html
+      assert_match /\-\-\- a\/foo.rb/,@html
+      assert_match /\+\+\+ b\/foo.rb/,@html
+    }
+  end
+
+  test_that "a git url with a shell command runs that command on that version of the repo" do
+    Given a_git_repo_with_two_tagged_verions_of_file("foo.rb")
+    When {
+      @version = @versions.keys[0]
+      git_url = @file_git_url.gsub(/\/foo.rb/,'/')
+      @html = renderer.block_code("#{git_url}##{@version}!cat foo.rb",nil)
+    }
+    Then {
+      assert_equal %{<article class='code-listing'><pre><code class="language-shell">&gt; cat foo.rb\n#{@versions[@version]}\n</code></pre></article>},@html
+    }
+  end
+
+  test_that "a git url with a shell command that exits nonzero raises an error" do
+    Given a_git_repo_with_two_tagged_verions_of_file("foo.rb")
+    When {
+      @version = @versions.keys[0]
+      git_url = @file_git_url.gsub(/\/foo.rb/,'/')
+      @executable = -> {
+        renderer.block_code("#{git_url}##{@version}!cat blah.rb",nil)
+      }
+    }
+    Then {
+      assert_raise Bookingit::UnexpectedShellCommandExit,&@executable
+    }
+  end
+
+  test_that "a git url with a shell command that exits nonzero doesn't raise an error if we indicate as such" do
+    Given a_git_repo_with_two_tagged_verions_of_file("foo.rb")
+    When {
+      @version = @versions.keys[0]
+      git_url = @file_git_url.gsub(/\/foo.rb/,'/')
+      @html = renderer.block_code("#{git_url}##{@version}!cat blah.rb!nonzero",nil)
+    }
+    Then {
+      refute_nil @html
+    }
+  end
+
   test_that "an sh url will run the given command and put the contents into the output" do
     Given {
       chdir @tempdir do
         mkdir "play"
         chdir "play" do
@@ -117,39 +199,95 @@
           system "touch quux"
         end
       end
     }
     When {
-      @html = Bookingit::Renderer.new.block_code("sh://#{@tempdir}/play#ls -1",nil)
+      @html = renderer.block_code("sh://play#ls -1",nil)
     }
     Then {
-      assert_equal %{<pre><code class="language-shell">&gt; ls -1
+      assert_equal %{<article class='code-listing'><pre><code class="language-shell">&gt; ls -1
 bar
 blah
 quux
-</code></pre>},@html
+</code></pre></article>},@html
     }
   end
 
+  test_that "an sh url that exits nonzero will raise" do
+    Given {
+      chdir @tempdir do
+        mkdir "play"
+        chdir "play" do
+          system "touch blah"
+          system "touch bar"
+          system "touch quux"
+        end
+      end
+    }
+    When {
+      @executable = -> { renderer.block_code("sh://play#cat bleorgh",nil) }
+    }
+    Then {
+      assert_raise Bookingit::UnexpectedShellCommandExit, &@executable
+    }
+  end
+
+  test_that "an sh url that exits nonzero but we expect it to will not raise" do
+    Given {
+      chdir @tempdir do
+        mkdir "play"
+        chdir "play" do
+          system "touch blah"
+          system "touch bar"
+          system "touch quux"
+        end
+      end
+    }
+    When {
+      @html = renderer.block_code("sh://play#cat bleorgh!nonzero",nil)
+    }
+    Then {
+      refute_nil @html
+    }
+  end
+
   test_that "we pass through inline code blocks" do
     When {
-      @html = Bookingit::Renderer.new.block_code("class Foo", 'coffeescript')
+      @html = renderer.block_code("class Foo", 'coffeescript')
     }
     Then {
-      assert_equal %{<pre><code class="language-coffeescript">class Foo</code></pre>},@html
+      assert_equal %{<article class='code-listing'><pre><code class="language-coffeescript">class Foo</code></pre></article>},@html
     }
   end
 
   test_that "we omit the language class if it's not provided in inline code" do
     When {
-      @html = Bookingit::Renderer.new.block_code("class Foo", nil)
+      @html = renderer.block_code("class Foo", nil)
     }
     Then {
-      assert_equal %{<pre><code>class Foo</code></pre>},@html
+      assert_equal %{<article class='code-listing'><pre><code class="">class Foo</code></pre></article>},@html
     }
   end
 
+  test_that "we can cache results between calls" do
+    Given a_git_repo_with_two_tagged_verions_of_file("foo.rb")
+    And {
+      @cachedir = File.join(@tempdir,'cache')
+      @renderer = renderer(cache: @cachedir)
+      @version  = @versions.keys[0]
+      @url      = "#{@file_git_url.gsub(/\/foo.rb/,'/')}##{@version}!cat foo.rb"
+      @html     = @renderer.block_code(@url,nil)
+    }
+    When {
+      @html2 = @renderer.block_code(@url,nil)
+    }
+    Then {
+      assert_equal %{<article class='code-listing'><pre><code class="language-shell">&gt; cat foo.rb\n#{@versions[@version]}\n</code></pre></article>},@html
+      assert_equal @html,@html2
+    }
+  end
+
 private
 
   def create_and_commit_file(file,contents)
     File.open(file,'w') do |file|
       file.puts contents
@@ -177,11 +315,11 @@
 end}
         }
         create_and_commit_file(file,code)
         # make sure test doesn't get the HEAD version
       end
-      @file_git_url = "git://#{File.join(@tempdir,'git_repo.git')}/#{file}"
+      @file_git_url = "git://git_repo.git/#{file}"
     }
   end
 
   def a_git_repo_with_two_tagged_verions_of_file(file)
     -> {
@@ -205,11 +343,11 @@
 end}
         }
         create_and_commit_file(file,code)
         # make sure test doesn't get the HEAD version
       end
-      @file_git_url = "git://#{File.join(@tempdir,'git_repo.git')}/#{file}"
+      @file_git_url = "git://git_repo.git/#{file}"
     }
   end
 
   def git_repo_in_tempdir(&block)
     chdir @tempdir do
@@ -230,23 +368,35 @@
   def initialize
   end
 end}
         create_and_commit_file(file,@code)
       end
-      @file_git_url = "git://#{File.join(@tempdir,'git_repo.git')}/#{file}"
+      @file_git_url = "git://git_repo.git/#{file}"
     }
   end
 
-  def render_file_url_code_block
+  def render_file_url_code_block(options={})
     -> {
-      @html = Bookingit::Renderer.new.block_code("file://#{@path}",nil)
+      @html = renderer(options).block_code("file://#{@path.gsub(/#{Regexp.escape(@tempdir)}\/?/,'')}",nil)
     }
   end
 
+  def a_file_named(filename)
+    -> {
+      @code = %{#{any_string}
+}
+      @path = File.join(@tempdir,filename)
+      File.open(@path,'w') do |file|
+        file.puts @code
+      end
+    }
+  end
+
   def a_file_with_extension_and_contents(extension,contents)
     -> {
       file = Tempfile.new(['foo',extension])
       @path = file.path
+      @relative_path = @path.gsub(Regexp.escape(@tempdir),'')
       @code = contents
       File.open(@path,'w') do |file|
         file.puts @code
       end
     }