glyph 0.3.0 → 0.4.0

data/spec/lib/bookmark_spec.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe Glyph::Bookmark do
+
+	before do
+		@b = Glyph::Bookmark.new :id => :test, :file => "test.glyph"
+	end
+
+	it "should be initialized with at least an id" do
+		lambda { Glyph::Bookmark.new }.should raise_error
+		lambda { Glyph::Bookmark.new({:id => :test}) }.should_not raise_error
+		lambda { Glyph::Bookmark.new({:file => "test"}) }.should raise_error
+		lambda { Glyph::Bookmark.new({:id => "test", :file => "test.glyph"}) }.should_not raise_error
+	end
+
+	it "shiuld expose title, code and file" do
+		@b.file.should == "test.glyph"
+		@b.code.should == :test
+		@b.title.should == nil
+		Glyph::Bookmark.new(:id => :test2, :title => "Test 2").title.should == "Test 2"
+	end
+
+	it "should convert to a string" do
+		@b.code.to_s == @b.to_s
+		"#{@b}".should == @b.to_s
+	end
+
+	it "should format the link for a single output file" do
+		# Link within the same file
+		@b.link.should == "#test"
+		# Link to a different file file
+		@b.link('intro.glyph').should == "#test"
+	end
+
+	it "should format the link for multiple output files" do
+		out = Glyph['document.output']
+		Glyph['document.output'] = 'web'
+		# Link within the same file
+		@b.link("test.glyph").should == "#test"
+		# Link to a different file file
+		@b.link("intro.glyph").should == "/test.html#test"
+		# Test that base directory is added correctly
+		Glyph["output.#{Glyph['document.output']}.base"] = ""
+		@b.link("intro.glyph").should == "test.html#test"
+		@b.link("test.glyph").should == "#test"
+		Glyph['document.output'] = out
+	end
+
+	it "should check ID validity" do
+		lambda { Glyph::Bookmark.new :id => "#test$", :file => "test.glyph"}.should raise_error(RuntimeError, "Invalid bookmark ID: #test$")		
+	end
+
+	it "should check bookmark equality" do
+		@b.should == Glyph::Bookmark.new(:id => :test, :file => 'test.glyph')
+		@b.should == Glyph::Bookmark.new(:id => :test, :file => "test.glyph")
+		@b.should == Glyph::Bookmark.new(:id => :test, :file => 'test.glyph', :level => 2)
+		@b.should_not == Glyph::Bookmark.new(:id => :test1, :file => 'test.glyph')
+		@b.should_not == Glyph::Bookmark.new(:id => :test, :file => 'test1.glyph')
+	end
+
+end

data/spec/lib/commands_spec.rb

@@ -23,7 +23,7 @@ describe "glyph" do
 	it "[config] should read configuration settings" do
 		create_project
 		run_command_successfully(["config", "-g"]).should == false
-		run_command(["config", "filters.target"]).match(/html/m).should_not == nil
+		run_command(["config", "document.html.filter_target"]).match(/html/m).should_not == nil
 	end
 
 	it "[config] should write configuration settings" do
@@ -149,9 +149,18 @@ describe "glyph" do
 		Glyph.enable 'generate:html'
 		(Glyph::PROJECT/'article.html').unlink
 		Glyph['document.output'] = 'pdf'
-		run_command_successfully(["compile", "article.glyph"]).should == true
-		(Glyph::PROJECT/'article.html').exist?.should == true
-		(Glyph::PROJECT/'article.pdf').exist?.should == true
+		src = Glyph::PROJECT/'article.html'
+		out = Glyph::PROJECT/'article.pdf'
+		generate_pdf = lambda do |gen|
+			Glyph.enable 'generate:pdf'
+			Glyph['output.pdf.generator'] = gen
+			run_command_successfully(["compile", "article.glyph"]).should == true
+			src.exist?.should == true
+			out.exist?.should == true
+			out.unlink
+		end
+		generate_pdf.call 'prince'
+		generate_pdf.call 'wkhtmltopdf'
 		Glyph.lite_mode = false
 	end	
 
@@ -197,7 +206,7 @@ test_project - Outline
 		i_id = "[#h_2]"
 		m_id = "[#md]"
 		file_write Glyph::PROJECT/'document.glyph', "document[#{file_load(Glyph::PROJECT/'document.glyph')}]"
