hologram 1.0.1 → 1.1.0

data/spec/doc_parser_spec.rb

@@ -28,6 +28,34 @@ Markdown stuff
 eos
   end
 
+  let(:multi_category_child_doc) do
+<<-eos
+/*doc
+---
+parent: multi
+name: otherStyle
+title: MultiChild
+---
+Markdown stuff
+multi-child
+*/
+eos
+  end
+
+  let(:multi_category_doc) do
+    <<-eos
+/*doc
+---
+title: MultiParent
+name: multi
+category: [Foo, Bar]
+---
+Markdown stuff
+multi-parent
+*/
+    eos
+  end
+
   let(:source_path) { 'spec/fixtures/source' }
   let(:temp_doc) { File.join(source_path, 'components', 'button', 'skin', 'testSkin.css') }
 
@@ -36,11 +64,23 @@ eos
   context '#parse' do
     let(:result) { parser.parse }
     let(:pages) { result[0] }
-    let(:categories) { result[1] }
+    let(:output_files_by_category) { result[1] }
 
-    it 'builds and returns a hash of pages and a hash of categories' do
+    it 'builds and returns a hash of pages and a hash of output_files_by_category' do
       expect(pages).to be_a Hash
-      expect(categories).to be_a Hash
+      expect(output_files_by_category).to be_a Hash
+    end
+
+    context 'when the component has two categories' do
+      around do |example|
+        File.open(temp_doc, 'a+'){ |io| io << multi_category_doc }
+        example.run
+        FileUtils.rm(temp_doc)
+      end
+
+      it 'adds two categories to output_files_by_category' do
+        expect(output_files_by_category).to eql({'Foo'=>'foo.html', 'Base CSS'=>'base_css.html', 'Bar'=>'bar.html'})
+      end
     end
 
 
@@ -89,5 +129,26 @@ eos
         expect(pages['base_css.html'][:md]).to include '<h2 id="otherStyle">Some other style</h2>'
       end
     end
+
+    context 'when a source doc is the child of a multi category doc block' do
+      around do |example|
+        File.open(temp_doc, 'w'){ |io|
+          io << multi_category_doc
+          io << multi_category_child_doc
+        }
+        example.run
+        FileUtils.rm(temp_doc)
+      end
+
+      it 'should not output duplicate content' do
+        objects = expect(pages['foo.html'][:md]).not_to match(/multi-parent.*multi-child.*multi-child/m)
+        objects = expect(pages['bar.html'][:md]).not_to match(/multi-parent.*multi-child.*multi-child/m)
+      end
+
+      it 'should correctly order content in each page' do
+        objects = expect(pages['foo.html'][:md]).to match(/multi-parent.*multi-child/m)
+        objects = expect(pages['bar.html'][:md]).to match(/multi-parent.*multi-child/m)
+      end
+    end
   end
 end

data/spec/document_block_spec.rb

@@ -8,17 +8,68 @@ describe Hologram::DocumentBlock do
   let(:markdown){ 'blah' }
   let(:doc_block){ subject.class.new(config, markdown) }
 
+  context '.from_comment' do
+    let(:doc) do
+<<-eos
+/*doc
+---
+title: Some other style
+name: otherStyle
+category: Foo
+---
+Markdown stuff
+*/
+eos
+    end
+
+    let(:bad_doc) do
+<<-eos
+/*doc
+---
+: :
+---
+Markdown stuff
+*/
+eos
+    end
+
+    it 'initializes a new document block from a matching comment' do
+      doc_block = Hologram::DocumentBlock.from_comment(doc)
+      expect(doc_block).to be_a Hologram::DocumentBlock
+    end
+
+    it 'raises CommentLoadError when the yaml section is bad' do
+      expect{
+        Hologram::DocumentBlock.from_comment(bad_doc)
+      }.to raise_error Hologram::CommentLoadError
+    end
+
+    it 'returns nothing if its not a valid doc block' do
+      doc_block = Hologram::DocumentBlock.from_comment('foo')
+      expect(doc_block).to be_nil
+    end
+
+    it 'sets up the usual attrs using the YAML and markdown text' do
+      doc_block = Hologram::DocumentBlock.from_comment(doc)
+      expect(doc_block.name).to eql 'otherStyle'
+      expect(doc_block.categories).to eql ['Foo']
+      expect(doc_block.title).to eql 'Some other style'
+      expect(doc_block.markdown).to eql "/*doc\n\nMarkdown stuff\n*/\n"
+    end
+  end
+
   context '#set_members' do
     it 'sets accessors for the the block config' do
