hologram 0.6.0 → 1.0.0

data/lib/hologram/document_block.rb

@@ -0,0 +1,36 @@
+module Hologram
+  class DocumentBlock
+    attr_accessor :name, :parent, :children, :title, :category, :markdown, :config, :heading
+
+    def initialize(config = nil, markdown = nil)
+      @children = {}
+      set_members(config, markdown) if config and markdown
+    end
+
+    def set_members(config, markdown)
+      @name     = config['name']
+      @category = config['category']
+      @title    = config['title']
+      @parent   = config['parent']
+      @markdown = markdown
+    end
+
+    def get_hash
+      {:name => @name,
+       :parent => @parent,
+       :category => @category,
+       :title => @title
+      }
+    end
+
+    def is_valid?
+      !!(@name && @markdown)
+    end
+
+    # sets the header tag based on how deep your nesting is
+    def markdown_with_heading(heading = 1)
+      @markdown = "\n\n<h#{heading.to_s} id=\"#{@name}\">#{@title}</h#{heading.to_s}>" + @markdown
+    end
+  end
+end
+

data/lib/hologram/template_variables.rb

@@ -0,0 +1,21 @@
+module Hologram
+
+  #Helper class for binding things for ERB
+  class TemplateVariables
+    attr_accessor :title, :file_name, :blocks, :categories
+
+    def initialize(args)
+      set_args(args)
+    end
+
+    def set_args(args)
+      args.each do |k,v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+    def get_binding
+      binding()
+    end
+  end
+end

data/lib/hologram/version.rb

@@ -25,5 +25,5 @@
 # ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 module Hologram
-  VERSION = "0.6.0"
+  VERSION = "1.0.0"
 end

data/lib/template/doc_assets/_header.html

@@ -8,11 +8,16 @@
 
     <nav>
       <ul>
-      <% for b in blocks %>
-        <li><a href="#<%= b[:name] %>"><%= b[:title] %></a></li>
+      <% @categories.each do |category, file_name| %>
+        <li><a href="<%= file_name %>"><%= category %></a></li>
       <% end %>
       </ul>
     </nav>
 
     <h1>a brand new style guide, it's super effective</h1>
     <section class="content">
+      <ul>
+      <% @blocks.each do |b| %>
+        <li><a href="#<%= b[:name] %>"><%= b[:title] %></a></li>
+      <% end %>
+      </ul>

data/lib/template/hologram_config.yml

@@ -1,3 +1,6 @@
+# Hologram will run from same directory where this config file resides
+# All paths should be relative to there
+
 # The directory containing the source files to parse recursively
 source: ./sass
 

data/spec/display_message_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+require 'tempfile'
+
+describe Hologram::DisplayMessage do
+  subject(:display) { Hologram::DisplayMessage }
+
+  #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
+
+  context '.quiet!' do
+    around do |example|
+      display.quiet!
+      example.run
+      display.show!
+    end
+
+    it 'sets quiet to true' do
+      display.quiet!
+      expect(display.quiet?).to be_true
+    end
+  end
+
+  context '.puts' do
+    let(:message) { capture(:stdout) { display.puts('foo') } }
+
+    it 'puts to console' do
+      expect(message).to eql "foo\n"
+    end
+
+    context 'when quiet' do
+      around do |example|
+        display.quiet!
+        example.run
+        display.show!
+      end
+
+      it 'does nothing' do
+        expect(message).to be_empty
+      end
+    end
+  end
+
+  context '.error' do
+    around do |example|
+      display.quiet!
+      example.run
+      display.show!
+    end
+
+    it 'displays an error in red' do
+      expect(display).to receive(:puts).with("\e[32m(╯°□°）╯\e[0m\e[31m︵ ┻━┻ \e[0m\e[31m Build not complete.\e[0m")
+      expect(display).to receive(:puts).with(" foo")
+
+      begin
+        display.error('foo')
+      rescue SystemExit
+      end
+    end
+
+    it 'exits' do
+      expect{ display.error('foo') }.to raise_error SystemExit
+    end
+  end
+
+  context '.warning' do
+    it 'displays a warning message in yellow' do
+      expect(display).to receive(:puts).with("\e[33mWarning: foo\e[0m")
+      display.warning('foo')
+    end
+  end
+
+  context '.colorize' do
+    it 'returns a colorized string' do
+      expect(display.colorize(31, 'foo')).to eql "\e[31mfoo\e[0m"
+    end
+  end
+
+  context '.red' do
+    it 'returns a red colorized string' do
+      expect(display.red('foo')).to eql display.colorize(31, 'foo')
+    end
+  end
+
+  context '.green' do
+    it 'returns a green colorized string' do
+      expect(display.green('foo')).to eql display.colorize(32, 'foo')
+    end
+  end
+
+  context '.yellow' do
+    it 'returns a yellow colorized string' do
+      expect(display.yellow('foo')).to eql display.colorize(33, 'foo')
+    end
+  end
+
+  context '.pink' do
+    it 'returns a pink colorized string' do
+      expect(display.pink('foo')).to eql display.colorize(35, 'foo')
+    end
+  end
+end

