glyph 0.1.0 → 0.2.0

data/spec/lib/interpreter_spec.rb

@@ -6,8 +6,7 @@ describe Glyph::Interpreter do
 	before do
 		delete_project
 		create_project
-		Glyph.run! 'load:macros'
-		Glyph.run! 'load:snippets'
+		Glyph.run! 'load:all'
 	end
 
 
@@ -87,4 +86,11 @@ describe Glyph::Interpreter do
 			{:"@" => 1}, {:markdown => 2},{:section => 3}, {:header => 4}]
 	end
 
+
+	it "should provide diagnostic information on errors" do
+		failure = "Incorrect macro syntax\n -> -- [Line 1, Column 13]"
+		# This is probably the only type of error recognized which can occur at parser level
+		lambda { interpret "section[em[]" }.should raise_error(Glyph::SyntaxError, failure)
+	end
+
 end

data/spec/lib/macro_spec.rb

@@ -4,8 +4,8 @@ require File.join(File.dirname(__FILE__), "..", "spec_helper")
 describe Glyph::Macro do
 
 	before do
-		Glyph.macro :test do |node|
-			"Test: #{node[:value]}"
+		Glyph.macro :test do
+			"Test: #{@value}"
 		end
 		create_tree = lambda {|text| }
 		create_doc = lambda {|tree| }
@@ -17,14 +17,30 @@ describe Glyph::Macro do
 	end
 
 	it "should raise macro errors" do
-		lambda { @macro.macro_error "Error!" }.should raise_error(MacroError)
-		
+		lambda { @macro.macro_error "Error!" }.should raise_error(Glyph::MacroError)
 	end
 
 	it "should interpret strings" do
 		@macro.interpret("test[--]").should == "Test: --"
 	end
 
+	it "should not interpret escaped macros" do
+		Glyph.macro :int_1 do
+			"->#{interpret(@value)}<-"
+		end
+		Glyph.macro :int_2 do
+			"=>#{interpret(@value)}<="
+		end
+		text1 = "int_1[int_2[Test]]"
+		text2 = "int_1[=int_2[Test]=]"
+		text3 = "int_1[=int_2\\[Test\\]=]"
+		text4 = "int_2[int_1[=int_1[wrong_macro[Test]]=]]"
+		@macro.interpret(text1).should == "->=>Test<=<-"
+		@macro.interpret(text2).should == "->int_2\\[Test\\]<-"
+		@macro.interpret(text3).should == "->int_2\\[Test\\]<-"
+		@macro.interpret(text4).should == "=>->int_1\\[wrong_macro\\[Test\\]\\]<-<="
+	end
+
 	it "should store and check bookmarks" do
 		h = { :id => "test2", :title => "Test 2" }
 		@macro.bookmark h
@@ -53,8 +69,40 @@ describe Glyph::Macro do
 		create_project
 		Glyph.run! 'load:macros'
 		Glyph::SNIPPETS[:inc] = "Test &[inc]"
-		@macro.interpret("&[inc] test").should == "Test [SNIPPET 'inc' NOT PROCESSED] test" 
+		lambda {interpret("&[inc] test").document}.should raise_error(Glyph::MutualInclusionError)
 	end
 
-end
+	it "should encode and decode text" do
+		Glyph.run! "load:all"
+		Glyph.macro :sec_1 do
+			res = decode "section[header[Test1]\n#{@value}]"
+			interpret res
+		end
+		Glyph.macro :sec_2 do
+			encode "section[section[header[Test2]\n#@value]]"
+		end
+		text1 = %{sec_1[sec_2[Test]]}
+		interpret text1
+		res1 = @p.document.output.gsub(/\t/, '')
+		text2 = %{section[header[Test1]
+			section[section[header[Test2]
+			Test]]]}
+		interpret text2
+		res2 = @p.document.output.gsub(/\t/, '')
+		result = "<div class=\"section\">
+				<h2 id=\"h_1\">Test1</h2>
+				<div class=\"section\">
+					<div class=\"section\">
+						<h4 id=\"h_2\">Test2</h4>
+						Test
+
+					</div>
+
+				</div>
 
+			</div>".gsub(/\t/, '')
+		res1.should == result
+		res2.should == result
+	end
+
+end

