glyph 0.2.0 → 0.3.0

data/Rakefile

@@ -31,17 +31,15 @@ begin
 		s.files.include "book/**/*"
 		s.add_dependency 'gli', '>= 0.3.1' # Command line interface
 		s.add_dependency 'extlib', '>= 0.9.12' # Extension methods
-		s.add_dependency 'treetop', '>= 0.4.3' # Glyph Language Parser
 		s.add_dependency 'rake', '>= 0.8.7' # Glyph rasks
 		s.add_development_dependency 'rspec', '>= 1.1.11' # Test suite
 		s.add_development_dependency 'yard', '>= 1.5.4' # Documentation suite
 		s.add_development_dependency 'jeweler', '1.4.0' # Gem management
 		s.add_development_dependency 'directory_watcher', ">= 1.3.2" # Auto-regeneration
-		s.add_development_dependency 'haml', ">= 2.2.3" # Sass filter
+		s.add_development_dependency 'haml', ">= 3.0.6" # Sass filter
 		s.add_development_dependency 'RedCloth', ">= 4.2.3" # Textile filter
 		s.add_development_dependency 'bluecloth', ">= 2.0.7" # Markdown filter
 		s.add_development_dependency 'coderay', ">= 0.9.3" # Syntax Highlighting
-		s.add_development_dependency 'ruby-prof', ">= 0.8.1" # Code profiling
 	end
 	Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/benchmark.rb

@@ -0,0 +1,72 @@
+require 'rubygems'
+require 'pathname'
+require 'extlib'
+require 'bluecloth'
+require 'redcloth'
+require 'benchmark'
+require Pathname.new(__FILE__).parent/"lib/glyph.rb"
+
+
+
+def macro_exec(text)
+	Glyph::Interpreter.new(text).document.output
+end
+
+def sep
+	puts "="*100
+end
+
+N = 50
+
+def rep(x, title, &block)
+	x.report(title.to_s) { N.times(&block) }
+end
+
+def reset_glyph
+	Glyph.lite_mode = true
+	Glyph['system.quiet'] = true
+end
+
+
+text = %{
+Lorem ipsum dolor sit amet, consectetur _adipisicing elit_, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 
+Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 
+* Duis aute irure dolor in *reprehenderit* in voluptate velit esse cillum dolore eu fugiat nulla pariatur. 
+* Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+}
+html = %{
+p[Lorem ipsum dolor sit amet, consectetur em[adipisicing elit], sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.]
+p[Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.]
+ul[
+	li[Duis aute irure dolor in strong[reprehenderit] in voluptate velit esse cillum dolore eu fugiat nulla pariatur.]
+	li[Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.]
+]
+}
+
+reset_glyph
+Glyph.run! 'load:all'
+Glyph::SNIPPETS[:test] = text
+Benchmark.bm(30) do |x|
+
+	sep
+	puts " => Core Classes"
+	rep(x, "Glyph::Interpreter.new.parse") {Glyph::Interpreter.new(text).parse}
+	rep(x, "Glyph::Parser.new(text).parse") {Glyph::Parser.new(text).parse}
+	sep
+	puts " => Macro Set: Glyph"
+	sep
+	rep(x, "section[...]") { macro_exec "section[#{text}]" }
+	rep(x, "snippet[...]") { macro_exec "snippet[test]" }
+  rep(x, "textile[...]") { macro_exec "textile[#{text}]" }
+	rep(x, "markdown[...]") { macro_exec "markdown[#{text}]" }
+	rep(x, "HTML text") { macro_exec html }
+	sep
+	rep(x, "Markdown (BlueCloth)") {BlueCloth.new(text).to_html } 
+	rep(x, "Textile (RedCloth)") {RedCloth.new(text).to_html } 
+	sep
+	puts " => Macro Set: XML"
+	reset_glyph
+	Glyph['language.set'] = 'xml'
+	Glyph.run! 'load:all'
+	rep(x, "HTML text") { macro_exec html }
+end

data/book/config.yml

@@ -1,11 +1,11 @@
 --- 
-:highlighters: 
-  :current: ultraviolet
-  :ultraviolet: 
-    :theme: blackboard
 :document: 
   :output: html
   :title: Glyph
   :subtitle: Rapid Document Authoring Framework
   :author: Fabio Cevasco
+  :revision: "v0.3.0"
   :filename: glyph
+  :draft: true
+:filters:
+  :highlighter: ultraviolet

data/book/document.glyph