data/spec/doc_block_collection_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe Hologram::DocBlockCollection do
+  let(:comment) do
+   comment = <<comment
+/*doc
+---
+title: Buttons
+name: button
+category: Base CSS
+---
+
+Button styles can be applied to any element. Typically you'll want
+to use either a `<button>` or an `<a>` element:
+
+```html_example
+  <button class="btn btnDefault">Click</button>
+  <a class="btn btnDefault" href="trulia.com">Trulia!</a>
+```
+
+If your button is actually a link to another page, please use the
+`<a>` element, while if your button performs an action, such as
+submitting a form or triggering some javascript event, then use a
+`<button>` element.
+
+*/
+comment
+  end
+
+  let(:collection){ Hologram::DocBlockCollection.new }
+
+  context '#add_doc_block' do
+    context 'when the comment is valid' do
+      before do
+        collection.add_doc_block(comment)
+      end
+
+      it 'adds a doc block to the collection' do
+        expect(collection.doc_blocks.size).to eql 1
+      end
+    end
+
+    context 'when no yaml is provided' do
+      before do
+        collection.add_doc_block('')
+      end
+
+      it 'does not add a new block' do
+        expect(collection.doc_blocks.size).to eql 0
+      end
+    end
+  end
+
+  context '#create_nested_structure' do
+    context 'when the collection has blocks with parents' do
+      before do
+        collection.add_doc_block(comment)
+        collection.add_doc_block(%q{
+          /*doc
+          ---
+          title: foo
+          name: bah
+          parent: button
+          ---
+          some other button style
+          */})
+
+        collection.create_nested_structure
+      end
+
+      it 'removes the child block from the collection level' do
+        expect(collection.doc_blocks.size).to eql 1
+      end
+
+      it 'nests the doc block as a child of the parent block' do
+        expect(collection.doc_blocks['button'].children.size).to eql 1
+      end
+    end
+  end
+end

