glyph 0.1.0

data/spec/lib/macro_spec.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe Glyph::Macro do
+
+	before do
+		Glyph.macro :test do |node|
+			"Test: #{node[:value]}"
+		end
+		create_tree = lambda {|text| }
+		create_doc = lambda {|tree| }
+		@text = "test[section[header[Test!|test]]]"
+		@tree = create_tree @text 
+		@doc = create_doc @tree
+		@node = {:macro => :test, :value => "Testing...", :source => "--", :document => @doc}.to_node
+		@macro = Glyph::Macro.new @node
+	end
+
+	it "should raise macro errors" do
+		lambda { @macro.macro_error "Error!" }.should raise_error(MacroError)
+		
+	end
+
+	it "should interpret strings" do
+		@macro.interpret("test[--]").should == "Test: --"
+	end
+
+	it "should store and check bookmarks" do
+		h = { :id => "test2", :title => "Test 2" }
+		@macro.bookmark h
+		@doc.bookmark?(:test2).should == h
+		@macro.bookmark?(:test2).should == h
+	end
+
+	it "should store and check headers" do
+		h = { :level => 2, :id => "test3", :title => "Test 3" }
+		@macro.header h
+		@doc.header?("test3").should == h
+		@macro.header?("test3").should == h
+	end
+
+	it "should store placeholders" do
+		@macro.placeholder { |document| }
+		@doc.placeholders.length.should == 1
+	end
+
+	it "should execute" do
+		@macro.execute.should == "Test: Testing..."
+	end
+
+	it "should detect mutual inclusion" do
+		delete_project
+		create_project
+		Glyph.run! 'load:macros'
+		Glyph::SNIPPETS[:inc] = "Test &[inc]"
+		@macro.interpret("&[inc] test").should == "Test [SNIPPET 'inc' NOT PROCESSED] test" 
+	end
+
+end
+

data/spec/lib/node_spec.rb

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe Node do
+
+	def create_node
+		@ht = {:a => 1, :b => 2}.to_node
+	end
+
+	it "should be a hash" do
+		ht = Node.new
+		ht.is_a?(Hash).should == true
+		ht.children.should == []
+	end
+
+	it "should be generated from a hash" do
+		create_node
+		@ht.respond_to?(:children).should == true
+	end
+
+	it "should support child elements" do
+		create_node
+		lambda { @ht << "wrong" }.should raise_error
+		lambda { @ht << {:c => 3, :d => 4} }.should_not raise_error
+		@ht.children[0][:c].should == 3
+		lambda { @ht << {:e => 5, :f => 6}.to_node }.should_not raise_error
+		@ht.child(1) << {:g => 7, :h => 8}
+		@ht.child(1) << {:i => 9, :j => 10}
+		((@ht>>1>>1)[:j]).should == 10
+	end
+	
+	it "should support iteration" do
+		create_node
+		@ht << {:c => 3, :d => 4}
+		@ht << {:e => 5, :f => 6}
+		@ht.child(0) << {:g => 7, :h => 8}
+		sum = 0
+		@ht.each_child do |c|
+			c.values.each { |v| sum+=v}
+		end
+		sum.should == 18
+		level = 0
+		str = ""
+		@ht.descend do |c, l|
+			level = l
+			c.values.sort.each { |v| str+=v.to_s}
+		end
+		str.should == "12347856"
+		level.should == 1
+	end
+
+	it "should store information about parent nodes" do
+		create_node
+		@ht << {:c => 3, :d => 4}
+		@ht << {:e => 5, :f => 6}
+		@ht.child(1) << {:g => 7, :h => 8}
+		@ht.child(1).child(0) << {:i => 9, :j => 10}
+		(@ht>>1>>0>>0).parent.should == @ht>>1>>(0)
+		(@ht>>1>>0>>0).root.should == @ht
+	end
+
+	it "should find child nodes" do
+		create_node
+		@ht << {:c => 3, :d => 4}
+		@ht << {:e => 5, :f => 6}
+		result = @ht.find_child do |node|
+			node[:d] == 4
+		end
+		result.should == {:c => 3, :d => 4}
+		result2 = @ht.find_child do |node|
+			node[:q] == 7
+		end
+		result2.should == nil
+	end
+
+end