-		run_command(["outline"]).should == %{#{start}
+		run_command(["-d", "outline"]).should == %{#{start}
   #{c_title}
     #{i_title}
   #{m_title}
@@ -218,4 +227,20 @@ test_project - Outline
 }
 	end
 
+	it "[stats] should display project statistics" do
+		reset_quiet
+		create_project
+		out = run_command(["stats", "-ms"])
+		out.should match "-- Total Macro Definitions: 44" 
+		out.should match "-- Unused Snippets: test"
+		out = run_command(["stats"])
+		out.should match "-- Total Macro Definitions: 44" 
+		out.should_not match "-- Unused Snippets: test"
+		out.should match "-- Total Unreferenced Bookmarks: 3"
+		out = run_command(["stats", "-lb", "--bookmark=md"])
+		out.should match "-- Unreferenced Bookmarks: h_1, h_2, md" 
+		out.should match "-- Defined in: text/a/b/c/markdown.markdown"
+		out.should_not match "-- Total Macro Definitions: 19"
+	end
+
 end

data/spec/lib/document_spec.rb

@@ -17,15 +17,18 @@ describe Glyph::Document do
 
 	it "should expose document data" do
 		@doc.bookmarks.should == {}
+		@doc.headers.should == {}
+		@doc.styles.should == []
 		@doc.placeholders.should == {}
 		@doc.new?.should == true
 	end
 
 	it "should store bookmarks" do
-		lambda { @doc.bookmark(:id => "test", :title => "Test Bookmark #1")}.should_not raise_error
-		lambda { @doc.bookmark(:id => :test, :title => "Test Bookmark #2")}.should_not raise_error
+		lambda { @doc.bookmark(:id => "test", :title => "Test Bookmark #1", :file => 'test.glyph')}.should_not raise_error
+		lambda { @doc.bookmark(:id => :test, :title => "Test Bookmark #1", :file => 'test.glyph')}.should raise_error
+		lambda { @doc.bookmark(:id => :test, :title => "Test Bookmark #2", :file => 'test2.glyph')}.should raise_error
 		@doc.bookmarks.length.should == 1
-		@doc.bookmarks[:test].should == {:id => :test, :title => "Test Bookmark #2"}
+		@doc.bookmarks[:test].should == Glyph::Bookmark.new(:id => :test, :title => "Test Bookmark #1", :file => "test.glyph")
 	end
 
 	it "should store placeholders" do
@@ -34,20 +37,29 @@ describe Glyph::Document do
 		@doc.placeholders["‡‡‡‡‡PLACEHOLDER¤1‡‡‡‡‡".to_sym].should == p
 	end
 
+	it "should store styles" do
+		lambda {@doc.style "test.css"}.should_not raise_error
+		@doc.styles.include?(Pathname.new('test.css')).should == true
+	end
+
 	it "can inherit data from another document" do
-		@doc.bookmark :id => :test1, :title => "Test #1"
-		@doc.bookmark :id => :test2, :title => "Test #2"
+		@doc.bookmark :id => :test1, :title => "Test #1", :file => "test.glyph"
+		@doc.bookmark :id => :test2, :title => "Test #2", :file => "test.glyph"
 		@doc.placeholder { "test" }
-		@doc.header :id => :test3, :title => "Test #3", :level => 3
+		@doc.style "test.css"
+		@doc.header :id => :test3, :title => "Test #3", :level => 3, :file => "test.glyph"
+		@doc.toc[:contents] = "TOC goes here..."
 		doc2 = create_doc @tree
 		doc2.bookmarks.length.should == 0
 		doc2.placeholders.length.should == 0
-		doc2.bookmark :id => :test4, :title => "Test #4"
+		doc2.bookmark :id => :test4, :title => "Test #4", :file => "test.glyph"
 		doc2.inherit_from @doc
-		doc2.bookmarks.length.should == 2
+		doc2.bookmarks.length.should == 3
 		doc2.placeholders.length.should == 1
 		doc2.headers.length.should == 1
-		doc2.bookmarks[:test3].should == nil
+		doc2.styles.length.should == 1
+		doc2.toc[:contents] = "TOC goes here..."
+		doc2.bookmarks[0].should_not == Glyph::Bookmark.new(:id => :test4, :title => "Test #4", :file => "test.glyph")
 	end
 
 	it "should analyze the syntax tree and finalize the document" do
@@ -109,5 +121,33 @@ describe Glyph::Document do
 		doc.finalize
 		doc.output.should == result
 	end
+
+	it "should store the Table of Contents" do
+		delete_project
+		create_project
+		Glyph.run! "load:all"
+		text = %{
+			document[
+				body[
+					toc[]
+					section[
+						@title[test 1]
+						...
+						section[
+							@title[test 2]
+							...
+						]
+					]
+				]
+			]
+		}
+		tree = create_tree text
+		doc = create_doc tree
+		doc.analyze
+		doc.finalize
+		doc.toc[:contents].match(%{<div class="contents">}).blank?.should == false
+		reset_quiet
+	end
+
 end
 

data/spec/lib/glyph_spec.rb

@@ -39,7 +39,7 @@ describe Glyph do
 		lambda { Glyph.macro_alias("->" => :ref)}.should_not raise_error
 		Glyph::MACROS[:"->"].should == Glyph::MACROS[:ref]
 		Glyph.macro_alias :em => :ref
-		Glyph::MACROS[:em].should_not == Glyph::MACROS[:ref]
+		Glyph::MACROS[:em].should == Glyph::MACROS[:ref]
 	end
 
 	it "should provide a filter method to convert raw text into HTML" do
@@ -73,4 +73,24 @@ describe Glyph do
 		Glyph.safe_mode = false
 	end
 
+	it "should rewrite macros using Glyph syntax" do
+		define_em_macro
+		Glyph.rewrite :test_rw_macro, %{em[{{0}} -- {{a}}]}
+		output_for("test_rw_macro[@a[!]?]").should == "<em>? -- !</em>"
+	end
+
+	it "should store alias information" do
+		delete_project_dir
+		create_project_dir
+		Glyph.run! 'project:create', Glyph::PROJECT
+		Glyph.run 'load:all'
+		Glyph::ALIASES[:by_def][:snippet].should == [:&]
+		Glyph::ALIASES[:by_alias][:"?"].should == :condition
+		Glyph.macro_aliases_for(:link).should == [:"=>"]
+		Glyph.macro_aliases_for(:"=>").should == nil
+		Glyph.macro_definition_for(:"=>").should == :link
+		Glyph.macro_definition_for(:link).should == nil
+		Glyph.macro_alias?(:"#").should == true
+	end
+
 end

data/spec/lib/macro_spec.rb

@@ -44,17 +44,17 @@ describe Glyph::Macro do
 	end
 
 	it "should store and check bookmarks" do
-		h = { :id => "test2", :title => "Test 2" }
+		h = { :id => "test2", :title => "Test 2", :file => 'test.glyph' }
 		@macro.bookmark h
-		@doc.bookmark?(:test2).should == h
-		@macro.bookmark?(:test2).should == h
+		@doc.bookmark?(:test2).should == Glyph::Bookmark.new(h)
+		@macro.bookmark?(:test2).should == Glyph::Bookmark.new(h)
 	end
 
 	it "should store and check headers" do
-		h = { :level => 2, :id => "test3", :title => "Test 3" }
+		h = { :level => 2, :id => "test3", :title => "Test 3", :file => "test.glyph"}
 		@macro.header h
-		@doc.header?("test3").should == h
-		@macro.header?("test3").should == h
+		@doc.header?("test3").should == Glyph::Bookmark.new(h)
+		@macro.header?("test3").should == Glyph::Bookmark.new(h)
 	end
 
 	it "should store placeholders" do

data/spec/lib/macro_validators_spec.rb

@@ -51,5 +51,29 @@ describe Glyph::Macro::Validators do
 		output_for("test[test @.test[test]]").should == "<test>test</test>"
 	end
 
+	it "should validate required attributes" do
+		Glyph['document.output'] = 'web'
+		Glyph.run! 'load:macros'
+		lambda { output_for("contents[section[@src[test]]]") }.should raise_error(Glyph::MacroError, "Macro 'section' requires a 'title' attribute")
+	end
+
+	it "should validate if a macro is within another one" do
+		define_em_macro
+		Glyph.macro :within_m do
+			within :em
+			"---"
+		end
+		lambda { output_for("within_m[test]") }.should raise_error(Glyph::MacroError, "Macro 'within_m' must be within a 'em' macro")
+	end	
+
+	it "should validate if a macro is not within another one" do
+		define_em_macro
+		Glyph.macro :within_m do
+			not_within :em
+			"---"
+		end
+		lambda { output_for("em[within_m[test]]") }.should raise_error(Glyph::MacroError, "Macro 'within_m' must not be within a 'em' macro")
+	end	
+
 end
 

data/spec/lib/reporter_spec.rb

@@ -0,0 +1,132 @@
+# encoding: utf-8
+
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe Glyph::Reporter do
+
+	before do
+		delete_project
+		reset_quiet
+		create_project_dir
+		create_project
+		Glyph.file_copy Glyph::SPEC_DIR/'files/document_for_stats.glyph', Glyph::PROJECT/'document.glyph'
+		Glyph.file_copy Glyph::SPEC_DIR/'files/references.glyph', Glyph::PROJECT/'text/references.glyph'
+		Glyph.run! 'generate:document'
+		@a = Glyph::Analyzer.new
+	end
+
+	def stats(name, *args)
+		@a.stats_for(name, *args)
+	end
+	
+	def rep
+		@r = Glyph::Reporter.new(@a.stats)
+	end
+
+	after do
+		delete_project_dir
+	end
+
+	it "should be initialized with stats" do
+		stats :macros
+		lambda { rep }.should_not raise_error
+	end
+
+	it "should display macro stats" do
+		stats :macros
+		out = stdout_for { rep.display }
+		out.should match "Total Macro Instances: 20"
+		out.should match "-- Used Macro Definitions:"
+		@r.detailed = false
+		out = stdout_for { @r.display }
+		out.should_not match "-- Used Macro Definitions:"
+	end
+
+	it "should display stats for a single macro" do
+		stats :macro, :section
+		out = stdout_for { rep.display }
+		out.should match "text/a/b/c/markdown.markdown \\(1\\)"
+		out.should match "-- Total Instances: 4"
+		@r.detailed = false
+		out = stdout_for { @r.display }
+		out.should_not match "text/a/b/c/markdown.markdown \\(1\\)"
+		stats :macro, :"=>"
+		out = stdout_for { rep.display }
+		out.should match "alias for: link"
+	end
+
+	it "should display bookmark stats" do
+		stats :bookmarks
+		out = stdout_for { rep.display }
+		out.should match "-- Total Bookmarks: 6"
+		out.should match "h_1    h_2    md     refs   toc"
+		out.should match "   - h_1 \\(1\\)"
+		@r.detailed = false
+		out = stdout_for { @r.display }
+		out.should_not match "-- Occurrences:"
+	end
+
+	it "should display stats for a single bookmark" do
+		stats :bookmark, 'refs'
+		out = stdout_for { rep.display }
+		out.should match "===== Bookmark 'refs' \\(header\\)"
+		out.should match "   - text/references.glyph \\(1\\)"
+		@r.detailed = false
+		out = stdout_for { @r.display }
+		out.should_not match "-- Referenced in:"
+	end
+
+	it "should display snippet stats" do
+		stats :snippets
+		out = stdout_for { rep.display }
+		out.should match "-- Total Snippets: 2"
+	end
+
+	it "should display stats for a single snippet" do
+		stats :snippet, :test
+		out = stdout_for { rep.display }
+		out.should match "-- Total Used Instances: 2"
+		out.should match "   - text/references.glyph \\(1\\)"
+		@r.detailed = false
+		out = stdout_for { @r.display }
+		out.should_not match "-- Usage Details:"
+	end
+
+	it "should display link stats" do
+		stats :links
+		out = stdout_for { rep.display }
+		out.should match "http://www.h3rald.com"
+		out.should match "-- Total Internal Links: 2"
+		@r.detailed = false
+		out = stdout_for { @r.display }
+		out.should_not match "     - text/references.glyph (1)"
+	end
+
+	it "should display stats for a single link" do
+		stats :link, 'h3'
+		out = stdout_for { rep.display }
+		out.should match "===== Links matching \\/h3\\/"
+		out.should match "   - http://www.h3rald.com \\(1\\)"
+		@r.detailed = false
+		out = stdout_for { @r.display }
+		out.should_not match "   - http://www.h3rald.com \\(1\\)"
+	end
+
+	it "should display files stats" do
+		stats :files
+		out = stdout_for { rep.display }
+		out.should match "-- Total Files: 6"
+		out.should match "-- /text    -- 4"
+	end
+
+	it "should display global stats" do
+		stats :global
+		out = stdout_for { rep.display }
+		out.should match "-- Total Files: 6"
+		out.should match "   - http://www.h3rald.com"
+		out.should match "Total Macro Instances: 20"
+		out.should match "-- Total Snippets: 2"
+		out.should match "h_1    h_2    md     refs   toc"
+	end
+end

data/spec/macros/core_spec.rb

@@ -83,7 +83,7 @@ describe "Macro:" do
 		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 == %{
+		@p.document.output.gsub(/\n|\t/, '').should == %{
 			<div class="section">
 			<h2 id="h_1">Container section</h2>
 			This is a test.
@@ -92,7 +92,7 @@ describe "Macro:" do
 				<p>&#8230;</p>
 				</div>
 			</div>
-		}.gsub(/\n|\t|_\d{1,3}/, '')
+		}.gsub(/\n|\t/, '')
 	end
 
 	it "include should work in Lite mode" do
@@ -191,5 +191,4 @@ Test -- Test Snippet
 		end.should raise_error(Glyph::MacroError)
 	end
 
-
 end