-      config.each do |k, v|
-        expect(doc_block.send(k)).to eql v
-      end
+      expect(doc_block.send('name')).to eql 'foo'
+      expect(doc_block.send('categories')).to eql ['bar']
+      expect(doc_block.send('title')).to eql 'baz'
+      expect(doc_block.send('parent')).to eql 'pop'
     end
   end
 
   context '#get_hash' do
     let(:meta) do
-      { :name => 'foo', :category => 'bar', :title => 'baz', :parent => 'pop' }
+      { :name => 'foo', :categories => ['bar'], :title => 'baz', :parent => 'pop' }
     end
 
     it 'returns a hash of meta info' do
@@ -41,6 +92,11 @@ describe Hologram::DocumentBlock do
       it 'returns false' do
         expect(invalid_doc_block.is_valid?).to eql false
       end
+
+      it 'populates errors' do
+        invalid_doc_block.is_valid?
+        expect(invalid_doc_block.errors).to include('Missing name or title config value')
+      end
     end
 
     context 'when markdown is not present' do
@@ -51,6 +107,11 @@ describe Hologram::DocumentBlock do
       it 'returns false' do
         expect(invalid_doc_block.is_valid?).to eql false
       end
+
+      it 'populates errors' do
+        invalid_doc_block.is_valid?
+        expect(invalid_doc_block.errors).to include('Missing required markdown')
+      end
     end
   end
 

data/spec/fixtures/renderer/invalid_renderer.rb

@@ -0,0 +1,2 @@
+class FooBar < Redcarpet::Render::HTML
+end

data/spec/fixtures/renderer/valid_renderer.rb

@@ -0,0 +1,2 @@
+class ValidRenderer < Redcarpet::Render::HTML
+end

data/spec/hologram_markdown_renderer_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe HologramMarkdownRenderer do
+  context 'for backwards compatability' do
+    it 'is retained' do
+      capture(:stdout) {
+        class TestFoo < HologramMarkdownRenderer
+        end
+      }
+
+      expect(TestFoo.ancestors).to include Hologram::MarkdownRenderer
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -5,3 +5,20 @@ require 'tmpdir'
 RSpec.configure do |config|
   config.order = "random"
 end
+
+#Rails kernerl helper
+def capture(stream)
+  stream = stream.to_s
+  captured_stream = Tempfile.new(stream)
+  stream_io = eval("$#{stream}")
+  origin_stream = stream_io.dup
+  stream_io.reopen(captured_stream)
+
+  yield
+
+  stream_io.rewind
+  return captured_stream.read
+ensure
+  captured_stream.unlink
+  stream_io.reopen(origin_stream)
+end