data/spec/macros/filters_spec.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe "Filter Macros" do
+
+	before do
+		delete_project
+		create_project
+		Glyph.run! 'load:macros'
+	end
+
+	after do
+		delete_project
+	end
+	
+	it "should filter textile input" do
+		text = "textile[This is a _TEST_(TM).]"
+		interpret text
+		@p.document.output.should == "<p>This is a <em><span class=\"caps\">TEST</span></em>&#8482;.</p>"
+		run_command ["config", "filters.target", :latex]
+		interpret text
+		@p.document.output.should == "This is a \\emph{TEST}\\texttrademark{}.\n\n"
+		run_command ["config", "filters.target", ":html"]
+		run_command ["config", "filters.redcloth.restrictions", "[:no_span_caps]"]
+		interpret text
+		@p.document.output.should == "<p>This is a <em>TEST</em>&#8482;.</p>"
+	end
+
+	it "should filter markdown input" do
+		text = "markdown[This is a test:
+
+- item 1
+- item 2
+- item 3
+
+...]"
+		interpret text
+		@p.document.output.gsub(/\n|\t/, '').should == 
+			"<p>This is a test:</p><ul><li>item 1</li><li>item 2</li><li>item 3</li></ul><p>...</p>"
+	end
+
+end	

data/spec/macros/macros_spec.rb

