glyph 0.1.0 → 0.2.0

data/AUTHORS.textile

@@ -0,0 +1,8 @@
+Glyph was designed and developed by <a href="http://www.h3rald.com">Fabio Cevasco</a> (h3rald).
+
+Special thanks to the following individuals who contributed to Glyph by reporting and fixing issues and/or proposing and implementing new features:
+* <a href="http://www.jabbslad.com">Jamie Atkinson</a> (Jabbslad)
+* <a href="http://koraktor.github.com">Sebastian Staudt</a> (koraktor)
+
+
+    

data/CHANGELOG.textile

@@ -0,0 +1,260 @@
+
+
+		<div class="section">
+<h2 id="h_1">v0.2.0 &ndash; May 9th 2010</h2>
+			<div class="section">
+<h3 id="h_2">11 Features Implemented</h3>
+			<table>
+<tr>
+<th>ID</th>
+					<th>Description</th>	
+</tr>
+				<tr>
+<td>
+<a href="http://github.com/h3rald/glyph/issues/closed#issue/62">#62</a>
+
+</td>
+			<td>
+<p>A new highlight macro is available to highlight source code (CodeRay or UltraViolet requireed).</p>
+
+</td>	
+</tr>
+	
+		
+		<tr>
+<td>
+<a href="http://github.com/h3rald/glyph/issues/closed#issue/76">#76</a>
+
+</td>
+			<td>
+<p>It is now possible to use Glyph programmatically via the new <code>Glyph#filter</code> and <code>Glyph#compile</code> methods.</p>
+
+</td>	
+</tr>
+	
+		
+		<tr>
+<td>
+<a href="http://github.com/h3rald/glyph/issues/closed#issue/87">#87</a>
+
+</td>
+			<td>
+<p>It is now possible to define snippets inside a Glyph source file using the snippet: macro.</p>
+
+</td>	
+</tr>
+		
+		
+		<tr>
+<td>
+<a href="http://github.com/h3rald/glyph/issues/closed#issue/88">#88</a>
+
+</td>
+			<td>
+<p>It is now possible to change configuration settings inside a Glyph source file using the config: macro macro (Jabbslad).</p>
+
+</td>	
+</tr>
+		
+		
+		<tr>
+<td>
+<a href="http://github.com/h3rald/glyph/issues/closed#issue/89">#89</a>
+
+</td>
+			<td>
+<p>It is now possible to compile a single Glyph source file without creating a Glyph project.</p>
+
+</td>	
+</tr>
+	
+		
+		<tr>
+<td>
+<a href="http://github.com/h3rald/glyph/issues/closed#issue/92">#92</a>
+
+</td>
+			<td>
+<p>6 new macros have been defined to allow conditional processing (condition macro, eq macro, not macro, and macro, or macro, match macro)</p>
+
+</td>	
+</tr>
+	
+		
+		<tr>
+<td>
+<a href="http://github.com/h3rald/glyph/issues/closed#issue/94">#94</a>
+
+</td>
+			<td>
+<p>It is now possible to add <em>validators</em> to macros, for example to check the number of parameters they take.</p>
+
+</td>	
+</tr>
+	
+		
+		<tr>
+<td>
+<a href="http://github.com/h3rald/glyph/issues/closed#issue/97">#97</a>
+
+</td>
+			<td>
+<p>The compile command command can now take an extra <code>--auto</code> switch to trigger document auto-regeneration whenever a source file is changed (koraktor).</p>
+
+</td>	
+</tr>
+	
+		
+		<tr>
+<td>
+<a href="http://github.com/h3rald/glyph/issues/closed#issue/99">#99</a>
+
+</td>
+			<td>
+<p>Added a <code>document.draft</code> setting. If set to <code>true</code>, comments and TODOs are rendered in output files.</p>
+
+</td>	
+</tr>
+	
+		
+		<tr>
+<td>
+<a href="http://github.com/h3rald/glyph/issues/closed#issue/100">#100</a>
+
+</td>
+			<td>
+<p><a id="system_css"></a>Glyph <span class="caps">CSS</span> files are no longer copied to new projects, but they can be referenced as if they were (see also <a href="#css_not_copied">#93</a>).</p>
+
+</td>	
+</tr>
+	
+		
+		<tr>
+<td>
+<a href="http://github.com/h3rald/glyph/issues/closed#issue/108">#108</a>
+
+</td>
+			<td>
+<p>It is now possible to define Glyph macros within Glyph source files using the macro: macro.</p>
+
+</td>	
+</tr>
+</table>
+
+</div>
+	
+	
+		<div class="section">
+<h3 id="h_3">8 Bugs Fixed</h3>
+			<table>
+<tr>
+<th>ID</th>
+					<th>Description</th>	
+</tr>
+				<tr>
+<td>
+<a href="http://github.com/h3rald/glyph/issues/closed#issue/86">#86</a>
+
+</td>
+			<td>
+<p>Warning and error messages have been updated, and it is now possible to show additional debug information. Additionally, syntax errors are now handled before the document is processed.</p>
+
+</td>	
+</tr>
+	
+		
+		<tr>
+<td>
+<a href="http://github.com/h3rald/glyph/issues/closed#issue/93">#93</a>
+
+</td>
+			<td>
+<p><a id="css_not_copied"></a>Default css files were not copied when creating a new project. The issue has been resolved by allowing the style macro to reference Glyph&#8217;s system styles (see also <a href="#system_css">#100</a>).</p>
+
+</td>	
+</tr>
+	
+		
+		<tr>
+<td>
+<a href="http://github.com/h3rald/glyph/issues/closed#issue/95">#95</a>
+
+</td>
+			<td>
+<p>The config command did not save data to <span class="caps">YAML</span> configuration files. This has been fixed ensuring that internal configuration overrides are not saved to the <span class="caps">YAML</span> file too.</p>
+
+</td>	
+</tr>
+	
+		
+		<tr>
+<td>
+<a href="http://github.com/h3rald/glyph/issues/closed#issue/98">#98</a>
+
+</td>
+			<td>
+<p>Glyph is now fully compatible with Ruby 1.9.1 and JRuby 1.4.0.</p>
+
+</td>	
+</tr>
+	
+		
+		<tr>
+<td>
+<a href="http://github.com/h3rald/glyph/issues/closed#issue/101">#101</a>
+
+</td>
+			<td>
+<p>Additional tests have been developed to improve Textile support. There should no longer be errors when using textile block elements inside Glyph macros.</p>
+
+</td>	
+</tr>
+	
+		
+		<tr>
+<td>
+<a href="http://github.com/h3rald/glyph/issues/closed#issue/103">#103</a>
+
+</td>
+			<td>
+<p>Fixed a bug that caused test failures when deleting the test project directory.</p>
+
+</td>	
+</tr>
+	
+		
+		<tr>
+<td>
+<a href="http://github.com/h3rald/glyph/issues/closed#issue/104">#104</a>
+
+</td>
+			<td>
+<p>Nested Glyph macros calling <code>Macro#interpret</code> no longer ignore escape delimiters.</p>
+
+</td>	
+</tr>
+	
+		
+		<tr>
+<td>
+<a href="http://github.com/h3rald/glyph/issues/closed#issue/107">#107</a>
+
+</td>
+			<td>
+<p>Added the possibility to encode (using the encode macro) and decode (using the decode macro) macros so that they can be interpreted later.</p>
+
+</td>	
+</tr>
+</table>
+
+</div>
+
+</div>
+	
+
+		<div class="section">
+<h2 id="h_4">v0.1.0 &ndash; April 8th 2010</h2>
+			Initial release.
+
+</div>
+	

data/LICENSE.textile

@@ -0,0 +1,26 @@
+Copyright (c) 2010 **Fabio Cevasco**, <a href="http://www.h3rald.com">http://www.h3rald.com</a>  
+
+
+<div class="code">
+<pre>
+<code>
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+</code>
+</pre>
+</div>

data/README.textile

@@ -1,8 +1,9 @@
 Glyph is a _Rapid Document Authoring Framework_. 
 
-Think of it like a sort of "Ruby On Rails":http://www.rubyonrails.org but for creating text documents instead of web sites. With Glyph, you can manage your documents tidily in _projects_ that can be used to generate deliverables in different formats such as HTML or PDF (through "Prince":http://www.princexml.com).
+Think of it like a sort of <a href="http://www.rubyonrails.org">Ruby on Rails</a> but for creating text documents instead of web sites. With Glyph, you can manage your documents tidily in _projects_ that can be used to generate deliverables in different formats such as HTML or PDF (through <a href="http://www.princexml.com/">Prince</a>).
 
-h3. Main Features
+<div class="section">
+<h2 id="h_1">Main Features</h2>
 
 Glyph uses a simple macro system to perform a wide variety of advanced tasks:
 * Generate block-level HTML tags not commonly managed by lightweight markups, like @head@, @body@, @div@ and @table@.
@@ -13,32 +14,45 @@ Glyph uses a simple macro system to perform a wide variety of advanced tasks:
 * Store common snippets of text in a single YAML file and use them anywhere in your document, as many times as you need.
 * Store configuration settings in a YAML file and use them anywhere in your document, as many times as you need.
 * Evaluate Ruby code within your document.
-* Call macros from other macros (including snippets), carefully avoiding mutual calls.
+* Call macros from other macros (including snippets), avoiding mutual calls.
 * Include text files in other text files.
-* Include the contents of configuration settings (author, title) in the document.
+* Include the value of any configuration setting (like author, title) in the document.
 * Filter input explicitly or implicitly, based on file extensions when including files. 
 * Manage comments and todo items.
 
-h3. Installation
+</div>
+
+<div class="section">
+<h2 id="h_2">Installation</h2>
 
 @gem install glyph@ -- simple, as always.
 
-h3. Essential Glyph Commands
+</div>
+
+<div class="section">
+<h2 id="h_3">Essential Glyph commands</h2>
 
-Glyph is 100% command line. Its interface "Git's":http://git-scm.com/ for its simplicity and power (thanks to the "Gli":http://github.com/davetron5000/gli gem). Here are some example commands: 
+Glyph is 100% command line. Its interface resambles <a href="http://git-scm.com/">Git's</a> for its simplicity and power (thanks to the <a href="http://github.com/davetron5000/gli">gli</a> gem). Here are some example commands: 
 
 * @glyph init@ -- to initialize a new Glyph project in the current (empty) directory.
 * @glyph add introduction.textile@ -- to create a new file called _introduction.textile_.
 * @glyph compile@ -- to compile the current document into a single HTML file.
-* @glyph compile -f pdf@ -- to compile the current document into HTML and then transform it into PDF using "Prince":http://www.princexml.com.
+* @glyph compile -f pdf@ -- to compile the current document into HTML and then transform it into PDF using <a href="http://www.princexml.com/">Prince</a>.
+* @glyph compile readme.glyph@ -- to compile a _readme.glyph_ located in the current directory into a single HTML file.
 
-h3. Glyph macros in a nutshell
+</div>
+
+<div class="section">
+<h2 id="macros_nutshell">Glyph macros in a nutshell</h2>
 
 Format your documents using Textile or Markdown, and use Glyph Macros to do everything else:
 
 **Glyph Source:**
 
-<pre><code>
+
+<div class="code">
+<pre>
+<code>
 section[header[Something about Glyph]
 You can use Glyph macros in conjunction
  with _Textile_ or _Markdown_ to
@@ -50,13 +64,18 @@ extremely easy with a 3rd-party
 renderer like =>[http://www.princexml.com|Prince].
   ]   
 ]
-</code></pre>
+</code>
+</pre>
+</div>
 
 **HTML Output:**
 
-<pre><code>
+
+<div class="code">
+<pre>
+<code>
 <div class="section">
-  <h2 id="h_1">Something about Glyph</h2>
+  <h2 id="h_10">Something about Glyph</h2>
   <p>You can use Glyph macros in conjunction with 
      <em>Textile</em> or <em>Markdown</em> to
      produce HTML files effortlessly.</p>
@@ -68,13 +87,22 @@ renderer like =>[http://www.princexml.com|Prince].
       like <a href="http://www.princexml.com">Prince</a>.</p>
   </div>
 </div>
-</code></pre>
+</code>
+</pre>
+</div>
 
-h3. Resources
+</div>
 
-* Home Page: "http://www.h3rald.com/glyph/":http://www.h3rald.com/glyph/
-* Repository: "http://www.github.com/h3rald/glyph/":http://www.github.com/h3rald/glyph/
-* Bug Tracking: "http://www.github.com/h3rald/glyph/issues":http://www.github.com/h3rald/glyph/issues
-* Book (PDF): "http://github.com/h3rald/glyph/tree/master/book/output/pdf/glyph.pdf":http://github.com/h3rald/glyph/tree/master/book/output/pdf/glyph.pdf
-* Reference Documentation: "http://yardoc.org/docs/h3rald-glyph/":http://yardoc.org/docs/h3rald-glyph/
-* User Group: "http://groups.google.com/group/glyph-framework":http://groups.google.com/group/glyph-framework
+<div class="section">
+<h2 id="h_5">Resources</h2>
+
+* Home Page: <a href="http://www.h3rald.com/glyph/">http://www.h3rald.com/glyph/</a>
+* Repository: <a href="http://www.github.com/h3rald/glyph/">http://www.github.com/h3rald/glyph/</a>
+* Bug Tracking: <a href="http://www.github.com/h3rald/glyph/issues">http://www.github.com/h3rald/glyph/issues</a>
+* Development Wiki <a href="http://wiki.github.com/h3rald/glyph">http://wiki.github.com/h3rald/glyph</a>
+* RubyGem Download <a href="http://www.rubygems.org/gems/glyph">http://www.rubygems.org/gems/glyph</a>
+* Book (PDF): <a href="http://github.com/h3rald/glyph/raw/0.1.0/book/output/pdf/glyph.pdf">http://github.com/h3rald/glyph/raw/0.1.0/book/output/pdf/glyph.pdf</a>
+* Reference Documentation: <a href="http://yardoc.org/docs/h3rald-glyph/">http://yardoc.org/docs/h3rald-glyph/</a>
+* User Group: <a href="http://groups.google.com/group/glyph-framework">http://groups.google.com/group/glyph-framework</a>
+
+</div>

data/Rakefile

@@ -9,7 +9,7 @@ task :default => :spec
 begin
 	require 'yard'
 	YARD::Rake::YardocTask.new(:yardoc) do |t|
-		t.files   = ['lib/**/*.rb', 'README.textile', 'lib/*.rb'] 
+		t.files   = ['lib/**/*.rb', './README.textile', 'lib/*.rb'] 
 		t.options = ['--no-private']
 	end
 rescue LoadError
@@ -27,12 +27,21 @@ begin
 		s.email = "h3rald@h3rald.com"
 		s.homepage = "http://www.h3rald.com/glyph/"
 		s.authors = ["Fabio Cevasco"]
-		s.add_dependency 'gli', '>= 0.3.1'
-		s.add_dependency 'extlib', '>= 0.9.12'
-		s.add_dependency 'treetop', '>= 0.4.3'
-		s.add_dependency 'rake', '>= 0.8.7'
-		s.add_development_dependency 'rspec'
-		s.add_development_dependency 'yard'
+		s.files.include "styles/**/*"
+		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 '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
@@ -43,6 +52,7 @@ begin
 	require 'spec/rake/spectask'
 	Spec::Rake::SpecTask.new('spec') do |t|
 		t.spec_files = FileList['spec/**/*_spec.rb']
+		t.spec_opts = ["--color"]
 	end
 rescue LoadError
 	puts "RSpec is not available. Install it with: gem install rspec"