tartancloth 0.0.1 → 0.0.2

data/spec/lib/matchers.rb

@@ -0,0 +1,110 @@
+require 'diff/lcs'
+require 'diff/lcs/callbacks'
+require 'pathname'
+
+# Borrowed most of this from the BlueCloth gem at
+# https://github.com/ged/bluecloth/blob/master/spec/lib/matchers.rb
+
+
+module TartanCloth::Matchers
+
+  class TransformMatcher
+
+    def initialize( html )
+      @html = html
+    end
+
+    ### Strip tab indentation from the expected HTML output.
+    def without_indentation
+      if indent = @html[/\A\s+/]
+        indent.gsub!( /\A\n/m, '' )
+        @html.gsub!( /^#{indent}/m, '' )
+      end
+
+      return self
+    end
+
+    ### Returns true if the HTML generated by the given +tartancloth+ object matches the
+    ### expected HTML, comparing only the salient document structures.
+    def matches?( tartancloth )
+      @tartancloth = tartancloth
+      @output_html = tartancloth.body_html.gsub( /\n\n\n/, "\n\n" )
+      return @output_html.strip == @html.strip
+    end
+
+    def failure_message_for_should
+      patch = self.make_patch( @html, @output_html )
+      return ("Expected the generated html:\n\n  %p\n\nto be the same as:\n\n" +
+        "  %p\n\nDiffs:\n\n%s") % [ @output_html, @html, patch ]
+    end
+
+    def failure_message_for_should_not
+      return "Expected the generated html:\n\n  %p\n\nnot to be the same as:\n\n  %p\n\n" %
+        [ @output_html, @html ]
+    end
+
+    ### Compute a patch between the given +expected+ output and the +actual+ output
+    ### and return it as a string.
+    def make_patch( expected, actual )
+      diffs = Diff::LCS.sdiff( expected.split("\n"), actual.split("\n"),
+        Diff::LCS::ContextDiffCallbacks )
+
+      maxcol = diffs.flatten.
+        collect {|d| [d.old_element.to_s.length, d.new_element.to_s.length ] }.
+        flatten.max || 0
+      maxcol += 4
+
+      patch = "              %#{maxcol}s | %s\n" % [ "Expected", "Actual" ]
+      patch << diffs.collect do |changeset|
+        changeset.collect do |change|
+          "%s [%03d, %03d]: %#{maxcol}s | %-#{maxcol}s" % [
+            change.action,
+            change.old_position,
+            change.new_position,
+            change.old_element.inspect,
+            change.new_element.inspect,
+          ]
+        end.join("\n")
+      end.join("\n---\n")
+    end
+
+  end # class TransformMatcher
+
+
+  ### Write markup to temp file
+  def write_tmp_file( string )
+    tmpfile = Pathname('tmp')
+    tmpfile.mkpath
+    tmpfile += 'markdown.md'
+    File.open( tmpfile.to_s, 'w') do |f|
+      f << string
+    end
+    tmpfile.to_s
+  end
+
+  ### Create a new TartanCloth object out of the given +string+ and +options+ and
+  ### return it.
+  def the_markdown( string )
+    return TartanCloth.new( write_tmp_file(string) )
+  end
+
+
+  ### Strip indentation from the given +string+, create a new TartanCloth object
+  ### out of the result and any +options+, and return it.
+  def the_indented_markdown( string )
+    if indent = string[/\A\s+/]
+      indent.gsub!( /\A\n/m, '' )
+      $stderr.puts "Source indent is: %p" % [ indent ] if $DEBUG
+      string.gsub!( /^#{indent}/m, '' )
+    end
+
+    return TartanCloth.new( write_tmp_file(string) )
+  end
+
+
+  ### Generate a matcher that expects to equal the given +html+.
+  def be_transformed_into( html )
+    return TartanCloth::Matchers::TransformMatcher.new( html )
+  end
+
+end # module

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require_relative '../lib/tartancloth'
+require_relative './lib/matchers'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  # Include custom matchers
+  config.include(TartanCloth::Matchers)
+end
+

data/spec/toc_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe "TOC" do
+
+  context "headers" do
+
+    it "identical headers have unique anchors" do
+      the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+      # TOC
+
+      # Header 1
+
+      # Header 1
+
+      # Header 1
+      ---
+      <a name="TOC"></a>
+      <h2>Table of Contents</h2>
+
+      <ul class="toc">
+      <li><span class="h1toc"><a href="#Header.1">Header 1</a></span></li>
+      <li><span class="h1toc"><a href="#Header.1.0">Header 1</a></span></li>
+      <li><span class="h1toc"><a href="#Header.1.1">Header 1</a></span></li>
+      </ul>
+
+      <a name="Header.1"></a>
+      <h1>Header 1</h1>
+
+      <a name="Header.1.0"></a>
+      <h1>Header 1</h1>
+
+      <a name="Header.1.1"></a>
+      <h1>Header 1</h1>
+      ---
+    end
+  end # context "headers"
+end # describe "TOC"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tartancloth
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-21 00:00:00.000000000 Z
+date: 2013-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,11 +96,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- CHANGELOG.txt
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/tartancloth.rb
+- spec/lib/matchers.rb
+- spec/spec_helper.rb
+- spec/toc_spec.rb
 - tartancloth.gemspec
 homepage: ''
 licenses:
@@ -127,5 +132,8 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Generate nice HTML with a table of contents
-test_files: []
+test_files:
+- spec/lib/matchers.rb
+- spec/spec_helper.rb
+- spec/toc_spec.rb
 has_rdoc: