hologram 1.2.0 → 1.3.0

data/spec/code_example_renderer/example_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Hologram::CodeExampleRenderer::Example do
+  let(:code) { 'goto 12' }
+  let(:example) { described_class.new(code) }
+
+  describe '#rendered_example' do
+    subject { example.rendered_example }
+    it { is_expected.to eq 'goto 12' }
+  end
+
+  describe '#code_example' do
+    let(:formatter) { double(:formatter) }
+    let(:lexer) { double(:lexer, lex: 'lexed_code') }
+
+    before do
+      allow(Rouge::Lexer).to receive(:find_fancy).with('guess', code) { lexer }
+      allow(Rouge::Formatters::HTML).to receive(:new) { formatter }
+      allow(formatter).to receive(:format).with('lexed_code') { 'formatted_lexed_code' }
+    end
+
+    subject { example.code_example }
+
+    it { is_expected.to eq 'formatted_lexed_code' }
+  end
+end

data/spec/code_example_renderer/factory_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+Hologram::CodeExampleRenderer.load_renderers_and_templates
+
+describe Hologram::CodeExampleRenderer::Factory do
+  describe '.define' do
+    let(:example_type) { 'foobar' }
+
+    before do
+      allow(Hologram::CodeExampleRenderer::Template).to receive(:new).with('custom_example_template') { double(template: 'the full custom example template') }
+      allow(Hologram::CodeExampleRenderer::Template).to receive(:new).with('custom_table_template') { double(template: 'the full custom table template') }
+      allow(Hologram::CodeExampleRenderer::Template).to receive(:new).with(nil).and_call_original
+    end
+
+    context "when a renderer is registered with all of the options" do
+      before do
+        custom_lexer = double(:lexer, lex: 'lexed code from supplied lexer')
+
+        Hologram::CodeExampleRenderer::Factory.define(example_type) do
+          example_template 'custom_example_template'
+          table_template 'custom_table_template'
+          lexer { custom_lexer }
+          rendered_example { |code| "special rendering for #{code}" }
+        end
+      end
+
+      after { Hologram::CodeExampleRenderer.unregister(example_type) }
+
+      describe "the registered example class" do
+        let(:example_class) { Hologram::CodeExampleRenderer.example_class_for(example_type) }
+        let(:example) { example_class.new('some code') }
+
+        it "renders the example using the block supplied to the factory" do
+          expect(example.rendered_example).to eq "special rendering for some code"
+        end
+
+        it "formats the code uses the supplied lexer" do
+          formatter = double(:formatter)
+          allow(Rouge::Formatters::HTML).to receive(:new) { formatter }
+
+          expect(formatter).to receive(:format).with('lexed code from supplied lexer') { 'formatted code' }
+          example.code_example
+        end
+      end
+
+      describe "the registered templates" do
+        let(:example_template) { Hologram::CodeExampleRenderer.example_template_for(example_type) }
+        let(:table_template) { Hologram::CodeExampleRenderer.table_template_for(example_type) }
+
+        it "uses the supplied example template" do
+          expect(example_template).to eq 'the full custom example template'
+        end
+
+        it "uses the supplied table template" do
+          expect(table_template).to eq 'the full custom table template'
+        end
+      end
+    end
+
+    context "when a renderer is registered with only some of the options" do
+      before do
+
+        Hologram::CodeExampleRenderer::Factory.define(example_type) do
+          example_template 'custom_example_template'
+        end
+      end
+
+      after { Hologram::CodeExampleRenderer.unregister(example_type) }
+
+      describe "the registered example class" do
+        let(:example_class) { Hologram::CodeExampleRenderer.example_class_for(example_type) }
+        let(:example) { example_class.new('some code') }
+
+        it "renders the example as is" do
+          expect(example.rendered_example).to eq "some code"
+        end
+
+        it "formats the code uses the default lexer" do
+          formatter = double(:formatter)
+          allow(Rouge::Lexer).to receive(:find_fancy).with('guess', 'some code') { double(lex: 'default lexed code') }
+          allow(Rouge::Formatters::HTML).to receive(:new) { formatter }
+
+          expect(formatter).to receive(:format).with('default lexed code') { 'formatted code' }
+          example.code_example
+        end
+      end
+
+      describe "the registered templates" do
+        let(:example_template) { Hologram::CodeExampleRenderer.example_template_for(example_type) }
+        let(:table_template) { Hologram::CodeExampleRenderer.table_template_for(example_type) }
+
+        it "uses the supplied example template" do
+          expect(example_template).to eq 'the full custom example template'
+        end
+
+        it "does not have a table template" do
+          expect(table_template).to be_nil
+        end
+      end
+    end
+  end
+end

data/spec/code_example_renderer/template_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Hologram::CodeExampleRenderer::Template do
+  describe '#template' do
+    subject { described_class.new(template_name).template }
+
+    context 'when template_name is nil' do
+      let(:template_name) { nil }
+      it { is_expected.to be_nil }
+    end
+
+    context 'when template_name is not nil' do
+      let(:template_name) { 'bar' }
+
+      let(:custom_template_filename) { 'custom/bar.html.erb' }
+      let(:default_template_filename) { 'cwd/../../template/code_example_templates/bar.html.erb' }
+
+      before do
+        allow(File).to receive(:dirname) { 'cwd/' }
+        allow(File).to receive(:read).with(custom_template_filename) { 'custom template' }
+        allow(File).to receive(:read).with(default_template_filename) { 'default template' }
+      end
+
+      context 'when path_to_custom_example_templates is defined' do
+        before do
+          described_class.path_to_custom_example_templates = 'custom/'
+          allow(File).to receive(:file?).with(custom_template_filename) { has_custom_template? }
+        end
+
+        after do
+          described_class.path_to_custom_example_templates = nil
+        end
+
+        context 'when a custom template exists' do
+          let(:has_custom_template?) { true }
+          it { is_expected.to eq 'custom template' }
+        end
+
+        context 'when a custom template does not exist' do
+          let(:has_custom_template?) { false }
+          it { is_expected.to eq 'default template' }
+        end
+      end
+
+      context 'when a path_to_custom_example_templates is not defined' do
+        it { is_expected.to eq 'default template' }
+      end
+    end
+  end
+end

data/spec/display_message_spec.rb

@@ -60,10 +60,28 @@ describe Hologram::DisplayMessage do
   end
 
   context '.warning' do
+    around do |example|
+      display.quiet!
+      example.run
+      display.show!
+    end
+
     it 'displays a warning message in yellow' do
       expect(display).to receive(:puts).with("\e[33mWarning: foo\e[0m")
       display.warning('foo')
     end
+
+    context 'when .exit_on_warnings! has been called' do
+      around do |example|
+        display.exit_on_warnings!
+        example.run
+        display.continue_on_warnings!
+      end
+
+      it 'exits' do
+        expect{ display.warning('foo') }.to raise_error SystemExit
+      end
+    end
   end
 
   context '.colorize' do

data/spec/doc_block_collection_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Hologram::DocBlockCollection do
   let(:comment) do
-   comment = <<comment
+    <<-comment
 /*doc
 ---
 title: Buttons
@@ -49,6 +49,31 @@ comment
         expect(collection.doc_blocks.size).to eql 0
       end
     end
+
+    context 'when the block has the same name as another block in the collection' do
+      let(:duplicate_comment) do
+        <<-comment
+/*doc
+---
+title: Imposter Buttons
+name: button
+category: Base CSS
+---
+
+Same old stuff
+*/
+comment
+      end
+
+      before do
+        collection.add_doc_block(comment, 'fake_file.sass')
+      end
+
+      it 'displays a warning' do
+        expect(Hologram::DisplayMessage).to receive(:warning)
+        collection.add_doc_block(duplicate_comment, 'fake_file.sass')
+      end
+    end
   end
 
   context '#create_nested_structure' do

data/spec/doc_builder_spec.rb

@@ -131,6 +131,32 @@ describe Hologram::DocBuilder do
     end
   end
 
+  context '#initialize' do
+    subject { Hologram::DocBuilder.new(config) }
+
+    context 'when the "exit_on_warnings" option is passed in as true' do
+      let(:config) do
+        { 'exit_on_warnings' => true }
+      end
+
+      it 'calls DisplayMessage.exit_on_warnings!' do
+        expect(Hologram::DisplayMessage).to receive(:exit_on_warnings!)
+        subject
+      end
+    end
+
+    context 'when the "exit_on_warnings" option is not passed in' do
+      let(:config) do
+        { }
+      end
+
+      it 'does not call DisplayMessage.exit_on_warnings!' do
+        expect(Hologram::DisplayMessage).not_to receive(:exit_on_warnings!)
+        subject
+      end
+    end
+  end
+
   context '#is_valid?' do
 
     let(:config) do
@@ -204,8 +230,6 @@ describe Hologram::DocBuilder do
   end
 
   context '#build' do
-    let(:style_files) { Dir[File.expand_path('../fixtures/styleguide/**/*.*', __FILE__)] }
-    let(:processed_files) { Dir[File.join(builder.destination, '.', '**/*.*')] }
     let(:config_path) { File.join(Dir.pwd, 'spec/fixtures/source/config.yml') }
     let(:config_copy_path) { File.join(Dir.pwd, 'spec/fixtures/source/config.yml.copy') }
     let(:builder) { Hologram::DocBuilder.from_yaml(config_copy_path) }
@@ -226,9 +250,8 @@ describe Hologram::DocBuilder do
 
     it 'builds a styleguide' do
       builder.build
-      style_files.each_with_index do |file, index|
-        expect(FileUtils.cmp(file, processed_files[index])).to be_truthy
-      end
+      expect(File.read(File.expand_path('../fixtures/styleguide/base_css.html', __FILE__))).to eq File.read(File.join(builder.destination, '.', 'base_css.html'))
+      expect(File.read(File.expand_path('../fixtures/styleguide/index.html', __FILE__))).to eq File.read(File.join(builder.destination, '.', 'index.html'))
     end
   end
 end

