glyph 0.3.0 → 0.4.0

data/macros/html5/block.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+macro :note do
+	%{<aside class="#{@name}">
+<span class="note-title">#{@name.to_s.capitalize}</span>#{value}
+
+</aside>}
+end
+
+macro :box do
+	exact_parameters 2
+	%{<aside class="box">
+<div class="box-title">#{param(0)}</div>
+#{param(1)}
+
+</aside>}
+end
+
+macro :figure do
+	min_parameters 1
+	max_parameters 2
+	image = param(0)
+	alt = "@alt[-]" unless attr(:alt)
+	caption = "figcaption[#{param(1)}]" rescue nil
+	figure_element_for image, alt, caption do |alt, dest_file, caption|
+		interpret %{=figure[
+img[#{alt}@src[#{Glyph['document.base']}#{dest_file}]#{@node.attrs.join}]
+					#{caption}
+]}
+	end
+end
+
+macro :pubdate do
+	no_parameters
+	t = Time.now
+	%{<time class="pubdate" datetime="#{t.strftime("%Y-%m-%d")}">
+#{Time.now.strftime("%B %Y")}
+</time>}
+end
+
+macro :navigation do
+	exact_parameters 1
+	procs = {}
+	procs[:contents] = lambda do
+		%{<a href="#{Glyph["output.#{Glyph['document.output']}.base"]}index.html">Contents</a>}
+	end
+	procs[:previous] = lambda do |topic|
+		if topic then
+			%{<a href="#{Glyph["output.#{Glyph['document.output']}.base"]}#{topic[:src].gsub(/\..+$/, '.html')}">#{topic[:title]} &larr;</a>}
+		else
+			""
+		end
+	end
+	procs[:next] = lambda do |topic|
+		if topic then
+			%{<a href="#{Glyph["output.#{Glyph['document.output']}.base"]}#{topic[:src].gsub(/\..+$/, '.html')}">&rarr; #{topic[:title]}</a>}
+		else
+			""
+		end
+	end
+	procs[:navigation] = lambda do |contents, prev_link, next_link|
+		%{<nav>#{prev_link}#{contents}#{next_link}</nav>}
+	end
+	navigation_element_for param(0).to_sym, procs
+end
+
+macro_alias :important => :note
+macro_alias :tip => :note
+macro_alias :caution => :note

data/macros/html5/inline.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+macro :fmi do
+	exact_parameters 2, :level => :warning
+	fmi_element_for param(0), param(1) do |topic, link|
+		%{<span class="fmi">for more information on <mark>#{topic}</mark>, see #{link}</span>}
+	end
+end
+
+macro :draftcomment do
+	draftcomment_element do |value|
+		%{<aside class="comment"><span class="comment-pre"><strong>Comment:</strong> </span>#{value}</aside>}
+	end
+end
+
+macro :todo do
+	exact_parameters 1
+	todo_element do |value|
+		%{<aside class="todo"><span class="todo-pre"><strong>TODO:</strong> </span>#{value}</aside>} 
+	end
+end
+
+macro_alias '!' => :todo
+macro_alias :dc => :draftcomment

data/macros/html5/structure.rb

@@ -0,0 +1,139 @@
+#!/usr/bin/env ruby
+
+macro :section do 
+	max_parameters 1
+	if raw_attribute(:src) && Glyph.multiple_output_files? then
+		required_attribute :title
+	end
+	procs = {}
+	procs[:title] = lambda do |level, ident, title|
+		%{<header><h1 id="#{ident}">#{title}</h1></header>\n}	
+	end
+	procs[:body] = lambda do |title, value|
+		%{<section class="#{@name}">
+#{title}#{value}
+
+</section>}	
+	end
+	section_element_for procs
+end
+
+macro :article do
+	exact_parameters 1
+	head = raw_attr(:head)
+ 	head ||= %{style[default.css]}
+	pre_title = raw_attr(:"pre-title")
+	post_title = raw_attr(:"post-title")
+	pubdate = @node.attr(:pubdate) ? "time[@class[pubdate]#{@node.attr(:pubdate).contents}]" : "pubdate[]"
+	halftitlepage = raw_attr(:halftitlepage)
+	halftitlepage ||= %{
+			#{pre_title}
+			hgroup[
+				title[]
+				subtitle[]
+			]
+			author[]
+			#{pubdate}
+			#{post_title}
+	}
+	interpret %{document[
+	head[#{head}]
+	body[
+		=article[
+			halftitlepage[
+				#{halftitlepage}
+			]
+			#{@node.value}
+		]
+	]
+]}	
+end
+
+macro :book do
+	no_parameters
+	head = raw_attr(:head) 
+	head ||= %{style[default.css]}
+	pre_title = raw_attr(:"pre-title")
+	post_title = raw_attr(:"post-title")
+	titlepage = raw_attr(:titlepage)
+	pubdate = @node.attr(:pubdate) ? "time[@class[pubdate]#{@node.attr(:pubdate).contents}]" : "pubdate[]"
+	titlepage ||= %{
+			#{pre_title}
+			hgroup[
+				title[]
+				subtitle[]
+			]
+			revision[]
+			author[]
+			#{pubdate}
+			#{post_title}
+	}
+	frontmatter = raw_attr(:frontmatter)
+	bodymatter = raw_attr(:bodymatter)
+	backmatter = raw_attr(:backmatter)
+	frontmatter = "frontmatter[\n#{frontmatter}\n]" if frontmatter
+	bodymatter = "bodymatter[\n#{bodymatter}\n]" if bodymatter
+	backmatter = "backmatter[\n#{backmatter}\n]" if backmatter
+	interpret %{document[
+	head[#{head}]
+	body[
+		titlepage[
+			#{titlepage}
+		]
+		#{frontmatter}
+		#{bodymatter}
+		#{backmatter}
+	]
+]}	
+end
+
+
+macro :document do
+	exact_parameters 1
+	%{<!DOCTYPE html>
+<html lang="en">
+#{value}
+
+</html>}
+end
+
+macro :toc do 
+	max_parameters 1
+	link_proc = lambda do |head|
+		(!Glyph.multiple_output_files? || (head.definition != head.file)) ? %{<a href="#{head.link(@source_file)}">#{head.title}</a>} : head.title
+	end
+	toc_list_proc = lambda do |descend_proc, bmk, document|
+		%{<nav class="contents">
+<h1 class="toc-header" id="#{bmk}">#{bmk.title}</h1>
+<ol class="toc">
+						#{descend_proc.call(document.structure, nil)}
+</ol>
+</nav>}
+	end
+	toc_item_proc = lambda do |classes, header|
+		"<li class=\"#{classes.join(" ").strip}\">#{header}</li>"
+	end
+	toc_sublist_proc = lambda do |contents|
+		"<li><ol>#{contents}</ol></li>\n"
+	end
+	toc_element_for param(0), attr(:title), 
+		:link => link_proc, 
+		:toc_list => toc_list_proc, 
+		:toc_item => toc_item_proc, 
+		:toc_sublist => toc_sublist_proc
+end
+
+# See:
+#  http://microformats.org/wiki/book-brainstorming
+#  http://en.wikipedia.org/wiki/Book_design
+
+(Glyph['system.structure.frontmatter'] + Glyph['system.structure.bodymatter'] + Glyph['system.structure.backmatter']).
+	each {|s| macro_alias s => :section }
+
+macro_alias :frontcover => :section
+macro_alias :titlepage => :section
+macro_alias :halftitlepage => :section
+macro_alias :frontmatter => :section
+macro_alias :bodymatter => :section
+macro_alias :backmatter => :section
+macro_alias :backcover => :section

data/macros/xml.rb

@@ -12,7 +12,7 @@ macro "|xml|" do
 		end
 	end
 	name = @node[:element]
- 	if name.to_s.in? Glyph['language.options.xml_blacklist'] then
+ 	if Glyph["options.xml_blacklist"] && name.to_s.in?(Glyph['options.xml_blacklist']) then
 		""
 	else
 		attributes # evaluate attributes

data/spec/files/custom_command.rb

@@ -0,0 +1,6 @@
+GLI.desc 'Print Hello, World!'
+command :hello do |c|
+	c.action do |global_options,options,args|
+		puts "Hello, World!"
+	end
+end

data/spec/files/custom_tasks.rake

@@ -0,0 +1,6 @@
+namespace :custom do
+	desc "Add a new text file to the project"
+	task :hello do
+		puts "Hello, World!"
+	end
+end

data/spec/files/document_for_stats.glyph

@@ -0,0 +1,12 @@
+snippet:[test|A test]
+snippet:[unused|...]
+toc[1]
+include[container.textile]
+include[a/b/c/markdown.markdown]
+section[
+	@id[refs]
+	@title[Refs.]
+	@src[references.glyph]
+	snippet[test]
+	#[unused]
+]

data/spec/files/references.glyph

@@ -0,0 +1,4 @@
+&[test]
+=>[#refs]
+=>[#h_1]
+=>[http://www.h3rald.com]

data/spec/files/web1.glyph

@@ -0,0 +1,11 @@
+	section[
+		@title[Test #1a]
+=>[#w2_1]
+=>[#w1_3]
+...
+	]
+	section[
+		@title[Test #1b]
+		@id[w1_3]
+...
+	]

data/spec/files/web2.glyph

@@ -0,0 +1,10 @@
+section[
+	@title[Test #2a]
+	@id[w2_1]
+=>[#w1_3]
+...
+]
+section[
+	@title[Test #2b]
+...
+]

data/spec/files/web_doc.glyph

@@ -0,0 +1,23 @@
+document[
+	head[
+		style[default.css]
+		style[test.sass]
+	]
+	body[
+		toc[]
+		contents[
+			section[
+				@title[Web Document]
+...
+				section[
+					@src[a/web1.glyph]
+					@title[Topic #1]
+				]
+				section[
+					@src[a/b/web2.glyph]
+					@title[Topic #2]
+				]
+			]
+		]
+	]
+]

data/spec/lib/analyzer_spec.rb

@@ -0,0 +1,137 @@
+# encoding: utf-8
+
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe Glyph::Analyzer do
+
+	before do
+		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
+
+	after do
+		delete_project_dir
+	end
+
+	it "should be initialized with a document" do
+		lambda { Glyph::Analyzer.new(Glyph.document) }.should_not raise_error
+		lambda { Glyph::Analyzer.new }.should_not raise_error
+	end
+
+	it "should expose a macro node iterator" do
+		lambda { @a.with_macros }.should raise_error(ArgumentError, "No block given")
+		count = 0
+		lambda { @a.with_macros {|n| count+=1} }.should_not raise_error
+		count.should == 20
+		count = 0
+		lambda { @a.with_macros(:snippet) {|n| count+=1} }.should_not raise_error
+		count.should == 2
+		count = 0
+		lambda { @a.with_macros(:&) {|n| count+=1} }.should_not raise_error
+		count.should == 2
+	end
+
+	it "should access macro instance arrays by definition" do
+		@a.macro_array_for(:snippet).should == []
+		@a.with_macros {}
+		@a.macro_array_for(:snippet).length.should == 2
+		@a.macro_array_for(:&).length.should == 2
+		@a.macro_array_for(:section).length.should == 4
+	end
+
+	it "should raise an error if a stat is not available" do
+		lambda { @a.stats_for :unknown }.should raise_error(RuntimeError, "Unable to calculate unknown stats")
+	end
+
+	it "should calculate stats for all macros" do
+		lambda {@a.stats_for :macros}.should_not raise_error
+		@a.stats[:macros].blank?.should == false
+		c = @a.stats[:macros]
+		c[:definitions].should == (Glyph::MACROS.keys - Glyph::ALIASES[:by_alias].keys).uniq.sort
+		c[:aliases].should == Glyph::ALIASES[:by_alias].keys.sort
+		c[:instances].length.should == 20
+		c[:used_definitions].should == [:anchor, :include, :link, :markdown, :section, :snippet, :"snippet:", :textile, :toc]
+	end
+
+	it "should calculate stats for a single macro" do
+		lambda {@a.stats_for :macro, :dsfash }.should raise_error(ArgumentError, "Unknown macro 'dsfash'")
+		lambda {@a.stats_for :macro, :frontmatter }.should 
+		raise_error(ArgumentError, "Alias 'frontmatter' is not used in this document, did you mean 'section'?")
+		lambda {@a.stats_for :macro, :section }.should_not raise_error
+		c = @a.stats[:macro]
+		c[:instances].length.should == 4
+		c[:files].should == [["document.glyph", 1], ["text/a/b/c/included.textile", 1], 
+			["text/a/b/c/markdown.markdown", 1], ["text/container.textile", 1]]
+		@a.stats_for :macro, :"&"
+		c = @a.stats[:macro]
+		c[:alias_for].should == :snippet
+		c[:instances].length.should == 2
+	end
+
+	it "should calculate stats for all bookmarks" do
+		lambda {@a.stats_for :bookmarks}.should_not raise_error
+		c = @a.stats[:bookmarks]
+		c[:codes].should == [:h_1, :h_2, :md, :refs, :toc, :unused]
+		c[:unreferenced].should == [:h_2, :md, :toc, :unused]
+		c[:referenced].should == [[:h_1, 1], [:refs, 1]]
+	end
+
+	it "should calculate stats for a single bookmark" do
+		lambda {@a.stats_for :bookmark, '#h_7'}.should raise_error(ArgumentError, "Bookmark 'h_7' does not exist")
+		lambda {@a.stats_for :bookmark, '#h_1'}.should_not raise_error
+		c = @a.stats[:bookmark]
+		c[:file].should == "text/container.textile"
+		c[:references].should == [["text/references.glyph", 1]]
+		c[:type].should == :header
+	end
+
+	it "should calculate stats for all links do" do
+		lambda {@a.stats_for :links}.should_not raise_error
+		c = @a.stats[:links]
+		c[:internal].should == [["#h_1", {:total=>1, :files=>[["text/references.glyph", 1]]}], 
+			 ["#refs", {:total=>1, :files=>[["text/references.glyph", 1]]}]]
+		c[:external].should == [["http://www.h3rald.com", {:total=>1, :files=>[["text/references.glyph", 1]]}]]
+	end
+
+	it "should calculate stats for a single link" do
+		lambda {@a.stats_for :link, 'q'}.should raise_error(ArgumentError, "No link matching /q/ was found")
+		lambda {@a.stats_for :link, 'h'}.should_not raise_error
+		c = @a.stats[:link][:stats]
+		c.should == [["#h_1", {:total=>1, :files=>[["text/references.glyph", 1]]}], 
+			["http://www.h3rald.com",{:total=>1, :files=>[["text/references.glyph", 1]]}]]
+	end
+
+	it "should calculate stats for all snippets" do
+		lambda {@a.stats_for :snippets}.should_not raise_error
+		c = @a.stats[:snippets]
+		c[:used].should == [:test]
+		c[:total].should == 2
+		c[:unused].should == [:unused]
+	 	c[:definitions].should == [:test, :unused]	
+	end
+
+	it "should calculate stats for a single snippet" do
+		lambda {@a.stats_for :snippet, 'test1'}.should raise_error(ArgumentError, "Snippet 'test1' does not exist")
+		lambda {@a.stats_for :snippet, 'unused'}.should raise_error(ArgumentError, "Snippet 'unused' is not used in this document")
+		lambda {@a.stats_for :snippet, 'test'}.should_not raise_error
+		c = @a.stats[:snippet][:stats]
+		c.should == {:total=>2, :files=>[["document.glyph", 1], ["text/references.glyph", 1]]}
+	end
+
+	it "should calculate global stats" do
+		lambda {@a.stats_for :global}.should_not raise_error
+		c = @a.stats
+		c[:bookmarks].blank?.should == false
+		c[:links].blank?.should == false
+		c[:snippets].blank?.should == false
+		c[:macros].blank?.should == false
+		c[:files].should == {:layouts=>0, :images=>1, :styles=>1, :text=>4, :lib=>0}
+	end
+
+end