data/spec/utils_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Hologram::Utils do
+  context '.get_markdown_renderer' do
+    subject(:utils) { Hologram::Utils }
+
+    around do |example|
+      Hologram::DisplayMessage.quiet!
+      current_dir = Dir.pwd
+      Dir.chdir('spec/fixtures/renderer')
+
+      example.run
+
+      Dir.chdir(current_dir)
+      Hologram::DisplayMessage.show!
+    end
+
+    context 'by default' do
+      let(:renderer) { utils.get_markdown_renderer }
+
+      it 'returns the standard hologram markdown renderer' do
+        expect(renderer).to eql Hologram::MarkdownRenderer
+      end
+    end
+
+    context 'when passed a valid custom renderer' do
+      let(:renderer) { utils.get_markdown_renderer('valid_renderer.rb') }
+
+      it 'returns the custom renderer' do
+        expect(renderer).to eql ValidRenderer
+      end
+    end
+
+    context 'when passed an invalid custom renderer' do
+      context 'expecting a class named as the upper camel cased version of the file name' do
+        it 'exits' do
+          expect {
+            utils.get_markdown_renderer('invalid_renderer.rb')
+          }.to raise_error SystemExit
+        end
+      end
+
+      context 'expecting a filename.rb' do
+        it 'exits' do
+          expect {
+            utils.get_markdown_renderer('foo')
+          }.to raise_error SystemExit
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hologram
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - JD Cantrell
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-28 00:00:00.000000000 Z
+date: 2014-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -17,42 +17,28 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: pygments.rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.2
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.14.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +67,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
 description: Build doc type things
 email:
 - jcantrell@trulia.com
@@ -96,24 +96,31 @@ files:
 - README.md
 - Rakefile
 - bin/hologram
+- example_markdown_renderer.rb.example
 - hologram.gemspec
 - lib/hologram.rb
+- lib/hologram/cli.rb
 - lib/hologram/display_message.rb
 - lib/hologram/doc_block_collection.rb
 - lib/hologram/doc_builder.rb
 - lib/hologram/doc_parser.rb
 - lib/hologram/document_block.rb
+- lib/hologram/errors.rb
+- lib/hologram/markdown_renderer.rb
 - lib/hologram/template_variables.rb
+- lib/hologram/utils.rb
 - lib/hologram/version.rb
-- lib/hologram_markdown_renderer.rb
 - lib/template/doc_assets/_footer.html
 - lib/template/doc_assets/_header.html
 - lib/template/hologram_config.yml
+- spec/cli_spec.rb
 - spec/display_message_spec.rb
 - spec/doc_block_collection_spec.rb
 - spec/doc_builder_spec.rb
 - spec/doc_parser_spec.rb
 - spec/document_block_spec.rb
+- spec/fixtures/renderer/invalid_renderer.rb
+- spec/fixtures/renderer/valid_renderer.rb
 - spec/fixtures/source/components/background/backgrounds.css
 - spec/fixtures/source/components/button/buttons.css
 - spec/fixtures/source/components/button/skin/buttonSkins.css
@@ -127,7 +134,9 @@ files:
 - spec/fixtures/styleguide/extra/css/screen.css
 - spec/fixtures/styleguide/index.html
 - spec/fixtures/styleguide/static/css/doc.css
+- spec/hologram_markdown_renderer_spec.rb
 - spec/spec_helper.rb
+- spec/utils_spec.rb
 homepage: http://trulia.github.io/hologram
 licenses:
 - MIT
@@ -148,16 +157,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Build document type things.
 test_files:
+- spec/cli_spec.rb
 - spec/display_message_spec.rb
 - spec/doc_block_collection_spec.rb
 - spec/doc_builder_spec.rb
 - spec/doc_parser_spec.rb
 - spec/document_block_spec.rb
+- spec/fixtures/renderer/invalid_renderer.rb
+- spec/fixtures/renderer/valid_renderer.rb
 - spec/fixtures/source/components/background/backgrounds.css
 - spec/fixtures/source/components/button/buttons.css
 - spec/fixtures/source/components/button/skin/buttonSkins.css
@@ -171,4 +183,6 @@ test_files:
 - spec/fixtures/styleguide/extra/css/screen.css
 - spec/fixtures/styleguide/index.html
 - spec/fixtures/styleguide/static/css/doc.css
+- spec/hologram_markdown_renderer_spec.rb
 - spec/spec_helper.rb
+- spec/utils_spec.rb