data/spec/lib/macro_validators_spec.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe Glyph::Macro::Validators do
+
+	before do
+		Glyph.run! 'load:all'
+		Glyph.macro :validated_test do
+			validate("Invalid Macro"){	@value == "valid" }
+			"Validated Test: #{@value}"
+		end
+	end
+
+	it "should provide custom validation" do
+		lambda { interpret("section[validated_test[invalid]]").document.output }.should raise_error Glyph::MacroError
+		lambda { interpret("chapter[validated_test[valid]]").document.output }.should_not raise_error
+	end
+
+	it "should validate the number of parameters" do
+		# exact
+		lambda { interpret("table[]").document.output }.should raise_error Glyph::MacroError
+		# none
+		lambda { interpret("toc[test]").document.output }.should raise_error Glyph::MacroError
+		# min
+		lambda { interpret("img[]").document.output }.should raise_error Glyph::MacroError
+		# max
+		lambda { interpret("not[a|b|c]").document.output }.should raise_error Glyph::MacroError
+		# correct
+		lambda { interpret("chapter[fmi[something|#something]]").document.output }.should_not raise_error Glyph::MacroError
+	end
+
+end
+

data/spec/lib/node_spec.rb

@@ -26,7 +26,15 @@ describe Node do
 		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
+		((@ht&1&1)[:j]).should == 10
+		l = (@ht&1).length
+		orphan = @ht&1&0
+		orphan.parent.should == @ht&1
+		(@ht&1).children.include?(orphan).should == true
+		(@ht&1) >> orphan
+		(@ht&1).children.length.should == l-1 
+		orphan.parent.should == nil
+		(@ht&1).children.include?(orphan).should == false
 	end
 	
 	it "should support iteration" do
@@ -55,8 +63,8 @@ describe Node do
 		@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
+		(@ht&1&0&0).parent.should == @ht&1&0
+		(@ht&1&0&0).root.should == @ht
 	end
 
 	it "should find child nodes" do

data/spec/macros/filters_spec.rb

@@ -17,11 +17,11 @@ describe "Filter Macros" 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]
+		Glyph['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]"]
+		Glyph['filters.target'] = :html
+		Glyph['filters.redcloth.restrictions'] = [:no_span_caps]
 		interpret text
 		@p.document.output.should == "<p>This is a <em>TEST</em>&#8482;.</p>"
 	end
@@ -33,10 +33,10 @@ describe "Filter Macros" do
 - item 2
 - item 3
 
-...]"
+etc.]"
 		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>"
+			"<p>This is a test:</p><ul><li>item 1</li><li>item 2</li><li>item 3</li></ul><p>etc.</p>"
 	end
 
 end	

data/spec/macros/macros_spec.rb

@@ -5,11 +5,11 @@ describe "Macro:" do
 
 	before do
 		create_project
-		Glyph.run! 'load:macros'
-		Glyph.run! 'load:snippets'
+		Glyph.run! 'load:all'
 	end
 
 	after do
+		Glyph.lite_mode = false
 		delete_project
 	end
 
@@ -18,7 +18,7 @@ describe "Macro:" do
 		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)
+		lambda { interpret "this is a #[test|test]. #[test|This won't work!]"; @p.document }.should raise_error(Glyph::MacroError)
 	end
 
 	it "snippet" do
@@ -39,6 +39,50 @@ describe "Macro:" do
 		@p.document.output.should == %{Test. This is a link to something afterwards: <a href="#other">Test</a>. <a id="other">Test</a>.}
 	end
 
+	it "snippet:" do
+		interpret("&[t1] - &:[t1|Test #1] - &[t1]")
+		@p.document.output.should == "[SNIPPET 't1' NOT PROCESSED] -  - Test #1"
+		Glyph::SNIPPETS[:t1].should == "Test #1"
+		Glyph::SNIPPETS.delete :t1
+	end
+
+	it "condition" do
+		define_em_macro
+		interpret("?[$[document.invalid]|em[test]]")
+		@p.document.output.should == ""
+		interpret("?[$[document.output]|em[test]]")
+		@p.document.output.should == "<em>test</em>"
+		interpret("?[not[eq[$[document.output]|]]|em[test]]")
+		@p.document.output.should == "<em>test</em>"
+		interpret %{?[
+				or[
+					eq[$[document.target]|htmls]|
+					not[eq[$[document.author]|x]]
+				]|em[test]]}
+		@p.document.output.should == "<em>test</em>"
+		# "false" should be regarded as false
+		interpret(%{?[%["test".blank?]|---]})
+		@p.document.output.should == ""
+		interpret("?[not[match[$[document.source]|/^docu/]]|em[test]]")
+		@p.document.output.should == ""
+		# Invalid regexp
+		lambda { interpret("?[match[$[document.source]|document]em[test]]").document.output }.should raise_error
+		interpret "?[%[lite?]|test]"
+		@p.document.output.should == ""
+		interpret "?[%[!lite?]|test]"
+		@p.document.output.should == "test"
+		interpret "?[%[lite?]|%[\"test\"]]"
+		@p.document.output.should == ""
+		# Condition not satisfied...
+		interpret "?[%[lite?]|*[= %[ Glyph\\['test_config'\\] = true ] =]]"
+		@p.document.output.should == ""
+		Glyph['test_config'].should_not == true
+		# Condition satisfied...
+		interpret "?[%[!lite?]|*[= --[%[ Glyph\\['test_config'\\] = true ]] =]]"
+		@p.document.output.should == ""
+		Glyph['test_config'].should == true
+	end
+
 	it "section, chapter, header" do
 		text = "chapter[header[Chapter X] ... section[header[Section Y|sec-y] ... section[header[Another section] ...]]]"
 		interpret text