data/spec/doc_builder_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe Hologram::DocBuilder do
+  subject(:builder) { Hologram::DocBuilder.new }
+
+  context '#init' do
+    around do |example|
+      Hologram::DisplayMessage.quiet!
+      example.run
+      Hologram::DisplayMessage.show!
+    end
+
+    context 'when passed an invalid config' do
+      before do
+        File.open('bad_config.yml', 'w'){ |io| io << '%' }
+      end
+
+      after do
+        FileUtils.rm('bad_config.yml')
+      end
+
+      it 'exits the process' do
+        expect { builder.init(['bad_config.yml']) }.to raise_error SystemExit
+      end
+    end
+
+    context 'when passed a config file' do
+      let(:style_files) { Dir[File.expand_path('../fixtures/styleguide/**/*.*', __FILE__)] }
+      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') }
+
+      around do |example|
+        Dir.mktmpdir do |tmpdir|
+          FileUtils.cp(config_path, config_copy_path)
+          File.open(config_copy_path, 'a'){ |io| io << "destination: #{tmpdir}" }
+          current_dir = Dir.pwd
+          Dir.chdir(tmpdir)
+
+          example.run
+
+          Dir.chdir(current_dir)
+          FileUtils.rm(config_copy_path)
+        end
+      end
+
+      before do
+        builder.init([config_copy_path])
+      end
+
+      it 'builds a styleguide' do
+        processed_files = Dir[File.join('.', '**/*.*')]
+        processed_files.each_with_index do |file, index|
+          expect(FileUtils.cmp(file, style_files[index])).to be_true
+        end
+      end
+    end
+
+    context 'when passed "init" as arg' do
+      around do |example|
+        Dir.mktmpdir do |dir|
+          Dir.chdir(dir) do
+            example.run
+          end
+        end
+      end
+
+      before do
+        builder.init(['init'])
+      end
+
+      it 'creates a config file' do
+        expect(File.exists?('hologram_config.yml')).to be_true
+      end
+
+      it 'creates default assets' do
+        Dir.chdir('doc_assets') do
+          ['_header.html', '_footer.html'].each do |asset|
+            expect(File.exists?(asset)).to be_true
+          end
+        end
+      end
+
+      context 'when a hologram_config.yml already exists' do
+        it 'does nothing' do
+          open('hologram_config.yml', 'w') {|io|io << 'foo'}
+          builder.init(['init'])
+          expect(IO.read('hologram_config.yml')).to eql('foo')
+        end
+      end
+    end
+  end
+end

data/spec/doc_parser_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe Hologram::DocParser do
+
+  let(:doc) do
+<<-eos
+/*doc
+---
+title: Some other style
+name: otherStyle
+category: Foo
+---
+Markdown stuff
+*/
+eos
+  end
+
+  let(:child_doc) do
+<<-eos
+/*doc
+---
+parent: button
+name: otherStyle
+title: Some other style
+---
+Markdown stuff
+*/
+eos
+  end
+
+  let(:source_path) { 'spec/fixtures/source' }
+  let(:temp_doc) { File.join(source_path, 'components', 'button', 'skin', 'testSkin.css') }
+
+  subject(:parser) { Hologram::DocParser.new('spec/fixtures/source') }
+
+  context '#parse' do
+    let(:result) { parser.parse }
+
+    it 'builds and returns a hash of pages' do
+      expect(result).to be_a Hash
+    end
+
+    context 'when an index page is specified' do
+      subject(:parser) { Hologram::DocParser.new('spec/fixtures/source', 'foo') }
+
+      around do |example|
+        File.open(temp_doc, 'a+'){ |io| io << doc }
+        example.run
+        FileUtils.rm(temp_doc)
+      end
+
+      it 'uses that page as the index' do
+        expect(result['index.html'][:md]).to include 'Markdown stuff'
+      end
+    end
+
+    context 'when the source is a parent doc' do
+      around do |example|
+        File.open(temp_doc, 'a+'){ |io| io << doc }
+        example.run
+        FileUtils.rm(temp_doc)
+      end
+
+      it 'takes the category in a collection and treats them as the page names' do
+        expect(result.keys).to include 'foo.html'
+      end
+    end
+
+    context 'when a source doc is a child' do
+      around do |example|
+        File.open(temp_doc, 'a+'){ |io| io << child_doc }
+        example.run
+        FileUtils.rm(temp_doc)
+      end
+
+      before do
+        parser.parse
+      end
+
+      it 'appends the child doc to the category page' do
+        expect(result['base_css.html'][:md]).to include 'Some other style'
+      end
+
+      it 'assigns the child doc a deeper header' do
+        expect(result['base_css.html'][:md]).to include '<h2 id="otherStyle">Some other style</h2>'
+      end
+    end
+  end
+end