data/spec/doc_parser_spec.rb

@@ -15,6 +15,19 @@ Markdown stuff
 eos
   end
 
+  let(:docs_child) do
+    <<-eos
+/*doc
+---
+parent: otherStyle
+title: Other Style Child
+name: otherStyleChild
+---
+Markdown stuff
+*/
+    eos
+  end
+
   let(:child_doc) do
 <<-eos
 /*doc
@@ -28,6 +41,19 @@ Markdown stuff
 eos
   end
 
+  let(:grandchild_doc) do
+    <<-eos
+/*doc
+---
+parent: otherStyle
+name: grandbaby
+title: Grandbaby
+---
+Markdown stuff
+*/
+    eos
+  end
+
   let(:multi_category_child_doc) do
 <<-eos
 /*doc
@@ -77,10 +103,10 @@ multi-parent
       expect(output_files_by_category).to be_a Hash
     end
 
-    context "when the source has multiple paths" do
+    context 'when the source has multiple paths' do
       subject(:parser) { Hologram::DocParser.new(['spec/fixtures/source/colors', 'spec/fixtures/source/components'], nil, plugins) }
 
-      it "parses all sources" do
+      it 'parses all sources' do
         expect(pages['base_css.html'][:md]).to include 'Base colors'
         expect(pages['base_css.html'][:md]).to include 'Background Colors'
       end
@@ -123,6 +149,30 @@ multi-parent
       it 'takes the category in a collection and treats them as the page names' do
         expect(pages.keys).to include 'foo.html'
       end
+
+      context 'when nav_level is set to section' do
+        before do
+          File.open(temp_doc, 'a+'){ |io| io << docs_child }
+          parser.nav_level = 'section'
+        end
+
+        it 'generates navigation to children from their parent' do
+          parser.parse
+          expect(pages['foo.html'][:md]).to include '<li><a href="#otherStyleChild">Other Style Child</a></li>'
+        end
+      end
+
+      context 'when nav_level is not set' do
+        before do
+          File.open(temp_doc, 'a+'){ |io| io << docs_child }
+          parser.nav_level = nil
+        end
+
+        it 'should not generate sub navigation' do
+          parser.parse
+          expect(pages['foo.html'][:md]).not_to include '<li><a href="#otherStyleChild">Other Style Child</a></li>'
+        end
+      end
     end
 
     context 'when a source doc is a child' do
@@ -132,16 +182,26 @@ multi-parent
         FileUtils.rm(temp_doc)
       end
 
-      before do
-        parser.parse
-      end
-
       it 'appends the child doc to the category page' do
+        parser.parse
         expect(pages['base_css.html'][:md]).to include 'Some other style'
       end
 
       it 'assigns the child doc a deeper header' do
-        expect(pages['base_css.html'][:md]).to include '<h2 id="otherStyle">Some other style</h2>'
+        parser.parse
+        expect(pages['base_css.html'][:md]).to include '<h2 id="otherStyle" class="styleguide">Some other style</h2>'
+      end
+
+      context 'when nav_level is set to all' do
+        before do
+          File.open(temp_doc, 'a+'){ |io| io << grandchild_doc }
+          parser.nav_level = 'all'
+        end
+
+        it 'generates navigation to grandchildren from their parent' do
+          parser.parse
+          expect(pages['base_css.html'][:md]).to include '<li><a href="#grandbaby">Grandbaby</a></li>'
+        end
       end
     end
 

data/spec/document_block_spec.rb

@@ -116,8 +116,39 @@ eos
   end
 
   context '#markdown_with_heading' do
-    it 'returns markdown with a specified header' do
-      expect(doc_block.markdown_with_heading(2)).to eql "\n\n<h2 id=\"foo\">baz</h2>blah"
+    context 'when include_sub_nav is false' do
+      it 'returns markdown with a specified header' do
+        expect(doc_block.markdown_with_heading(2)).to eql "\n\n<h2 id=\"foo\" class=\"styleguide\">baz</h2>blah"
+      end
+    end
+
+    context 'when include_sub_nav is true' do
+      context 'when the component has no children' do
+        it 'returns markdown with no nav' do
+          expect(doc_block.markdown_with_heading(2, include_sub_nav: true)).to eql "\n\n<h2 id=\"foo\" class=\"styleguide\">baz</h2>blah"
+        end
+      end
+
+      context 'when the component has children' do
+        before do
+          doc_block.children['child-one'] = double( name: 'child-one', title: 'Child 1' )
+          doc_block.children['child-two'] = double( name: 'child-two', title: 'Child 2' )
+        end
+
+        it 'returns markdown with no nav' do
+          expected_output = <<-eos
+
+
+<h2 id="foo" class="styleguide">baz</h2>
+<ul class="section-nav">
+  <li><a href="#child-one">Child 1</a></li>
+  <li><a href="#child-two">Child 2</a></li>
+</ul>
+blah
+eos
+          expect(doc_block.markdown_with_heading(2, include_sub_nav: true)).to eql expected_output.rstrip
+        end
+      end
     end
   end
 end