@@ -57,7 +101,7 @@ describe "Macro:" do
 	end
 
 	it "include" do
-		Glyph.config_override "filters.by_extension", true
+		Glyph["filters.by_extension"] = true
 		text = file_load(Glyph::PROJECT/'text/container.textile')
 		interpret text
 		@p.document.output.gsub(/\n|\t|_\d{1,3}/, '').should == %{
@@ -72,12 +116,52 @@ describe "Macro:" do
 		}.gsub(/\n|\t|_\d{1,3}/, '')
 	end
 
+	it "include should not work in Lite mode" do
+		text = file_load(Glyph::PROJECT/'text/container.textile')
+		Glyph.lite_mode = true
+		lambda { interpret(text).document.output }.should raise_error Glyph::MacroError
+		Glyph.lite_mode = false
+	end
 
-	it "style" do
-		interpret "style[test.sass]"
-		@p.document.output.gsub(/\n|\t/, '').should == "<style type=\"text/css\">#main {  background-color: #0000ff; }</style>"
+	it "document, head, style" do
+		interpret "document[head[style[test.sass]]]"
+		@p.document.output.gsub(/\n|\t/, '').should == %{
+		<?xml version="1.0" encoding="utf-8"?>
+		<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+		<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+			<head>
+				<title>#{Glyph::CONFIG.get("document.title")}</title>
+				<meta name="author" content="#{Glyph["document.author"]}" />
+				<meta name="copyright" content="#{Glyph["document.author"]}" />
+				<meta name="generator" content="Glyph v#{Glyph::VERSION} (http://www.h3rald.com/glyph)" />
+				<style type=\"text/css\">#main {  background-color: #0000ff; }</style>
+			</head>
+		</html>
+		}.gsub(/\n|\t/, '')
 	end	
 
+	it "style should link files by absolute or relative path in Lite mode" do
+		result = %{
+		<?xml version="1.0" encoding="utf-8"?>
+		<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+		<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+			<head>
+				<title>#{Glyph::CONFIG.get("document.title")}</title>
+				<meta name="author" content="#{Glyph["document.author"]}" />
+				<meta name="copyright" content="#{Glyph["document.author"]}" />
+				<meta name="generator" content="Glyph v#{Glyph::VERSION} (http://www.h3rald.com/glyph)" />
+				<style type=\"text/css\">#main {  background-color: #0000ff; }</style>
+			</head>
+		</html>
+		}.gsub(/\n|\t/, '')
+		Glyph.lite_mode = true
+		Dir.chdir Glyph::PROJECT
+		interpret "document[head[style[styles/test.sass]]]"
+		@p.document.output.gsub(/\n|\t/, '').should == result
+		interpret "document[head[style[#{Glyph::PROJECT}/styles/test.sass]]]"
+		@p.document.output.gsub(/\n|\t/, '').should == result
+	end
+
 	it "escape" do
 		define_em_macro
 		text = %{This is a test em[This can .[=contain test[macros em[test]]=]]}		
@@ -88,12 +172,23 @@ describe "Macro:" do
 	it "ruby" do
 		interpret "2 + 2 = %[2+2]"
 		@p.document.output.should == %{2 + 2 = 4}
+		interpret "%[lite?]"
+		@p.document.output.should == %{false}
+		interpret "%[def test; end]"
 	end
 
 	it "config" do
-		Glyph.config_override "test.setting", "TEST"
+		Glyph["test.setting"] = "TEST"
+		interpret "test.setting = $[test.setting]"
+		@p.document.output.should == %{test.setting = TEST}
+	end
+	
+	it "config:" do
+		Glyph["test.setting"] = "TEST"
 		interpret "test.setting = $[test.setting]"
 		@p.document.output.should == %{test.setting = TEST}
