glyph 0.4.2 → 0.5.0

data/layouts/web5/topic.glyph

@@ -4,7 +4,7 @@ document[
 	]
 	body[
 		@class[topic]
-		=article[
+		xml/article[
 			section[
 				@title[{{title}}]
 				@id[{{id}}]

data/lib/glyph.rb

@@ -1,6 +1,7 @@
 # Copyright (c) 2009-2010 Fabio Cevasco
 # website: http://www.h3rald.com/glyph
 # license: MIT
+# encoding: utf-8
 
 require 'rubygems'
 require 'pathname'
@@ -31,7 +32,6 @@ module Glyph
 	require LIB/'bookmark'
 	require LIB/'document'
 	require LIB/'macro_validators'
-	require LIB/'macro_helpers'
 	require LIB/'macro'
 	require LIB/'syntax_node'
 	require LIB/'parser'
@@ -40,8 +40,13 @@ module Glyph
 	require LIB/'reporter'
 	extend Glyph::Utils
 
+  # A generic Glyph error.
 	class Error < RuntimeError; end
+  
+  # A syntax error.
 	class SyntaxError < Error; end
+
+  # A macro error.
 	class MacroError < Error
 		include Glyph::Utils
 		attr_reader :macro
@@ -62,17 +67,19 @@ module Glyph
 			msg "#{"-"*54}\n#{@macro.node.to_s.gsub(/\t/, ' ')}\n#{"-"*54}" if Glyph.debug?
 		end
 	end
+  
+  # An infinite recursion error
 	class MutualInclusionError < MacroError; end
 
 	# The current version of Glyph
-	VERSION = file_load(HOME/'VERSION').strip
-
-	# All the currently-loaded snippets
-	SNIPPETS = {}
+	VERSION = "0.5.0"
 
 	# All the currently-loaded macros
 	MACROS = {}
 
+	# All the currently-loaded macro representations
+	REPS = {}
+
 	# All macro aliases
 	ALIASES = {:by_alias => {}, :by_def => {}}
 
@@ -110,10 +117,13 @@ module Glyph
 	CONFIG = Glyph::Config.new :resettable => true, :mutable => false
 
 	home_dir = Pathname.new(RUBY_PLATFORM.match(/win32|mingw/) ? ENV['HOMEPATH'] : ENV['HOME'])
+  # System configuration
 	SYSTEM_CONFIG = 
 		Glyph::Config.new(:file => HOME/'config.yml')
+  # Global configuration
 	GLOBAL_CONFIG = 
 		Glyph.test? ? Glyph::Config.new(:file => SPEC_DIR/'.glyphrc') : Glyph::Config.new(:file => home_dir/'.glyphrc')
+  # Project configuration
 	PROJECT_CONFIG = 
 		Glyph::Config.new(:file => PROJECT/'config.yml', :resettable => true) rescue Glyph::Config.new(:resettable => true, :mutable => true)
 
@@ -168,7 +178,7 @@ module Glyph
 		self.enable_all
 		self.config_reset
 		MACROS.clear
-		SNIPPETS.clear
+		REPS.clear
 	end
 
 	# Reenables all Glyph Rake tasks
@@ -203,11 +213,34 @@ module Glyph
 		MACROS[name.to_sym] = block
 	end
 
-	#@since 0.4.0
-	# Creates a new macro by rewriting.
+	# Defines a new macro representation
+	# @since 0.5.0
+	# @param [Symbol, String] name the name of the macro
+	def self.rep(name, &block)
+		REPS[name.to_sym] = block
+		# Mirror aliases as well
+		ALIASES[:by_def][name.to_sym].to_a.each { |a| REPS[a] = block }
+	end
+
+	# Loads macro representations for a given output
+	# @since 0.5.0
+	# @param [Symbol, String] output a valid output format
+	def self.reps_for(output)
+		Glyph.instance_eval file_load(Glyph::HOME/"macros/reps/#{output}.rb") rescue nil
+	end
+
+	# Loads project macro representations for a given output
+	# @since 0.5.0
+	# @param [Symbol, String] output a valid output format
+	def self.project_reps_for(output)
+		Glyph.instance_eval file_load(Glyph::PROJECT/"lib/macros/reps/#{output}.rb") rescue nil
+	end
+
+	#@since 0.5.0
+	# Defines a new macro in Glyph code.
 	# @param [Symbol, String] name the name of the macro
 	# @param [String] text the Glyph code used to define the macro
-	def self.rewrite(name, text)
+	def self.define(name, text)
 		macro name do
 			body = text.dup
 			# Parameters
@@ -283,7 +316,6 @@ module Glyph
 		result
 	end
 
-
 end
 
 Glyph.setup

data/lib/glyph/analyzer.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Glyph
 
 	# @since 0.4.0
@@ -186,7 +188,8 @@ module Glyph
 		def stats_snippets
 			c = @stats[:snippets] = {}
 			snippets = {}
-			c[:definitions] = Glyph::SNIPPETS.keys.sort
+			c[:definitions] = @doc.snippets.keys.sort
+			c[:values] = @doc.snippets
 			c[:used] = []
 			c[:unused] = []
 			c[:total] = 0
@@ -204,7 +207,7 @@ module Glyph
 		def stats_snippet(name)
 			name = name.to_sym
 			snippets = {}
-			raise ArgumentError, "Snippet '#{name}' does not exist" unless Glyph::SNIPPETS[name]
+			raise ArgumentError, "Snippet '#{name}' does not exist" unless @doc.snippet? name
 			with_macros(:snippet) do |n|
 				code = n.parameters[0].to_s.to_sym
 				if code == name then

data/lib/glyph/bookmark.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Glyph
 
 	# @since 0.4.0
@@ -31,7 +33,7 @@ module Glyph
 
 		# Returns true if the two bookmarks have the same ID and file
 		# @param [Glyph::Bookmark] b the bookmark to compare
-		# @raises [RuntimeError] if the parameter supplied is not a bookmark
+		# @raise [RuntimeError] if the parameter supplied is not a bookmark
 		def ==(b)
 			raise RuntimeError, "#{b.inspect} is not a bookmark" unless b.is_a? Glyph::Bookmark
 			self.code == b.code && self.file == b.file

data/lib/glyph/commands.rb

@@ -1,9 +1,13 @@
-include GLI
+# encoding: utf-8
 
+include GLI
 
 GLI.desc "Enable debugging"
 switch [:d, :debug]
 
+GLI.desc "Prints the version of the program"
+switch [:v, :version]
+
 require Glyph::LIB/'commands/init'
 require Glyph::LIB/'commands/add'
 require Glyph::LIB/'commands/compile'
@@ -17,17 +21,16 @@ Glyph.run 'load:commands'
 
 pre do |global,command,options,args|
 	# Pre logic here
-	# Return true to proceed; false to abourt and not call the
+	# Return true to proceed; false to abort and not call the
 	# chosen command
 	if global[:d] then
 		Glyph.debug_mode = true
 	end
-	if !command || command.name == :help then
-		puts "====================================="
+	if global[:v] || !command || command.name == :help then
 		puts "Glyph v#{Glyph::VERSION}"
-		puts "====================================="
+    puts
 	end
-	true
+	global[:v] ? false : true
 end
 
 post do |global,command,options,args|
@@ -38,10 +41,9 @@ on_error do |exception|
 	raise if Glyph.library?
 	if exception.is_a? Glyph::MacroError then
 		exception.display
-		false
 	else
+		Glyph.warning exception.message
 		if Glyph.debug? then
-			Glyph.warning exception.message
 			puts "\n"+"-"*20+"[ Backtrace: ]"+"-"*20
 			puts "Backtrace:"
 			exception.backtrace.each do |b|
@@ -49,6 +51,6 @@ on_error do |exception|
 			end
 			Glyph.debug_mode = false
 		end
-		true
 	end
+	false
 end

data/lib/glyph/commands/add.rb

@@ -1,8 +1,10 @@
+# encoding: utf-8
+
 GLI.desc 'Add a new text file to the project'
 arg_name "file_name"
 command :add do |c|
 	c.action do |global_options,options,args|
-		raise ArgumentError, "Please specify a file name." if args.blank?
+		exit_now! "Please specify a file name.", -20 if args.blank?
 		Glyph.run 'project:add', args[0]
 	end
 end

data/lib/glyph/commands/compile.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 GLI.desc 'Compile the project'
 arg_name "[source_file] [destination_file]"
 command :compile do |c|
@@ -8,7 +10,7 @@ command :compile do |c|
 	c.desc "Auto-regenerate output on file changes"
 	c.switch [:a, :auto]
 	c.action do |global_options, options, args|
-		raise ArgumentError, "Too many arguments" if args.length > 2
+		exit_now! "Too many arguments", -12 if args.length > 2
 		Glyph.lite_mode = true unless args.blank? 
 		Glyph.run! 'load:config'
 		original_config = Glyph::CONFIG.dup
@@ -18,14 +20,15 @@ command :compile do |c|
 		target = Glyph['document.output']
 		target = nil if target.blank?
 		target ||= Glyph["output.#{Glyph['document.output']}.filter_target"]
+		through = Glyph["output.#{target}.through"]
 		Glyph['document.source'] = options[:s] if options[:s]
 		if Glyph.multiple_output_files? then
 			Glyph["output.#{Glyph['document.output']}.base"] = Glyph::PROJECT/"output/#{Glyph['document.output']}/".to_s if Glyph["output.#{Glyph['document.output']}.base"].blank?
 		else
 			Glyph["output.#{Glyph['document.output']}.base"] = ""
 		end
-		raise ArgumentError, "Output target not specified" unless target
-		raise ArgumentError, "Unknown output target '#{target}'" unless output_targets.include? target.to_sym
+		exit_now! "Output target not specified", -30 unless target
+		exit_now! "Unknown output target '#{target}'", -31 unless output_targets.include? target.to_sym
 
 		# Lite mode
 		if Glyph.lite? then
@@ -35,15 +38,15 @@ command :compile do |c|
 			src_extension = Regexp.escape(source_file.extname) 
 			dst_extension = "."+Glyph['document.output']
 			destination_file ||= Pathname.new(source_file.to_s.gsub(/#{src_extension}$/, dst_extension))
-			raise ArgumentError, "Source file '#{source_file}' does not exist" unless source_file.exist? 
-			raise ArgumentError, "Source and destination file are the same" if source_file.to_s == destination_file.to_s
+			exit_now! "Source file '#{source_file}' does not exist", -32 unless source_file.exist? 
+			exit_now! "Source and destination file are the same", -33 if source_file.to_s == destination_file.to_s
 			Glyph['document.filename'] = filename
 			Glyph['document.source'] = source_file.to_s
 			Glyph['document.output_dir'] = destination_file.parent.to_s # System use only
 			Glyph['document.output_file'] = destination_file.basename.to_s # System use only
 		end
 		begin
-			Glyph.run "generate:#{target}"
+			Glyph.run "generate:#{target}#{through ? "_through_#{through}" : ""}"
 		rescue Exception => e
 			message = e.message
 			if Glyph.debug? then
@@ -61,7 +64,7 @@ command :compile do |c|
 			begin
 				require 'directory_watcher'
 			rescue LoadError
-				raise RuntimeError, "DirectoryWatcher is not available. Install it with: gem install directory_watcher"
+				exit_now! "DirectoryWatcher is not available. Install it with: gem install directory_watcher", -34
 			end
 			Glyph.info 'Auto-regeneration enabled'
 			Glyph.info 'Use ^C to interrupt'

data/lib/glyph/commands/config.rb

@@ -1,7 +1,9 @@
+# encoding: utf-8
+
 GLI.desc 'Get/set configuration settings'
 arg_name "setting [new_value]"
 command :config do |c|
-	c.desc "Save to global configuration"
+	c.desc "Read from/Save to global configuration"
 	c.switch [:g, :global]
 	c.action do |global_options,options,args|
 		Glyph.run 'load:config'
@@ -12,14 +14,14 @@ command :config do |c|
 		end
 		case args.length
 		when 0 then
-			raise ArgumentError, "Too few arguments."
+			exit_now! "Too few arguments.", -10
 		when 1 then # read current config
 			setting = Glyph[args[0]]
-			raise RuntimeError, "Unknown setting '#{args[0]}'" if setting.blank?
+			exit_now! "Unknown setting '#{args[0]}'", -11 if setting == nil
 			Glyph.info setting.inspect
 		when 2 then
 			if args[0].match /^system\..+/ then
-				Glyph.warning "Cannot reset '#@value' setting (system use only)."
+				exit_now! "Cannot reset '#@value' setting (system use only).", -11
 			else
 				# Remove all overrides
 				Glyph.config_reset
@@ -32,7 +34,7 @@ command :config do |c|
 				Glyph.config_refresh
 			end
 		else
-			raise ArgumentError, "Too many arguments."
+			exit_now! "Too many arguments.", -12
 		end
 	end
 end

data/lib/glyph/commands/init.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 GLI.desc 'Create a new Glyph project'
 command :init do |c|
 	c.action do |global_options,options,args|

data/lib/glyph/commands/outline.rb

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

data/lib/glyph/commands/stats.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 GLI.desc 'Display statistics'
 command :stats do |c|
 	c.desc "Display stats about macros"
@@ -32,6 +34,7 @@ command :stats do |c|
 		no_flags = true
 		[:macro, :bookmark, :link, :snippet].each do |f|
 			if options[f] then
+				analyzer.stats_for :snippets if f == :snippet
 				analyzer.stats_for f, options[f] 
 				no_flags = false
 			end

data/lib/glyph/commands/todo.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 GLI.desc 'Display all project TODO items'
 command :todo do |c|
 	c.action do |global_options, options, args|

data/lib/glyph/config.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Glyph
 
 	# The Glyph::Config class is used (you don't say!) to store configuration data. Essentially it wraps a Hash of Hashes

data/lib/glyph/document.rb

@@ -9,9 +9,11 @@ module Glyph
 	# as well as replacing placeholders.
 	class Document
 
-		ESCAPES = /\\([\\\]\[\|.=])/
+    # A Regexp containing the characters to escape
+		ESCAPES = /\\([\\\]\[\|\/=])/
 
-		attr_reader :bookmarks, :placeholders, :headers, :styles, :context, :errors, :todos, :topics, :links, :toc
+		attr_reader :bookmarks, :placeholders, :headers, :styles, :context
+		attr_reader :errors, :todos, :topics, :links, :toc, :fragments, :snippets
 
 		# Creates a new document
 		# @param [GlyphSyntaxNode] tree the syntax tree to be evaluate
@@ -24,6 +26,8 @@ module Glyph
 			@placeholders = {}
 			@bookmarks = {}
 			@headers = {}
+			@snippets = {}
+			@fragments = {}
 			@styles = []
 			@errors = []
 			@todos = []
@@ -49,12 +53,14 @@ module Glyph
 		def inherit_from(document, data={})
 			@bookmarks = document.bookmarks unless data[:bookmarks] == false
 			@headers = document.headers unless data[:headers] == false
+			@snippets = document.snippets unless data[:snippets] == false
 			@todos = document.todos unless data[:todos] == false
 			@styles = document.styles unless data[:styles] == false
 			@topics = document.topics unless data[:topics] == false
 			@placeholders = document.placeholders unless data[:placeholders] == false
 			@toc = document.toc unless data[:toc] == false
-			@links = document.links unless data[:links] == true
+			@links = document.links unless data[:links] == false
+			@fragments = document.fragments unless data[:fragments] == false
 			self
 		end
 
@@ -75,7 +81,8 @@ module Glyph
 		end
 
 		# Stores a new bookmark
-		# @param [Hash] hash the bookmark hash: {:id => "BookmarkID", :title => "Bookmark Title", :file => "dir/preface.glyph"}
+		# @param [Hash] hash the bookmark hash
+    # @example {:id => "BookmarkID", :title => "Bookmark Title", :file => "dir/preface.glyph"}
 		# @return [Glyph::Bookmark] the stored bookmark
 		# @raise [RuntimeError] if the bookmark is already defined.
 		def bookmark(hash)
@@ -86,7 +93,8 @@ module Glyph
 		end
 
 		# Stores a new header
-		# @param [Hash] hash the header hash: {:id => "Bookmark_ID", :title => "Bookmark Title", :level => 3}
+		# @param [Hash] hash the header hash
+    # @example {:id => "Bookmark_ID", :title => "Bookmark Title", :level => 3}
 		# @return [Glyph::Header] the stored header
 		# @raise [RuntimeError] if the bookmark is already defined.
 		def header(hash)
@@ -104,10 +112,27 @@ module Glyph
 			@headers[key.to_sym]
 		end
 
+		# Stores a new snippet
+		# @param [Symbol, String] key the snippet identifier
+		# @param [string] value the snippet contents
+		# @return [String] the stored snippet
+		# @since 0.5.0
+		def snippet(key, value)
+			@snippets[key.to_sym] = value
+		end
+
+		# Returns a stored snippet or nil
+		# @param [String, Symbol] key the snippet identifier
+		# @return [String, nil] the snippet contents or nil if no snippet is found
+		# @since 0.5.0
+		def snippet?(key)
+			@snippets[key.to_sym]
+		end
+
 		# @since 0.4.0
 		# Stores a stylesheet
 		# @param [String] file the stylesheet file
-		# @raises [RuntimeError] if the stylesheet is already specified for the document (unless the output has more than one file)
+		# @raise [RuntimeError] if the stylesheet is already specified for the document (unless the output has more than one file)
 		def style(file)
 			f = Pathname.new file
 			if @styles.include?(f) && !Glyph.multiple_output_files? then
@@ -152,10 +177,10 @@ module Glyph
 				end
 			end
 			# Substitute escape sequences
-			@output.gsub!(ESCAPES) { |match| ($1 == '.') ? '' : $1 }
-			toc[:contents].gsub!(ESCAPES) { |match| ($1 == '.') ? '' : $1 } rescue nil
+			@output.gsub!(ESCAPES) { |match| ($1 == '/') ? '' : $1 }
+			toc[:contents].gsub!(ESCAPES) { |match| ($1 == '/') ? '' : $1 } rescue nil
 			@topics.each do |t|
-				t[:contents].gsub!(ESCAPES) { |match| ($1 == '.') ? '' : $1 }
+				t[:contents].gsub!(ESCAPES) { |match| ($1 == '/') ? '' : $1 }
 			end
 			@state = :finalized
 		end