livingstyleguide 0.6.0.alpha.2 → 1.0.0.alpha.3

data/test/fixtures/markdown/font-example.md

@@ -1 +1,4 @@
-{{font-example:16px Courier}}
+~~~
+@font-example 16px Courier
+~~~
+

data/test/fixtures/markdown/{layout-example.md → full-width-example.md}

@@ -1,4 +1,5 @@
-~~~ layout-example
+~~~
+@full-width
 <button class="button">Test</button>
 ~~~
 

data/test/fixtures/markdown/haml-example-with-highlight.md

@@ -1,4 +1,5 @@
-~~~ haml-example
+~~~
+@haml
 %button***.button*** Test
 ~~~
 

data/test/fixtures/markdown/haml-example.md

@@ -1,4 +1,5 @@
-~~~ haml-example
+~~~
+@haml
 %button.button Test
 ~~~
 

data/test/fixtures/standalone/modules/_buttons.md

@@ -1,6 +1,6 @@
 # Buttons
 
-~~~ example
+~~~
 <button class="button">A button</button>
 ~~~
 

data/test/integration/markdown_test.rb

@@ -1,16 +1,17 @@
 require 'test_helper'
 require 'tilt'
 
-class MarkdownTest < Test::Unit::TestCase
+class MarkdownTest < Minitest::Test
 
-  def render(file)
-    template = Tilt.new(file)
-    template.render
+  def render_markdown(file, options)
+    engine = LivingStyleGuide::Engine.new('', options, {})
+    engine.markdown = File.read(file)
+    engine.html
   end
 
-  def assert_markdown(expected, file)
+  def assert_markdown(expected, file, options = {})
     expected = expected.gsub(/\s+/m, ' ').gsub(/([\$\(\)\[\]])/) { |s| "\\#{s}" }.strip