+		interpret "test.setting = $:[test.setting|TEST2]$[test.setting]"
+		@p.document.output.should == %{test.setting = TEST2}
 	end
 
 	it "toc" do
@@ -146,6 +241,19 @@ describe "Macro:" do
 		}.gsub(/\n|\t/, '')
 	end
 
+	it "img should link files by absolute or relative path in Lite mode" do
+		result = %{
+			<img src="images/ligature.jpg" 
+			width="90%" height="90%" alt="-"/>
+		}.gsub(/\n|\t/, '')
+		Glyph.lite_mode = true
+		Dir.chdir Glyph::PROJECT
+		interpret "img[images/ligature.jpg|90%|90%]"
+		@p.document.output.gsub(/\t|\n/, '').should == result
+		interpret "img[#{Glyph::PROJECT}/images/ligature.jpg|90%|90%]"
+		@p.document.output.gsub(/\t|\n/, '').gsub(Glyph::PROJECT.to_s+'/', '').should == result
+	end
+
 	it "fig" do
 		interpret "fig[ligature.jpg|Ligature]"
 		@p.document.output.gsub(/\t|\n/, '').should == %{
@@ -156,4 +264,73 @@ describe "Macro:" do
 		}.gsub(/\n|\t/, '')
 	end
 
+	it "fig should link files by absolute or relative path in Lite mode" do
+		result = %{
+			<div class="figure">
+			<img src="images/ligature.jpg" alt="-"/>
+			<div class="caption">Ligature</div>
+			</div>
+		}.gsub(/\n|\t/, '')
+		Glyph.lite_mode = true
+		Dir.chdir Glyph::PROJECT
+		interpret "fig[images/ligature.jpg|Ligature]"
+		@p.document.output.gsub(/\t|\n/, '').should == result
+		interpret "fig[#{Glyph::PROJECT}/images/ligature.jpg|Ligature]"
+		@p.document.output.gsub(/\t|\n/, '').gsub(Glyph::PROJECT.to_s+'/', '').should == result
+	end
+
+	it "draftcomment, todo" do
+		text1 = "dc[comment!]"
+		text2 = "![todo!]"
+		interpret text1
+		@p.document.output.should == ""
+		interpret text2
+		@p.document.output.should == ""
+		Glyph['document.draft'] = true
+		interpret text1
+		@p.document.output.should == %{<span class="comment"><span class="comment-pre"><strong>Comment:</strong> </span>comment!</span>}
+		interpret text2
+		@p.document.output.should == %{<span class="todo"><span class="todo-pre"><strong>TODO:</strong> </span>todo!</span>}
+		@p.document.todos.length.should == 1
+		Glyph['document.draft'] = false
+	end
+
+	it "highlight" do
+		cr = false
+		uv = false
+		begin
+			require 'coderay'
+			cr = true
+		rescue Exception
+		end
+		begin
+			require 'uv'
+			uv = true
+		rescue Exception
+		end
+		code = %{def test_method(a, b)
+				puts a+b
+			end}
+		cr_result = %{<div class=\"CodeRay\"> <div class=\"code\"><pre> <span class=\"r\">def</span> 
+			<span class=\"fu\">test_method</span>(a, b) puts a+b <span class=\"r\">end</span></pre></div> </div>}
+		uv_result = %{<pre class=\"iplastic\"> <span class=\"Keyword\">def</span> 
+			<span class=\"FunctionName\">test_method</span>(<span class=\"Arguments\">a<span class=\"Arguments\">,</span> b</span>) 
+			puts a<span class=\"Keyword\">+</span>b <span class=\"Keyword\">end</span> </pre>}
+		Glyph['highlighters.ultraviolet.theme'] = 'iplastic'
+		check = lambda do |hl, result|
+			Glyph["highlighters.current"] = hl
+			Glyph.debug_mode = true
+			interpret("highlight[=ruby|\n#{code}=]")
+			@p.document.output.gsub(/\s+/, ' ').strip.should == result.gsub(/\s+/, ' ').strip
+		end
+		check.call 'ultraviolet', uv_result if uv
+		check.call 'coderay', cr_result if cr
+	end
+
+	it "macro:" do
+		interpret '%:[e_macro|
+			"Test: #@value"]e_macro[OK!]'
+		@p.document.output.should == "Test: OK!"
+	end
+
 end