@@ -1,66 +1,99 @@
-document[
-	head[
+book[
+	@head[
 		style[default.css]
 		?[eq[$[document.output]|pdf]|style[pagination.css]]
-		?[eq[$[highlighters.current]|coderay]|style[coderay.css]]
-		?[eq[$[highlighters.current]|ultraviolet]|style[ultraviolet/blackboard.css]]
+		?[eq[$[filters.highlighter]|coderay]|style[coderay.css]]
+		?[eq[$[filters.highlighter]|ultraviolet]|style[ultraviolet/lazy.css]]
 	]
-	body[
-		titlepage[
-			?[eq[$[document.output]|pdf]|img[glyph.svg|20%|20%]]
-			?[eq[$[document.output]|html]|img[glyph.png|20%|20%]]
-			title[]
-			subtitle[]
-			v\.%[Glyph::VERSION]
-			author[]
-			pubdate[]
-		]
-		frontmatter[
-			toc[]
-			introduction[header[Introduction]
-				textile[@[introduction.glyph]]
-				section[header[License]
-					textile[@[license.glyph]]
-				]
-			]
-			acknowledgement[header[Acknowledgement]
-				textile[@[acknowledgement.glyph]]
+	@pre-title[
+		?[eq[$[document.output]|pdf]|image[@width[20%]@height[20%]glyph.svg]]
+		?[eq[$[document.output]|html]|image[@width[20%]@height[20%]glyph.png]]
+	]
+	@frontmatter[
+		toc[3]
+		introduction[
+			@title[Introduction]
+			textile[include[introduction]]
+			section[
+				@title[License]
+				textile[include[license]]
 			]
 		]
-		bodymatter[
-			chapter[
-				header[Getting Started]
-				textile[@[getting_started.glyph]]
-			]
-			chapter[
-				header[Authoring Documents]
-				textile[@[authoring.glyph]]
-			]
-			chapter[
-				header[Extending Glyph|extending]
-				textile[@[extending.glyph]]
-			]
-			chapter[
-				header[Troubleshooting]
-				textile[@[troubleshooting.glyph]]
-			]
+		acknowledgement[
+			@title[Acknowledgement]
+			textile[include[acknowledgement]]
 		]
-		backmatter[
-			appendix[
-				header[Command Reference|cmd_ref]
-				textile[@[ref_commands.glyph]]
-			]
-			appendix[
-				header[Macro Reference|macro_ref]
-				textile[@[ref_macros.glyph]]
-			]
-			appendix[
-				header[Configuration Reference|cfg_ref]
-				textile[@[ref_config.glyph]]
-			]
-			appendix[header[Changelog]
-				@[changelog.glyph]
-			]
+	]
+	@bodymatter[
+		chapter[
+			@title[Getting Started]
+			include[getting_started/create_project]
+			include[getting_started/structure]
+			include[getting_started/configuration]
+		]
+		chapter[
+			@title[Authoring Documents]
+			include[text_editing/glyph_files]
+			include[text_editing/macro_intro]
+			include[text_editing/sections]
+			include[text_editing/links]
+			include[text_editing/images]
+			include[text_editing/code]
+			include[text_editing/raw_html]
+			include[text_editing/stylesheets]
+			include[text_editing/inclusions]
+			include[text_editing/evaluation]
+			include[text_editing/conditionals]
+		]
+		chapter[
+			@title[Generating Output Files]
+			include[compiling/compiling]
+			include[compiling/lite_mode]
+			include[compiling/programmatic_usage]
+		]
+		chapter[
+			@title[Extending Glyph]
+			@id[extending]
+			include[extending/internals]
+			include[extending/macro_def]
+			include[extending/params_attrs]
+			include[extending/bookmarks_headers]
+			include[extending/placeholders]
+			include[extending/validators]
+			include[extending/interpreting]
+			include[extending/further_reading]
+		]
+		chapter[
+			@title[Troubleshooting]
+			include[troubleshooting/errors_intro]
+			include[troubleshooting/errors_generic]
+			include[troubleshooting/errors_parser]
+			include[troubleshooting/errors_command]
+			include[troubleshooting/errors_macro]
+		]
+	]
+	@backmatter[
+		appendix[
+			@title[Command Reference]
+			@id[cmd_ref]
+			include[ref_commands]
+		]
+		appendix[
+			@title[Macro Reference]
+			@id[macro_ref]
+			include[macros/macros_core]
+			include[macros/macros_block]
+			include[macros/macros_inline]
+			include[macros/macros_filters]
+			include[macros/macros_structure]
+		]
+		appendix[
+			@title[Configuration Reference]
+			@id[cfg_ref]
+			include[ref_config]
+		]
+		appendix[@title[Changelog]
+		include[changelog]
 		]
 	]
 ]

data/book/lib/macros/reference.rb

@@ -6,7 +6,7 @@ macro :error_table do
 				<th style="width:30%">Error Message</th>
 				<th>Description</th>
 			</tr>
-			#{@value}
+			#{value}
 		</table>
 	}
 end
@@ -22,42 +22,45 @@ macro :ref_error do
 end
 
 macro :"%>" do
-	interpret "=>[#m_#{@value.gsub(/[^a-z0-1_-]/, '_')}|#@value] macro"
+	interpret "=>[#m_#{value.gsub(/[^a-z0-1_-]/, '_')}|#{value}] macro"
 end
 
 macro :"#>" do
-	interpret "=>[#c_#@value|#@value] command"
+	interpret "=>[#c_#{value}|#{value}] command"
 end
 
 macro :"$>" do
-	val = @value.gsub /\./, "_"
-	interpret "=>[#s_#{val}|#@value] setting"
+	val = value.gsub /\./, "_"
+	interpret "=>[#s_#{val}|#{value}] setting"
 end
 
 macro :default do
-	%{*Default Value:* @#@value@}
+	%{<strong>Default Value:</strong> <code>#{value}</code>}
 end
 
-macro :"parameters" do
+macro :parameters do
 	interpret %{
-		section[header[#{@name.to_s[0..0].upcase+@name.to_s[1..@name.to_s.length-1]}]
+		section[
+			@title[#{@name.to_s[0..0].upcase+@name.to_s[1..@name.to_s.length-1]}]
+			@notoc[true]
 
 		<table style="width:100%;">
 			<tr>
 				<th style="width:30%">#{@name.to_s[0..0].upcase+@name.to_s[1..@name.to_s.length-2]}</th>
 				<th>Description</th>
 			</tr>
-#{@value}
+#{value}
 		</table>
 		]
 	}
 end
 
 macro :option do
-	ident, desc = params
+	ident = param(0)
+	desc = param(1)
 	%{
 		<tr>
-			<td><notextile>-#{ident[0..0]} (--#{ident})</notextile></td>
+			<td><code>-#{ident[0..0]}</code> (<code>--#{ident}</code>)</td>
 			<td>
 #{desc}
 			</td>
@@ -66,40 +69,79 @@ macro :option do
 end
 
 macro :values do
-	%{*Possible Values:* @#@value@}
+	%{*Possible Values:* @#{value}@}
 end
 
 macro :example do
-	%{*Example:* <code>#@value</code>}
+	%{<p><strong>Example:</strong> <code>#{value}</code></p>}
+end
+
+macro :block_example do
+	interpret %{
+		div[@class[example]
+			p[strong[Example]]
+			highlight[=html|
+#{value}
+			=]
+		]
+	}
 end
 
 macro :examples do
 	%{
-*Examples:* 
-#{@value.split("\n").map{|i| "@#{i}@\n"}.to_s}
+<div class="examples">
+<p><strong>Examples:</strong></p> 
+#{value.split("\n").map{|i| "<code>#{i}</code><br />"}.to_s}
+</div>
 	}
 end
 
 macro :aliases do
-	%{*Aliases:* @#@value@}
+	%{<strong>Aliases:</strong> <code>#{value}</code>}
 end
 
 macro :ref_macro do
-	m_name, m_value = params
+	m_name = raw_attr(:n)
+	m_value = raw_attr(:desc)
+	m_params = "parameters[#{raw_attr(:params)}]" if raw_attr(:params)
+	m_attrs = "attributes[#{raw_attr(:attrs)}]" if raw_attr(:attrs)
+	m_examples = "examples[#{raw_attr(:examples)}]" if raw_attr(:examples)
+	m_example = "example[#{raw_attr(:example)}]" if raw_attr(:example)
+	m_block_example = "block_example[#{raw_attr(:block_example)}]" if raw_attr(:block_example)
+	m_aliases = "aliases[#{raw_attr(:aliases)}]" if raw_attr(:aliases)
+	m_remarks = %{section[
+		@title[Remarks]
+		@notoc[:true]
+			txt[
+#{raw_attr(:remarks)}
+			]
+		]} if raw_attr(:remarks)
 	interpret %{
-	section[header[@#{m_name}@|m_#{m_name.gsub(/[^a-z0-1_-]/, '_')}]
+	section[
+		@title[<code>#{m_name}</code>]
+		@id[m_#{m_name.gsub(/[^a-z0-1_-]/, '_')}]
+		txt[
 #{m_value}
+		]
+#{m_aliases}
+#{m_example}
+#{m_block_example}
+#{m_examples}
+#{m_params}
+#{m_attrs}
+#{m_remarks}
 	]
 	}
 end
 
 macro :ref_config do
-	m_name, m_value = params
+	m_name = param(0)
+	m_value = param(1)
 	default = Glyph::SYSTEM_CONFIG.get(m_name).to_yaml.gsub(/^---/, '')
 	default = "nil" if default.blank?
 	interpret %{tr[
-		td[codeph[#{m_name}] #[s_#{m_name.gsub(/\./, '_')}]]
-		td[#{m_value}]
+		td[code[#{m_name}] #[s_#{m_name.gsub(/\./, '_').gsub(/\*/,'')}]]
+		td[txt[#{m_value}]]
 		td[
 			code[=
 #{default}
@@ -115,11 +157,22 @@ macro :config_table do
 				th[Description]
 				th[Default (YAML)]
 			]
-			#@value
+			#{value}
 		]}
 end
 
+macro :class do
+	if value.match /Glyph::/ then
+		path = "Glyph/#{value.gsub /Glyph::/, ''}"
+	else
+		path = value
+	end
+	interpret %{=>[&[yardoc]/#{path}|code[#{value}]]}
+end
+
 
 macro_alias :options => :parameters
+macro_alias :attributes => :parameters
 macro_alias '-p' => :ref_error
+macro_alias '-a' => :ref_error
 macro_alias '-o' => :option