-    given    = render(File.join(%W(test fixtures markdown #{file})))
+    given    = render_markdown(File.join(%W(test fixtures markdown #{file})), options)
     given    = given.gsub(/\s+/m, ' ').strip
     assert_match /#{expected}/, given
   end
@@ -24,9 +25,9 @@ class MarkdownTest < Test::Unit::TestCase
     HTML
   end
 
-  def test_layout_examples
-    assert_markdown <<-HTML, 'layout-example.md'
-      <div class="livingstyleguide--layout-example">
+  def test_full_width_examples
+    assert_markdown <<-HTML, 'full-width-example.md'
+      <div class="livingstyleguide--example -lsg-has-full-width">
         <button class="button">Test</button>
       </div>
       <pre class="livingstyleguide--code-block"><code class="livingstyleguide--code">.+button.+Test.+button.+</code></pre>
@@ -88,7 +89,7 @@ class MarkdownTest < Test::Unit::TestCase
 
   def test_code_with_highlight_block
     assert_markdown <<-HTML, 'code-with-highlight-block.md'
-      <pre class="livingstyleguide--code-block"><code class="livingstyleguide--code"><strong class="livingstyleguide--code-highlight-block">.+Block example.+</strong></code></pre>
+      <pre class="livingstyleguide--code-block"><code class="livingstyleguide--code">.+<strong class="livingstyleguide--code-highlight-block">.+Block example.+</strong>.+</code></pre>
     HTML
   end
 
@@ -123,10 +124,12 @@ class MarkdownTest < Test::Unit::TestCase
     HTML
   end
 
-  def test_javascript_example
-    assert_markdown <<-HTML, 'javascript-example.md'
-      <script>alert("Hello world!"); </script>
-      <pre class="livingstyleguide--code-block"><code class="livingstyleguide--code">alert(<q>"<b>Hello</b> world!"</q>);</code></pre>
+  def test_resetting_language
+    assert_markdown <<-HTML, 'code-block-and-example.md', default_language: 'code'
+      <pre class="livingstyleguide--code-block"><code class="livingstyleguide--code">Normal code block</code></pre><div class="livingstyleguide--example">
+        Example
+      </div>
+      <pre class="livingstyleguide--code-block"><code class="livingstyleguide--code">Example</code></pre>
     HTML
   end
 

data/test/integration/sprockets_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+require 'tilt'
+
+describe "Sprockets integration" do
+
+  describe "sprockets should know when to invalidate cache" do
+    template = Tilt.new('test/fixtures/standalone/styleguide.html.lsg')
+    context = Minitest::Mock.new
+    %w(style.scss modules/_buttons.scss modules/_buttons.md styleguide.html.lsg).each do |file|
+      context.expect :depend_on, nil, ["test/fixtures/standalone/#{file}"]
+    end
+
+    template.render context
+
+    context.verify
+  end
+
+end
+

data/test/integration/standalone_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 require 'tilt'
 
-class MarkdownTest < Test::Unit::TestCase
+class MarkdownTest < Minitest::Test
 
   def test_standalone_project
     html = render('test/fixtures/standalone/styleguide.html.lsg')

data/test/integration/variables_test.rb

@@ -4,7 +4,7 @@ require 'compass'
 require 'compass/logger'
 require 'sass/plugin'
 
-class VariablesImporterTest < Test::Unit::TestCase
+class VariablesImporterTest < Minitest::Test
 
   def setup
     Compass.configure_sass_plugin!

data/test/test_helper.rb

@@ -1,6 +1,7 @@
+require 'minitest/autorun'
 require 'compass'
 require 'livingstyleguide'
-require 'test/unit'
+require 'heredoc_unindent'
 
 Compass.configuration.add_import_path File.join(%w(test fixtures stylesheets))
 
@@ -18,3 +19,10 @@ def parse_file(filename)
   Sass::Engine.new(File.read(filename), options)
 end
 
+def normalize(html)
+  html.gsub! /\s+/, ' '
+  html.gsub! '><', '> <'
+  html.strip!
+  html
+end
+

data/test/unit/code_block_test.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+describe LivingStyleGuide::CodeBlock do
+
+  before do
+    @code_block = Class.new(LivingStyleGuide::CodeBlock)
+  end
+
+  describe "when no language is given" do
+    it "should output the code" do
+      @code_block.new("My Code").render.must_equal <<-HTML.unindent.strip
+        <pre class="livingstyleguide--code-block"><code class="livingstyleguide--code">My Code</code></pre>
+      HTML
+    end
+
+    it "should html escape the code" do
+      @code_block.new("1 < 2 > 0 &\"").render.must_equal <<-HTML.unindent.strip
+        <pre class="livingstyleguide--code-block"><code class="livingstyleguide--code">1 &lt; 2 &gt; 0 &amp;"</code></pre>
+      HTML
+    end
+  end
+
+  describe "when a language is given" do
+    it "should output the code with syntax highlighting" do
+      @code_block.new("<my-code>", :html).render.must_equal <<-HTML.unindent.strip
+        <pre class="livingstyleguide--code-block"><code class="livingstyleguide--code"><b>&lt;<em>my-code</em></b><b>&gt;</b></code></pre>
+      HTML
+    end
+  end
+
+  describe "when filters are set" do
+    it "should filter the code" do
+      @code_block.filter_code do |code|
+        code.gsub(/ugly/, 'beautiful')
+      end
+
+      @code_block.new("my ugly code").render.must_equal <<-HTML.unindent.strip
+        <pre class="livingstyleguide--code-block"><code class="livingstyleguide--code">my beautiful code</code></pre>
+      HTML
+    end
+
+    it "should use own syntax highlighter" do
+      @code_block.syntax_highlight do |code|
+        code.gsub(/language/, language)
+      end
+
+      @code_block.new("my ugly language code", "html").render.must_equal <<-HTML.unindent.strip
+        <pre class="livingstyleguide--code-block"><code class="livingstyleguide--code">my ugly html code</code></pre>
+      HTML
+    end
+  end
+end
+

data/test/unit/example_test.rb

@@ -0,0 +1,142 @@
+require 'example_test_helper'
+
+class ExampleTest < ExampleTestCase
+
+  def test_default
+    assert_render_equals <<-INPUT, <<-OUTPUT
+      <button>Hello World</button>
+    INPUT
+      <div class="livingstyleguide--example"> <button>Hello World</button> </div>
+      <pre class="livingstyleguide--code-block">
+        <code class="livingstyleguide--code">
+          <b>&lt;<em>button</em></b><b>&gt;</b>Hello World<b>&lt;/<em>button</em>&gt</b>
+        </code>
+      </pre>
+    OUTPUT
+  end
+
+  def test_filters_with_underscore_and_dash_case
+    @class.add_filter :test_filter do
+      filter_before do |html|
+        "TEST"
+      end
+    end
+    %w(test_filter test-filter).each do |filter|
+      assert_render_equals <<-INPUT, <<-OUTPUT
+        @#{filter}
+        <button>Hello World</button>
+      INPUT
+        <div class="livingstyleguide--example"> TEST </div>
+        <pre class="livingstyleguide--code-block">
+          <code class="livingstyleguide--code">
+            <b>&lt;<em>button</em></b><b>&gt;</b>Hello World<b>&lt;/<em>button</em>&gt</b>
+          </code>
+        </pre>
+      OUTPUT
+    end
+  end
+
+  def test_filters
+    @class.add_filter do
+      filter_before do |html|
+        "TEST"
+      end
+    end
+    assert_render_equals <<-INPUT, <<-OUTPUT
+      <button>Hello World</button>
+    INPUT
+      <div class="livingstyleguide--example"> TEST </div>
+      <pre class="livingstyleguide--code-block">
+        <code class="livingstyleguide--code">
+          <b>&lt;<em>button</em></b><b>&gt;</b>Hello World<b>&lt;/<em>button</em>&gt</b>
+        </code>
+      </pre>
+    OUTPUT
+  end
+
+  def test_filters_with_argument
+    @class.add_filter :test_filter do |argument|
+      filter_before do |html|
+        argument
+      end
+    end
+    assert_render_equals <<-INPUT, <<-OUTPUT
+      @test_filter Another Test
+      <button>Hello World</button>
+    INPUT
+      <div class="livingstyleguide--example"> Another Test </div>
+      <pre class="livingstyleguide--code-block">
+        <code class="livingstyleguide--code">
+          <b>&lt;<em>button</em></b><b>&gt;</b>Hello World<b>&lt;/<em>button</em>&gt</b>
+        </code>
+      </pre>
+    OUTPUT
+  end
+
+  def test_default_filters
+    @class.add_filter :test_filter do
+      filter_before do |html|
+        "TEST"
+      end
+    end
+    assert_render_equals <<-INPUT, <<-OUTPUT, { default_filters: ['@test-filter'] }
+      <button>Hello World</button>
+    INPUT
+      <div class="livingstyleguide--example"> TEST </div>
+      <pre class="livingstyleguide--code-block">
+        <code class="livingstyleguide--code">
+          <b>&lt;<em>button</em></b><b>&gt;</b>Hello World<b>&lt;/<em>button</em>&gt</b>
+        </code>
+      </pre>
+    OUTPUT
+  end
+
+  def test_outer_html
+    @class.html do |c|
+      "<span>#{c}</span>"
+    end
+    assert_render_equals <<-INPUT, <<-OUTPUT
+      <button>Hello World</button>
+    INPUT
+      <span> <button>Hello World</button> </span>
+      <pre class="livingstyleguide--code-block">
+        <code class="livingstyleguide--code">
+          <b>&lt;<em>button</em></b><b>&gt;</b>Hello World<b>&lt;/<em>button</em>&gt</b>
+        </code>
+      </pre>
+    OUTPUT
+  end
+
+  def test_hide_code_block
+    @class.add_filter :suppress_code_block do
+      suppress_code_block
+    end
+    assert_render_equals <<-INPUT, <<-OUTPUT
+      @suppress-code-block
+      <button>Hello World</button>
+    INPUT
+      <div class="livingstyleguide--example"> <button>Hello World</button> </div>
+    OUTPUT
+  end
+
+  def test_pre_processor
+    @class.add_filter :pre_processor_one do
+      pre_processor { |source| 'fail' }
+    end
+    @class.add_filter :pre_processor_two do
+      pre_processor { |source| source.gsub(/World/, 'Moon') }
+    end
+    assert_render_equals <<-INPUT, <<-OUTPUT
+      @pre-processor-one
+      @pre-processor-two
+      Hello World
+    INPUT
+      <div class="livingstyleguide--example"> Hello Moon </div>
+      <pre class="livingstyleguide--code-block">
+        <code class="livingstyleguide--code">Hello World</code>
+      </pre>
+    OUTPUT
+  end
+
+end
+

data/test/unit/filter_hooks_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+
+describe LivingStyleGuide::FilterHooks do
+
+  before do
+    @class = Class.new
+    @class.class_eval do
+      include Hooks
+      include Hooks::InstanceHooks
+      include LivingStyleGuide::FilterHooks
+      define_hook :filter
+    end
+  end
+
+  describe "running filters after each other" do
+    it "should filter one filter" do
+      @class.filter { |text| text * 2 }
+      @class.run_filter_hook(:filter, "hello world").must_equal "hello worldhello world"
+    end
+
+    it "should filter several filter in a row" do
+      @class.filter { |text| text * 2 }
+      @class.filter { |text| text.gsub(/worldhello/, 'beautiful') }
+      @class.run_filter_hook(:filter, "hello world").must_equal "hello beautiful world"
+    end
+
+    it "should work on instances" do
+      @class.filter { |text| text * 2 }
+      @class.new.run_filter_hook(:filter, "hello world").must_equal "hello worldhello world"
+    end
+  end
+
+  describe "run only the latest added filter" do
+    it "should should run only one filter" do
+      @class.filter { |text| text.gsub(/animal/, 'fish') }
+      @class.filter { |text| text.gsub(/animal/, 'bird') }
+      @class.run_last_filter_hook(:filter, "the animal").must_equal "the bird"
+    end
+
+    it "should return the original string if no hooks are defined" do
+      @class.run_last_filter_hook(:filter, "the animal").must_equal "the animal"
+    end
+  end
+
+end
+

data/test/unit/filters/add_wrapper_class_test.rb

@@ -0,0 +1,15 @@
+require 'example_test_helper'
+
+class AddWrapperClassTest < ExampleTestCase
+
+  def test_add_wrapper_class
+    assert_render_match <<-INPUT, <<-OUTPUT
+      @add-wrapper-class my-class
+      <section>Something wide</section>
+    INPUT
+      <div class="livingstyleguide--example my-class">
+    OUTPUT
+  end
+
+end
+

data/test/unit/filters/coffee_script_test.rb

@@ -0,0 +1,19 @@
+require 'example_test_helper'
+
+class CoffeeScriptTest < ExampleTestCase
+
+  def test_coffee_script
+    assert_render_equals <<-INPUT, <<-OUTPUT
+      @coffee-script
+      alert "Hello world!"
+    INPUT
+      <div class="livingstyleguide--example -lsg-for-javascript"> <script>(function() { alert("Hello world!"); }).call(this); </script> </div>
+      <pre class="livingstyleguide--code-block">
+        <code class="livingstyleguide--code">alert "Hello world!"</code>
+      </pre>
+    OUTPUT
+  end
+
+end
+
+