@@ -0,0 +1,159 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe "Macro:" do
+
+	before do
+		create_project
+		Glyph.run! 'load:macros'
+		Glyph.run! 'load:snippets'
+	end
+
+	after do
+		delete_project
+	end
+
+	it "anchor" do
+		interpret "this is a #[test|test]."
+		doc = @p.document
+		doc.output.should == "this is a <a id=\"test\">test</a>."
+		doc.bookmarks.has_key?(:test).should == true 
+		lambda { interpret "this is a #[test|test]. #[test|This won't work!]"; @p.document }.should raise_error(MacroError)
+	end
+
+	it "snippet" do
+		define_em_macro
+		interpret "Testing a snippet: &[test]."
+		@p.document.output.should == "Testing a snippet: This is a \nTest snippet."
+		interpret("Testing &[wrong].")
+		@p.document.output.should == "Testing [SNIPPET 'wrong' NOT PROCESSED]." 
+		Glyph::SNIPPETS[:a] = "this is a em[test] &[b]"
+		Glyph::SNIPPETS[:b] = "and another em[test]"
+		text = "TEST: &[a]"
+		interpret text
+		@p.document.output.should == "TEST: this is a <em>test</em> and another <em>test</em>"
+		# Check snippets with links
+		Glyph::SNIPPETS[:c] = "This is a link to something afterwards: =>[#other]"
+		text = "Test. &[c]. #[other|Test]."
+		interpret text
+		@p.document.output.should == %{Test. This is a link to something afterwards: <a href="#other">Test</a>. <a id="other">Test</a>.}
+	end
+
+	it "section, chapter, header" do
+		text = "chapter[header[Chapter X] ... section[header[Section Y|sec-y] ... section[header[Another section] ...]]]"
+		interpret text
+		doc = @p.document
+		doc.output.gsub(/\n|\t/, '').should == %{<div class="chapter">
+					<h2 id="h_1">Chapter X</h2> ... 
+					<div class="section">
+					<h3 id="sec-y">Section Y</h3> ... 
+						<div class="section">
+						<h4 id="h_3">Another section</h4> ...
+						</div>
+					</div>
+				</div>
+		}.gsub(/\n|\t/, '')
+		doc.bookmark?(:"sec-y").should == {:id => :"sec-y", :title => "Section Y"} 
+	end
+
+	it "include" do
+		Glyph.config_override "filters.by_extension", true
+		text = file_load(Glyph::PROJECT/'text/container.textile')
+		interpret text
+		@p.document.output.gsub(/\n|\t|_\d{1,3}/, '').should == %{
+			<div class="section">
+			<h2 id="h_1">Container section</h2>
+			This is a test.
+				<div class="section">
+				<h3 id="h_2">Test Section</h3>	
+				<p>&#8230;</p>
+				</div>
+			</div>
+		}.gsub(/\n|\t|_\d{1,3}/, '')
+	end
+
+
+	it "style" do
+		interpret "style[test.sass]"
+		@p.document.output.gsub(/\n|\t/, '').should == "<style type=\"text/css\">#main {  background-color: #0000ff; }</style>"
+	end	
+
+	it "escape" do
+		define_em_macro
+		text = %{This is a test em[This can .[=contain test[macros em[test]]=]]}		
+		interpret text
+		@p.document.output.should == %{This is a test <em>This can contain test[macros em[test]]</em>}
+	end
+
+	it "ruby" do
+		interpret "2 + 2 = %[2+2]"
+		@p.document.output.should == %{2 + 2 = 4}
+	end
+
+	it "config" do
+		Glyph.config_override "test.setting", "TEST"
+		interpret "test.setting = $[test.setting]"
+		@p.document.output.should == %{test.setting = TEST}
+	end
+
+	it "toc" do
+		file_copy Glyph::PROJECT/'../files/document_with_toc.glyph', Glyph::PROJECT/'document.glyph'
+		interpret file_load(Glyph::PROJECT/'document.glyph')
+		doc = @p.document
+		doc.output.gsub!(/\n|\t/, '')
+		doc.output.slice(/(.+?<\/div>)/, 1).should == %{
+			<div class="contents">
+			<h2 class="toc-header" id="h_toc">Table of Contents</h2>
+			<ol class="toc">
+				<li class=" section"><a href="#h_1">Container section</a></li>
+				<li><ol>
+					<li class=" section"><a href="#h_2">Test Section</a></li>
+				</ol></li>
+				<li class=" section"><a href="#md">Markdown</a></li>
+			</ol>
+			</div>
+		}.gsub(/\n|\t/, '')
+	end
+
+	it "link" do
+		text = %{
+			link[#test_id]
+			link[#test_id2]
+			#[test_id|Test #1]
+			#[test_id2|Test #2]
+		}
+		interpret text
+		@p.document.output.gsub(/\n|\t/, '').should == %{
+			<a href="#test_id">Test #1</a>
+			<a href="#test_id2">Test #2</a>
+			<a id="test_id">Test #1</a>
+			<a id="test_id2">Test #2</a>
+		}.gsub(/\n|\t/, '')
+	end
+
+	it "fmi" do
+		interpret "fmi[this topic|#test] #[test|Test]"
+		@p.document.output.should == %{<span class="fmi">
+			for more information on this topic, 
+			see <a href="#test">Test</a></span> <a id="test">Test</a>}.gsub(/\n|\t/, '')
+	end	
+
+	it "img" do
+		interpret "img[ligature.jpg|90%|90%]"
+		@p.document.output.gsub(/\t|\n/, '').should == %{
+			<img src="images/ligature.jpg" 
+			width="90%" height="90%" alt="-"/>
+		}.gsub(/\n|\t/, '')
+	end
+
+	it "fig" do
+		interpret "fig[ligature.jpg|Ligature]"
+		@p.document.output.gsub(/\t|\n/, '').should == %{
+			<div class="figure">
+			<img src="images/ligature.jpg" alt="-"/>
+			<div class="caption">Ligature</div>
+			</div>
+		}.gsub(/\n|\t/, '')
+	end
+
+end	

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+$: << File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require "stringio"
+
+module Glyph; end
+
+begin
+	unless Glyph.const_defined? :TEST_MODE then
+		Glyph::TEST_MODE = true
+	end
+rescue Exception => e
+end
+
+require "glyph"
+
+Glyph.config_override :quiet, true
+
+def create_project_dir
+	Glyph::PROJECT.mkpath
+end
+
+def create_project
+	enable_all_tasks
+	create_project_dir
+	Glyph.run! 'project:create', Glyph::PROJECT.to_s
+	file_copy Glyph::SPEC_DIR/'files/container.textile', Glyph::PROJECT/'text/container.textile'
+	(Glyph::PROJECT/'text/a/b/c').mkpath
+	file_copy Glyph::SPEC_DIR/'files/included.textile', Glyph::PROJECT/'text/a//b/c/included.textile'
+	file_copy Glyph::SPEC_DIR/'files/markdown.markdown', Glyph::PROJECT/'text/a//b/c/markdown.markdown'
+	file_copy Glyph::SPEC_DIR/'files/document.glyph', Glyph::PROJECT/'document.glyph'
+	file_copy Glyph::SPEC_DIR/'files/test.sass', Glyph::PROJECT/'styles/test.sass'
+	file_copy Glyph::SPEC_DIR/'files/ligature.jpg', Glyph::PROJECT/'images/ligature.jpg'
+end
+
+def enable_all_tasks
+	Rake::Task.tasks.each {|t| t.reenable }
+end
+
+def delete_project_dir
+	FileUtils.rm_rf Glyph::PROJECT.to_s
+end
+
+def delete_project 
+	delete_project_dir
+	Glyph::SNIPPETS.clear
+	Glyph::MACROS.clear
+	Glyph.config_override 'document.source', 'document.glyph'
+	Glyph.instance_eval { remove_const :DOCUMENT rescue nil }
+end
+
+def run_command(cmd)
+	out = StringIO.new
+	old_stdout = $stdout
+	old_stderr = $stderr
+	$stdout = out
+	$stderr = out 
+	Glyph.config_override :quiet, false
+	GLI.run cmd
+	Glyph.config_override :quiet, true
+	$stdout = old_stdout
+	$stderr = old_stderr
+	out.string
+end
+
+def run_command_successfully(cmd)
+	run_command(cmd).match(/error/) == nil
+end
+
+def define_em_macro
+	Glyph.macro :em do
+		%{<em>#{@value}</em>}
+	end
+end
+
+def define_ref_macro
+	Glyph.macro :ref do
+		%{<a href="#{@params[0]}">#{@params[1]}</a>}
+	end
+end
+
+def interpret(text)
+	@p = Glyph::Interpreter.new(text)
+end
+
+def create_tree(text)
+	GlyphLanguageParser.new.parse text 
+end
+
+def create_doc(tree)
+	Glyph::Document.new tree, {} 
+end

data/spec/tasks/generate_spec.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe "generate" do
+
+	before do
+		create_project
+	end
+
+	after do
+		delete_project
+	end
+	
+	it ":document should generate Glyph::DOCUMENT" do
+		lambda { Glyph.run! 'generate:document'}.should_not raise_error
+		Glyph::DOCUMENT.structure.children.length.should > 0
+	end
+
+	it ":html should generate a standalone html document" do
+		lambda { Glyph.run! 'generate:html'}.should_not raise_error
+		(Glyph::PROJECT/'output/html/test_project.html').exist?.should == true
+	end
+
+	it "should copy images" do
+		dir = (Glyph::PROJECT/'images/test').mkpath
+		file_copy Glyph::HOME/'spec/files/ligature.jpg', Glyph::PROJECT/'images/test' 
+		lambda { Glyph.run! 'generate:html' }.should_not raise_error
+		(Glyph::PROJECT/'output/html/images/test/ligature.jpg').exist?.should == true
+	end
+
+end