glyph 0.5.1 → 0.5.2

data/book/text/stats/stats.glyph

@@ -2,7 +2,7 @@ def:[stats_for|
   section[
     @title[Displaying stats about {{title}}]
     txt[To display statistics about {{object}}, execute code[glyph stats {{command}}]. Glyph displays something like this:]
-    highlight[=html|
+    highlight[=plain|
 {{example}}
     =]
     section[

data/book/text/text_editing/code.glyph

@@ -3,7 +3,7 @@ If you're a programmer, chances are that you're going to include some source cod
 
 Cosider the following piece of ruby code:
   ]
-  highlight[=mediawiki|
+  highlight[=text|
 def find_child(&block)
   children.each do \|c\|
     c.descend do \|node, level\|
@@ -14,7 +14,7 @@ def find_child(&block)
 end
   =]
   p[It can be wrapped in a highlight macro, like so:]
-  highlight[=mediawiki|
+  highlight[=text|
 highlight[\=ruby\|
   def find_child(&block)
     children.each do \\\/\|c\\\/\|

data/book/text/text_editing/evaluation.glyph

@@ -8,14 +8,14 @@ As of version 0.5.0, Glyph can be considered _Turing-complete_, as it satisfies
 * A memory model which emulates an infinite store: there are no enforced limits on attribute/snippets allocations and number of algorithms or parameters.
   ]
 
-  §txt[
+  §[
     @title[Operations on integer values]
 
-Glyph can be used to perform operation on integer values (additions, subtractions and multiplications). For example, code[=\/add[2\|3\|7]=] will evaluate to @12@, and code[=\/multiply[add[3\|7]\|subtract[5\|1\|2]]=] will return 20.
+p[Glyph can be used to perform operation on integer values (additions, subtractions and multiplications). For example, code[=\/add[2\|3\|7]=] will evaluate to @12@, and code[=\/multiply[add[3\|7]\|subtract[5\|1\|2]]=] will return 20.]
 
-As a more complex example, consider the following @factorial@ macro, which is able to calculate the factorial of a number recursively:
+p[As a more complex example, consider the following @factorial@ macro, which is able to calculate the factorial of a number recursively:]
 
-highlight[=html|
+  highlight[=html|
 def:[factorial\|
   ?[
     eq[{{0}}\|0]\|1\|
@@ -24,9 +24,9 @@ def:[factorial\|
     ]
   ]
 ]
-=]
+  =]
 
-If you try executing code[=factorial[5]=], it will evaluate to @120@.
+p[If you try executing code[=factorial[5]=], it will evaluate to @120@.]
 
   ]
   §txt[

data/book/text/text_editing/inclusions.glyph

@@ -28,7 +28,7 @@ While including the context of an entire file is definitely a useful feature for
 
 Snippets can be defined using the %>[snippet:] (aliased by @&:@) and called by using the %>[snippet] (aliased by @&@). Consider the following simple example:
     ]
-    highlight[=html|
+    highlight[=plain|
 &:[markups\|Textile or Markdown]
 
 Glyph supports &[markups].
@@ -44,7 +44,7 @@ Snippets (or any other macro) can be nested within other snippets. Glyph takes c
     @id[fragments]
     txt[As an even simpler alternative to snippets, consider using _fragments_. The %>[fragment:] (aliased by @##@) can be used to mark a section of Glyph code as a fragment that can then be _embedded_ using the %>[embed] (aliased by @<=@), like this:]
     
-    highlight[=html|
+    highlight[=plain|
 Snippets and fragments ##[good_way\|are a good way to reuse] small chunks of content, while the include and load macros <=[good_way] entire files.
     =]
   ]

data/book/text/text_editing/links.glyph

@@ -9,7 +9,7 @@ If you care about link validation and you want to save some keystrokes, then you
 	]
 	box[Example|
 		p[&[gcode]]
-		highlight[=html|
+		highlight[=plain|
 This is a link to link[#test].
 ...
 This is link[#wrong].
@@ -23,7 +23,7 @@ This is a #[test\\\|test anchor].
 <p>This is a <a id="test">test anchor</a>.</p>
 		=]
 		p[Additionally, the following warning message is displayed when =>[#compile|compiling]:]
-		highlight[=html|
+		highlight[=plain|
 warning: Bookmark 'wrong' does not exist
  -> source: @: authoring.textile
  -> path: document/body/bodymatter/chapter/@/textile/section/section/box/link
@@ -37,7 +37,7 @@ Basically, if you use the %>[link] and the %>[anchor], Glyph makes sure that:
 
 Besides using the %>[anchor], you can also create an anchor for a header by passing an code[@id] attribute the the %>[section], like this: 
 	]
-	highlight[=html|
+	highlight[=plain|
 section[
   @title[My Section]
   @id[my_section]

data/config.yml

@@ -37,23 +37,27 @@
     :extension: .html
     :filter_target: html
     :macro_reps: html
+    :clean_source: true
   :html5:
     :multifile: false
     :extension: .html
     :filter_target: html
     :macro_reps: html5
+    :clean_source: true
   :pdf:
     :multifile: false
     :extension: .pdf
     :filter_target: html
     :through: html
-    :generator: wkhtmltopdf
+    :generator: prince
     :macro_reps: html
+    :clean_source: false
   :web:
     :multifile: true
     :extension: .html
     :filter_target: html
     :macro_reps: html
+    :clean_source: true
     :layout_dir: web
     :layouts:
       :topic: topic
@@ -64,6 +68,7 @@
     :extension: .html
     :filter_target: html
     :macro_reps: html5
+    :clean_source: true
     :layout_dir: web5
     :layouts:
       :topic: topic
@@ -74,6 +79,7 @@
     :extension: .epub
     :filter_target: html
     :generator: calibre
+    :clean_source: false
     :calibre:
       # See options at http://calibre-ebook.com/user_manual/cli/ebook-convert-3.html
       "output-profile": nook
@@ -83,6 +89,7 @@
     :extension: .mobi
     :filter_target: html
     :generator: calibre
+    :clean_source: false
     :calibre:
       # See options at http://calibre-ebook.com/user_manual/cli/ebook-convert-3.html
       "no-inline-toc":

data/glyph.gemspec

@@ -2,13 +2,13 @@
 
 Gem::Specification.new do |s|
   s.name = "glyph"
-  s.version = "0.5.1"
+  s.version = "0.5.2"
   s.summary = "Glyph -- A Ruby-powered Document Authoring Framework"
   s.description = "Glyph is a framework for structured document authoring."
   s.homepage = "http://www.h3rald.com/glyph/"
   s.authors = ["Fabio Cevasco"]
   s.email = "h3rald@h3rald.com"
-  s.date = "2011-11-04"
+  s.date = "2012-11-10"
   s.license = "MIT"
 
   s.files = ["Rakefile"]
@@ -32,15 +32,15 @@ Gem::Specification.new do |s|
   s.default_executable = "glyph"
   s.extra_rdoc_files = Dir.glob "*.textile"
  
-  s.add_runtime_dependency("gli", [">= 1.4.0"])
+  s.add_runtime_dependency("gli", [">= 2.4.1"])
   s.add_runtime_dependency("extlib", [">= 0.9.15"])
   s.add_runtime_dependency("rake", [">= 0.9.2.2"])
 
-  s.add_development_dependency("rspec", [">= 2.5.1"])
-  s.add_development_dependency("yard", [">= 0.7.4"])
+  s.add_development_dependency("rspec", [">= 2.11.0"])
+  s.add_development_dependency("yard", [">= 0.8.3"])
   s.add_development_dependency("directory_watcher", [">= 1.4.1"])
-  s.add_development_dependency("sass", [">= 3.1.11"])
+  s.add_development_dependency("sass", [">= 3.2.1"])
   s.add_development_dependency("RedCloth", [">= 4.2.9"])
   s.add_development_dependency("bluecloth", [">= 2.2.0"])
-  s.add_development_dependency("coderay", [">= 1.0.4"])
+  s.add_development_dependency("coderay", [">= 1.0.8"])
 end

data/lib/glyph.rb

@@ -72,7 +72,7 @@ module Glyph
 	class MutualInclusionError < MacroError; end
 
 	# The current version of Glyph
-	VERSION = "0.5.1"
+	VERSION = "0.5.2"
 
 	# All the currently-loaded macros
 	MACROS = {}
@@ -278,7 +278,7 @@ module Glyph
 			require 'glyph/commands'
 			self['system.quiet'] = true
 			self.library_mode = true
-			GLI.run ["compile", src.to_s, out].compact	
+			TOPLEVEL_BINDING.eval('self').run ["compile", src.to_s, out].compact	
 		rescue Exception => e
 			raise 
 		ensure

data/lib/glyph/commands.rb

@@ -1,20 +1,17 @@
 # encoding: utf-8
 
-include GLI
+include GLI::App
 
-GLI.desc "Enable debugging"
+version Glyph::VERSION
+program_desc "A rapid document authoring framework"
+
+d "Enable debugging"
 switch [:d, :debug]
 
-GLI.desc "Prints the version of the program"
-switch [:v, :version]
+d "Display documentation"
+switch [:h, :help]
 
-require Glyph::LIB/'commands/init'
-require Glyph::LIB/'commands/add'
-require Glyph::LIB/'commands/compile'
-require Glyph::LIB/'commands/config'
-require Glyph::LIB/'commands/todo'
-require Glyph::LIB/'commands/outline'
-require Glyph::LIB/'commands/stats'
+commands_from Glyph::LIB/"commands"
 
 Glyph.run 'load:tasks'
 Glyph.run 'load:commands'
@@ -26,11 +23,7 @@ pre do |global,command,options,args|
 	if global[:d] then
 		Glyph.debug_mode = true
 	end
-	if global[:v] || !command || command.name == :help then
-		puts "Glyph v#{Glyph::VERSION}"
-    puts
-	end
-	global[:v] ? false : true
+  true
 end
 
 post do |global,command,options,args|

data/lib/glyph/commands/add.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-GLI.desc 'Add a new text file to the project'
+d 'Add a new text file to the project'
 arg_name "file_name"
 command :add do |c|
 	c.action do |global_options,options,args|

data/lib/glyph/commands/compile.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-GLI.desc 'Compile the project'
+d 'Compile the project'
 arg_name "[source_file] [destination_file]"
 command :compile do |c|
 	c.desc "Specify a glyph file to compile (default: document.glyph)"

data/lib/glyph/commands/config.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-GLI.desc 'Get/set configuration settings'
+d 'Get/set configuration settings'
 arg_name "setting [new_value]"
 command :config do |c|
 	c.desc "Read from/Save to global configuration"

data/lib/glyph/commands/init.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-GLI.desc 'Create a new Glyph project'
+d 'Create a new Glyph project'
 command :init do |c|
 	c.action do |global_options,options,args|
 		Glyph.run 'project:create', Dir.pwd

data/lib/glyph/commands/outline.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-GLI.desc 'Display the document outline'
+d 'Display the document outline'
 command :outline do |c|
 	c.desc "Limit to level N"
 	c.flag :l, :level

data/lib/glyph/commands/stats.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-GLI.desc 'Display statistics'
+d 'Display statistics'
 command :stats do |c|
 	c.desc "Display stats about macros"
 	c.switch [:m, :macros]

data/lib/glyph/commands/todo.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-GLI.desc 'Display all project TODO items'
+d 'Display all project TODO items'
 command :todo do |c|
 	c.action do |global_options, options, args|
 		Glyph['system.quiet'] = true

data/lib/glyph/utils.rb

@@ -1,179 +1,204 @@
 # encoding: utf-8
 
 module Glyph
-	#@since 0.4.0
-	module Utils
-
-		# Prints a message
-		# @param [String] message the message to print
-		def msg(message)
-			puts message unless Glyph['system.quiet']
-		end
-
-		# Prints an informational message
-		# @param [String] message the message to print
-		def info(message)
-			puts "-- #{message}" unless Glyph['system.quiet']
-		end
-
-		# Prints a warning
-		# @param [String] message the message to print
-		def warning(message)
-			puts "-> warning: #{message}" unless Glyph['system.quiet']
-		end
-
-		# Prints an error
-		# @param [String] message the message to print
-		def error(message)
-			puts "=> error: #{message}" unless Glyph['system.quiet']
-		end
-
-		# Prints a message if running in debug mode
-		# @param [String] message the message to print
-		def debug(message)
-			puts message if Glyph.debug?
-		end
-
-		# Dumps and serialize an object to a YAML file
-		# @param [#to_s] file the file to write to
-		# @param [Object] obj the object to serialize
-		def yaml_dump(file, obj)
-			File.open(file.to_s, 'w+') {|f| f.write obj.to_yaml}
-		end
-
-		# Loads and deserialiaze the contents of a YAML file
-		# @param [#to_s] file the YAML file to load
-		# @return [Object] the contents of the YAML file, deserialized
-		def yaml_load(file)
-			YAML.load_file(file.to_s)
-		end
-
-		# Loads the contents of a file
-		# @param [#to_s] file the file to load
-		# @return [String] the contents of the file
-		def file_load(file)
-			result = ""
-			File.open(file.to_s, 'r:utf-8') do |f|
-				while l = f.gets 
-					result << l
-				end
-			end
-			result
-		end
-
-		# Writes a string to a file
-		# @param [#to_s] file the file to write
-		# @param [String] contents the string to write
-		# @return [String] the string written to the file
-		def file_write(file, contents="")
-			File.open(file.to_s, 'w+:utf-8') do |f|
-				f.print contents
-			end
-			contents
-		end
-
-		# An alias for FileUtils#cp
-		# @param [String] source the source file
-		# @param [String] dest the destination file or directory
-		# @param [Hash] options copy options
-		def file_copy(source, dest, options={})
-			FileUtils.cp source, dest, options
-		end
-
-		# Loads all child elements of the given directory, matching a given extension
-		# @param [Pathname] dir the directory containing the files
-		# @param [String] extension the file extension to check
-		# @yield [file, contents] the file (Pathname) and its contents
-		# @since 0.4.0
-		def load_files_from_dir(dir, extension, &block)
-			if dir.exist? then
-				dir.children.each do |c|
-					block.call(c, file_load(c)) unless c.directory? || c.extname != extension
-				end
-			end
-		end
-
-		# Iterates through the files in a source directory recursively
-		# @param [String] dir the directory to operate on (mirrored in the output directory)
-                # @yield [src, dest] the source file and the corresponding output file
-		# @since 0.4.0
-		def with_files_from(dir, &block)
-			output =  complex_output? ? 'tmp' : Glyph['document.output']
-			dir_path = Glyph::PROJECT/"output/#{output}/#{dir}"
-			dir_path.mkpath
-			(Glyph::PROJECT/dir).find do |i|
-				if i.file? then
-					dest = "#{Glyph::PROJECT/"output/#{output}/#{dir}"}/#{i.relative_path_from(Glyph::PROJECT/dir)}"
-					src = i.to_s
-					Pathname.new(dest).parent.mkpath
-					block.call src, dest
-				end
-			end
-		end
-
-		# Returns true if Glyph['document.output'] requires two or more conversions
-		# @since 0.5.0
-		def complex_output?
-			out = Glyph['document.output']
-			!Glyph["output.#{out}.generator"].blank? || !Glyph["output.#{out}.through"].blank?
-		end
-
-		# Returns true if the macro name is used as an alias
-		# @param [String, Symbol] name the macro name to check
-		def macro_alias?(name)
-			ALIASES[:by_alias].include? name.to_sym
-		end
-
-		# Returns the name of the macro definition referenced by the supplied alias
-		# @param [String, Symbol] name the alias name to check
-		def macro_definition_for(name)
-			ALIASES[:by_alias][name.to_sym]
-		end
-
-		# Returns the names of the macro aliases referencing the supplied definition
-		# @param [String, Symbol] name the macro name to check
-		def macro_aliases_for(name)
-			ALIASES[:by_def][name.to_sym]
-		end
-
-		# Returns a list of macro names corresponding to sections
-		# that commonly have a title
-		def titled_sections
-			(Glyph['system.structure.frontmatter']+
-			Glyph['system.structure.bodymatter']+
-			Glyph['system.structure.backmatter']+
-			[:section]).uniq
-		end
-
-		# Returns true if the macro names point to the same definition
-		# @param [String, Symbol] ident1 the first macro to compare
-		# @param [String, Symbol] ident2 the second macro to compare
-		def macro_eq?(ident1, ident2)
-			Glyph::MACROS[ident1.to_sym] == Glyph::MACROS[ident2.to_sym]
-		end
-
-		# Returns true if the PROJECT constant is set to a valid Glyph project directory
-		def project?
-			children = ["text", "config.yml", "document.glyph"].sort
-			actual_children = PROJECT.children.map{|c| c.basename.to_s}.sort 
-			(actual_children & children) == children
-		end
-
-		# Returns true if multiple output files are being generated
-		def multiple_output_files?
-			Glyph["output.#{Glyph['document.output']}.multifile"]
-		end
-
-		# Execute an external command
-		# @since 0.5.0
-		def run_external_command(cmd)
-			IO.popen(cmd+" 2>&1") do |pipe|
-				pipe.sync = true
-				while str = pipe.gets do
-					puts str
-				end
-			end
-		end
-
-	end
+  #@since 0.4.0
+  module Utils
+
+    # Prints a message
+    # @param [String] message the message to print
+    def msg(message)
+      puts message unless Glyph['system.quiet']
+    end
+
+    # Prints an informational message
+    # @param [String] message the message to print
+    def info(message)
+      puts "-- #{message}" unless Glyph['system.quiet']
+    end
+
+    # Prints a warning
+    # @param [String] message the message to print
+    def warning(message)
+      puts "-> warning: #{message}" unless Glyph['system.quiet']
+    end
+
+    # Prints an error
+    # @param [String] message the message to print
+    def error(message)
+      puts "=> error: #{message}" unless Glyph['system.quiet']
+    end
+
+    # Prints a message if running in debug mode
+    # @param [String] message the message to print
+    def debug(message)
+      puts message if Glyph.debug?
+    end
+
+    # Dumps and serialize an object to a YAML file
+    # @param [#to_s] file the file to write to
+    # @param [Object] obj the object to serialize
+    def yaml_dump(file, obj)
+      File.open(file.to_s, 'w+') {|f| f.write obj.to_yaml}
+    end
+
+    # Loads and deserialiaze the contents of a YAML file
+    # @param [#to_s] file the YAML file to load
+    # @return [Object] the contents of the YAML file, deserialized
+    def yaml_load(file)
+      YAML.load_file(file.to_s)
+    end
+
+    # Loads the contents of a file
+    # @param [#to_s] file the file to load
+    # @return [String] the contents of the file
+    def file_load(file)
+      result = ""
+      File.open(file.to_s, 'r:utf-8') do |f|
+        while l = f.gets 
+          result << l
+        end
+      end
+      result
+    end
+
+    # Writes a string to a file
+    # @param [#to_s] file the file to write
+    # @param [String] contents the string to write
+    # @return [String] the string written to the file
+    def file_write(file, contents="")
+      File.open(file.to_s, 'w+:utf-8') do |f|
+        f.print contents
+      end
+      contents
+    end
+
+    # An alias for FileUtils#cp
+    # @param [String] source the source file
+    # @param [String] dest the destination file or directory
+    # @param [Hash] options copy options
+    def file_copy(source, dest, options={})
+      FileUtils.cp source, dest, options
+    end
+
+    # Loads all child elements of the given directory, matching a given extension
+    # @param [Pathname] dir the directory containing the files
+    # @param [String] extension the file extension to check
+    # @yield [file, contents] the file (Pathname) and its contents
+    # @since 0.4.0
+    def load_files_from_dir(dir, extension, &block)
+      if dir.exist? then
+        dir.children.each do |c|
+          block.call(c, file_load(c)) unless c.directory? || c.extname != extension
+        end
+      end
+    end
+
+    # Iterates through the files in a source directory recursively
+    # @param [String] dir the directory to operate on (mirrored in the output directory)
+    # @yield [src, dest] the source file and the corresponding output file
+    # @since 0.4.0
+    def with_files_from(dir, &block)
+      output =  complex_output? ? 'tmp' : Glyph['document.output']
+      dir_path = Glyph::PROJECT/"output/#{output}/#{dir}"
+      dir_path.mkpath
+      (Glyph::PROJECT/dir).find do |i|
+        if i.file? then
+          dest = "#{Glyph::PROJECT/"output/#{output}/#{dir}"}/#{i.relative_path_from(Glyph::PROJECT/dir)}"
+          src = i.to_s
+          Pathname.new(dest).parent.mkpath
+          block.call src, dest
+        end
+      end
+    end
+
+    # Returns the value of a setting referred to the current output format
+    # @param [String, Symbol] the name of the setting to retrieve
+    # @since 0.6.0
+    def current_output_setting(setting)
+      Glyph["output.#{Glyph['document.output']}.#{setting}"]
+    end
+
+    # Returns true if Glyph['document.output'] requires two or more conversions
+    # @since 0.5.0
+    def complex_output?
+      out = Glyph['document.output']
+      !Glyph["output.#{out}.generator"].blank? || !Glyph["output.#{out}.through"].blank?
+    end
+
+    # Returns true if the macro name is used as an alias
+    # @param [String, Symbol] name the macro name to check
+    def macro_alias?(name)
+      ALIASES[:by_alias].include? name.to_sym
+    end
+
+    # Returns the name of the macro definition referenced by the supplied alias
+    # @param [String, Symbol] name the alias name to check
+    def macro_definition_for(name)
+      ALIASES[:by_alias][name.to_sym]
+    end
+
+    # Returns the names of the macro aliases referencing the supplied definition
+    # @param [String, Symbol] name the macro name to check
+    def macro_aliases_for(name)
+      ALIASES[:by_def][name.to_sym]
+    end
+
+    # Returns a list of macro names corresponding to sections
+    # that commonly have a title
+    def titled_sections
+      (Glyph.macro_aliases_for(:section)+
+       [:section]-[:frontmatter, :bodymatter, :backmatter]).uniq
+    end
+
+    # Returns true if the macro names point to the same definition
+    # @param [String, Symbol] ident1 the first macro to compare
+    # @param [String, Symbol] ident2 the second macro to compare
+    def macro_eq?(ident1, ident2)
+      Glyph::MACROS[ident1.to_sym] == Glyph::MACROS[ident2.to_sym]
+    end
+
+    # Returns true if the PROJECT constant is set to a valid Glyph project directory
+    def project?
+      children = ["text", "config.yml", "document.glyph"].sort
+      actual_children = PROJECT.children.map{|c| c.basename.to_s}.sort 
+      (actual_children & children) == children
+    end
+
+    # Returns true if multiple output files are being generated
+    def multiple_output_files?
+      Glyph["output.#{Glyph['document.output']}.multifile"]
+    end
+
+    # Execute an external command
+    # @since 0.5.0
+    def run_external_command(cmd)
+      IO.popen(cmd+" 2>&1") do |pipe|
+        pipe.sync = true
+        while str = pipe.gets do
+          puts str
+        end
+      end
+    end
+
+    # Re-indents source code and removes unnecessary spacing 
+    # @param [String] the XML document to clean up
+    # @since 0.6.0
+    def clean_xml_document(doc)
+      return doc unless current_output_setting :clean_source
+      begin
+        require 'nokogiri'
+      rescue Exception
+        warning "Cannot clean source because Nokogiri is not installed. Please run: gem install nokogiri"
+        return doc
+      end
+      begin
+        Nokogiri.XML(doc.to_s, &:noblanks).to_xml :indent => 2
+      rescue Exception => e
+        warning "Unable to clean up source"
+        debug e.message
+        debug e.backtrace.join("\n")
+        doc
+      end
+    end
+  end
 end