glyph 0.2.0 → 0.3.0

data/document.glyph

@@ -1,29 +1,29 @@
-document[
-  head[style[default.css]]
-  body[
-    titlepage[
-      title[]
-      author[]
-      pubdate[]
-    ]
-    frontmatter[
-      toc[]
-      preface[header[Preface]
-        @[preface.textile]
-      ]
+book[
+  @frontmatter[
+		toc[]
+		preface[
+			@title[Preface]
+			todo[Write the preface]
+			include[preface]
+		]
+	]
+  @bodymatter[  
+    chapter[ 
+			@title[Chapter 1]
+			todo[Write chapter 1]
+      include[chapter_1]
     ]
-    bodymatter[  
-      chapter[header[Chapter #1]
-        @[chapter_1.textile]
-      ]
-      chapter[header[Chapter #2]
-        @[chapter_2.textile]
-      ]
+    chapter[
+			@title[Chapter 2]
+			todo[Write chapter 2]
+      include[chapter_2]
     ]
-		backmatter[
-			appendix[header[Appendix A]
-				@[appendix_a.textile]
-			]
-		]
   ]
+	@backmatter[
+		appendix[
+			@title[Appendix A]
+			todo[Write appendix A]
+			include[appendix_a]
+		]
+	]
 ]

data/glyph.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{glyph}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Fabio Cevasco"]
-  s.date = %q{2010-05-09}
+  s.date = %q{2010-06-13}
   s.default_executable = %q{glyph}
   s.description = %q{Glyph is a framework for structured document authoring.}
   s.email = %q{h3rald@h3rald.com}
@@ -25,35 +25,67 @@ Gem::Specification.new do |s|
      "README.textile",
      "Rakefile",
      "VERSION",
+     "benchmark.rb",
      "bin/glyph",
      "book/config.yml",
      "book/document.glyph",
+     "book/images/document_generation.png",
      "book/images/glyph.png",
      "book/images/glyph.svg",
      "book/lib/macros/reference.rb",
      "book/output/html/glyph.html",
+     "book/output/html/images/document_generation.png",
      "book/output/html/images/glyph.png",
      "book/output/html/images/glyph.svg",
      "book/output/pdf/glyph.pdf",
+     "book/resources/document_generation.txt",
      "book/script/authors",
      "book/script/changelog",
-     "book/script/compile.rb",
      "book/script/license",
-     "book/script/prof",
-     "book/script/prof_results.htm",
      "book/script/readme",
      "book/snippets.yml",
      "book/text/acknowledgement.glyph",
-     "book/text/authoring.glyph",
      "book/text/changelog.glyph",
-     "book/text/extending.glyph",
-     "book/text/getting_started.glyph",
+     "book/text/compiling/compiling.glyph",
+     "book/text/compiling/lite_mode.glyph",
+     "book/text/compiling/programmatic_usage.glyph",
+     "book/text/extending/bookmarks_headers.glyph",
+     "book/text/extending/further_reading.glyph",
+     "book/text/extending/internals.glyph",
+     "book/text/extending/interpreting.glyph",
+     "book/text/extending/macro_def.glyph",
+     "book/text/extending/params_attrs.glyph",
+     "book/text/extending/placeholders.glyph",
+     "book/text/extending/validators.glyph",
+     "book/text/getting_started/configuration.glyph",
+     "book/text/getting_started/create_project.glyph",
+     "book/text/getting_started/structure.glyph",
      "book/text/introduction.glyph",
      "book/text/license.glyph",
+     "book/text/macros/macros_block.glyph",
+     "book/text/macros/macros_core.glyph",
+     "book/text/macros/macros_filters.glyph",
+     "book/text/macros/macros_inline.glyph",
+     "book/text/macros/macros_structure.glyph",
      "book/text/ref_commands.glyph",
      "book/text/ref_config.glyph",
      "book/text/ref_macros.glyph",
-     "book/text/troubleshooting.glyph",
+     "book/text/text_editing/code.glyph",
+     "book/text/text_editing/conditionals.glyph",
+     "book/text/text_editing/evaluation.glyph",
+     "book/text/text_editing/glyph_files.glyph",
+     "book/text/text_editing/images.glyph",
+     "book/text/text_editing/inclusions.glyph",
+     "book/text/text_editing/links.glyph",
+     "book/text/text_editing/macro_intro.glyph",
+     "book/text/text_editing/raw_html.glyph",
+     "book/text/text_editing/sections.glyph",
+     "book/text/text_editing/stylesheets.glyph",
+     "book/text/troubleshooting/errors_command.glyph",
+     "book/text/troubleshooting/errors_generic.glyph",
+     "book/text/troubleshooting/errors_intro.glyph",
+     "book/text/troubleshooting/errors_macro.glyph",
+     "book/text/troubleshooting/errors_parser.glyph",
      "config.yml",
      "document.glyph",
      "glyph.gemspec",
@@ -61,18 +93,19 @@ Gem::Specification.new do |s|
      "lib/glyph/commands.rb",
      "lib/glyph/config.rb",
      "lib/glyph/document.rb",
-     "lib/glyph/glyph_language.rb",
-     "lib/glyph/glyph_language.treetop",
      "lib/glyph/interpreter.rb",
      "lib/glyph/macro.rb",
      "lib/glyph/macro_validators.rb",
      "lib/glyph/node.rb",
+     "lib/glyph/parser.rb",
+     "lib/glyph/syntax_node.rb",
      "lib/glyph/system_extensions.rb",
-     "macros/common.rb",
+     "macros/core.rb",
      "macros/filters.rb",
      "macros/html/block.rb",
      "macros/html/inline.rb",
      "macros/html/structure.rb",
+     "macros/xml.rb",
      "spec/files/article.glyph",
      "spec/files/container.textile",
      "spec/files/document.glyph",
@@ -89,9 +122,13 @@ Gem::Specification.new do |s|
      "spec/lib/macro_spec.rb",
      "spec/lib/macro_validators_spec.rb",
      "spec/lib/node_spec.rb",
+     "spec/lib/parser_spec.rb",
+     "spec/lib/syntax_node_spec.rb",
+     "spec/macros/core_spec.rb",
      "spec/macros/filters_spec.rb",
      "spec/macros/macros_spec.rb",
      "spec/macros/textile_spec.rb",
+     "spec/macros/xml_spec.rb",
      "spec/spec_helper.rb",
      "spec/tasks/generate_spec.rb",
      "spec/tasks/load_spec.rb",
@@ -130,8 +167,10 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.6}
   s.summary = %q{Glyph -- A Ruby-powered Document Authoring Framework}
   s.test_files = [
-    "spec/macros/filters_spec.rb",
+    "spec/macros/core_spec.rb",
+     "spec/macros/filters_spec.rb",
      "spec/macros/textile_spec.rb",
+     "spec/macros/xml_spec.rb",
      "spec/macros/macros_spec.rb",
      "spec/lib/interpreter_spec.rb",
      "spec/lib/commands_spec.rb",
@@ -140,6 +179,8 @@ Gem::Specification.new do |s|
      "spec/lib/macro_validators_spec.rb",
      "spec/lib/config_spec.rb",
      "spec/lib/glyph_spec.rb",
+     "spec/lib/parser_spec.rb",
+     "spec/lib/syntax_node_spec.rb",
      "spec/lib/document_spec.rb",
      "spec/tasks/load_spec.rb",
      "spec/tasks/generate_spec.rb",
@@ -154,46 +195,40 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<gli>, [">= 0.3.1"])
       s.add_runtime_dependency(%q<extlib>, [">= 0.9.12"])
-      s.add_runtime_dependency(%q<treetop>, [">= 0.4.3"])
       s.add_runtime_dependency(%q<rake>, [">= 0.8.7"])
       s.add_development_dependency(%q<rspec>, [">= 1.1.11"])
       s.add_development_dependency(%q<yard>, [">= 1.5.4"])
       s.add_development_dependency(%q<jeweler>, ["= 1.4.0"])
       s.add_development_dependency(%q<directory_watcher>, [">= 1.3.2"])
-      s.add_development_dependency(%q<haml>, [">= 2.2.3"])
+      s.add_development_dependency(%q<haml>, [">= 3.0.6"])
       s.add_development_dependency(%q<RedCloth>, [">= 4.2.3"])
       s.add_development_dependency(%q<bluecloth>, [">= 2.0.7"])
       s.add_development_dependency(%q<coderay>, [">= 0.9.3"])
-      s.add_development_dependency(%q<ruby-prof>, [">= 0.8.1"])
     else
       s.add_dependency(%q<gli>, [">= 0.3.1"])
       s.add_dependency(%q<extlib>, [">= 0.9.12"])
-      s.add_dependency(%q<treetop>, [">= 0.4.3"])
       s.add_dependency(%q<rake>, [">= 0.8.7"])
       s.add_dependency(%q<rspec>, [">= 1.1.11"])
       s.add_dependency(%q<yard>, [">= 1.5.4"])
       s.add_dependency(%q<jeweler>, ["= 1.4.0"])
       s.add_dependency(%q<directory_watcher>, [">= 1.3.2"])
-      s.add_dependency(%q<haml>, [">= 2.2.3"])
+      s.add_dependency(%q<haml>, [">= 3.0.6"])
       s.add_dependency(%q<RedCloth>, [">= 4.2.3"])
       s.add_dependency(%q<bluecloth>, [">= 2.0.7"])
       s.add_dependency(%q<coderay>, [">= 0.9.3"])
-      s.add_dependency(%q<ruby-prof>, [">= 0.8.1"])
     end
   else
     s.add_dependency(%q<gli>, [">= 0.3.1"])
     s.add_dependency(%q<extlib>, [">= 0.9.12"])
-    s.add_dependency(%q<treetop>, [">= 0.4.3"])
     s.add_dependency(%q<rake>, [">= 0.8.7"])
     s.add_dependency(%q<rspec>, [">= 1.1.11"])
     s.add_dependency(%q<yard>, [">= 1.5.4"])
     s.add_dependency(%q<jeweler>, ["= 1.4.0"])
     s.add_dependency(%q<directory_watcher>, [">= 1.3.2"])
-    s.add_dependency(%q<haml>, [">= 2.2.3"])
+    s.add_dependency(%q<haml>, [">= 3.0.6"])
     s.add_dependency(%q<RedCloth>, [">= 4.2.3"])
     s.add_dependency(%q<bluecloth>, [">= 2.0.7"])
     s.add_dependency(%q<coderay>, [">= 0.9.3"])
-    s.add_dependency(%q<ruby-prof>, [">= 0.8.1"])
   end
 end
 

data/lib/glyph.rb

@@ -7,7 +7,6 @@ require 'pathname'
 require 'yaml'
 require 'gli'
 require 'extlib'
-require 'treetop'
 require 'rake'
 
 # Glyph is a Rapid Document Authoring Framework able to produce structured documents 	effortlessly.
@@ -29,14 +28,32 @@ module Glyph
 	require LIB/'config'
 	require LIB/'node'
 	require LIB/'document'
-	require LIB/'glyph_language'
 	require LIB/'macro_validators'
 	require LIB/'macro'
+	require LIB/'syntax_node'
+	require LIB/'parser'
 	require LIB/'interpreter'
 
 	class Error < RuntimeError; end
 	class SyntaxError < Error; end
-	class MacroError < Error; end
+	class MacroError < Error
+		attr_reader :macro
+
+		# Initializes a new Glyph::MacroError
+		# @param [String] message the error message
+		# @param [Glyph::Macro] macro the macro that caused the error
+		def initialize(message, macro)
+			@macro = macro
+			super(message)
+		end
+
+		# Displays the error message, source, path and node value (if debugging)
+		def display
+			Glyph.warning exception.message
+			Glyph.msg "    source: #{@macro.source}\n    path: #{@macro.path}"
+			Glyph.msg "#{"-"*54}\n#{@macro.node.to_s.gsub(/\t/, ' ')}\n#{"-"*54}" if Glyph.debug?
+		end
+	end
 	class MutualInclusionError < MacroError; end
 
 	# The current version of Glyph
@@ -50,8 +67,13 @@ module Glyph
 
 	begin
 		unless const_defined? :MODE then
-			# Glyph's modes: debug/lite/test
-			MODE = {:debug => false, :lite => false, :test => false, :library => false} 
+			MODE = {
+				:debug => false, 
+				:lite => false, 
+				:test => false, 
+				:library => false,
+				:safe => false
+			} 
 		end
 	rescue
 	end
@@ -60,7 +82,7 @@ module Glyph
 	@@document = nil
 
 	(class << self; self; end).instance_eval do
-		["test", "lite", "debug", "library"].each do |mode|
+		["test", "lite", "debug", "library", "safe"].each do |mode|
 			define_method((mode+"?").to_sym) do
 				MODE[mode.to_sym]
 			end
@@ -176,6 +198,12 @@ module Glyph
 		MACROS[name.to_sym] = block
 	end
 
+	def self.rewrite(name, &block)
+		MACROS[name.to_sym] = lambda do
+			rewrite &block
+		end
+	end
+
 	# Defines an alias for an existing macro
 	# @param [Hash] text the single-key hash defining the alias
 	# @example
@@ -198,7 +226,7 @@ module Glyph
 		Dir.chdir Pathname.new(src).parent.to_s
 		begin
 			require 'glyph/commands'
-			self[:quiet] = true
+			self['system.quiet'] = true
 			self.library_mode = true
 			GLI.run ["compile", src.to_s, out].compact	
 		rescue Exception => e
@@ -207,7 +235,7 @@ module Glyph
 			Dir.chdir pwd
 			self.library_mode = false
 			self.lite_mode = false
-			self[:quiet] = false
+			self['system.quiet'] = false
 		end
 	end
 
@@ -224,7 +252,7 @@ module Glyph
 		self.enable_all
 		result = ""
 		begin
-			self[:quiet] = true
+			self['system.quiet'] = true
 			self.library_mode = true
 			self.run 'load:all'
 			result = Interpreter.new(text).document.output
@@ -233,27 +261,40 @@ module Glyph
 		ensure
 			self.lite_mode = false
 			self.library_mode = false
-			self[:quiet] = false
+			self['system.quiet'] = false
 		end
 		result
 	end
 
+
 	# Prints a message
 	# @param [String] message the message to print
+	def self.msg(message)
+		puts message unless Glyph['system.quiet']
+	end
+
+	# Prints an informational message
+	# @param [String] message the message to print
 	def self.info(message)
-		puts "#{message}" unless Glyph[:quiet]
+		puts "-- #{message}" unless Glyph['system.quiet']
 	end
 
 	# Prints a warning
 	# @param [String] message the message to print
 	def self.warning(message)
-		puts "--> warning: #{message}" unless Glyph[:quiet]
+		puts "-> warning: #{message}" unless Glyph['system.quiet']
 	end
 
 	# Prints an error
 	# @param [String] message the message to print
 	def self.error(message)
-		puts "==> error: #{message}" unless Glyph[:quiet]
+		puts "=> error: #{message}" unless Glyph['system.quiet']
+	end
+	
+	# Prints a message if running in debug mode
+	# @param [String] message the message to print
+	def self.debug(message)
+		puts message if Glyph.debug?
 	end
 
 end

data/lib/glyph/commands.rb

@@ -29,13 +29,13 @@ command :compile do |c|
 	c.desc "Specify the format of the output file (default: html)"
 	c.flag [:f, :format]
 	c.desc "Auto-regenerate output on file changes"
-	c.switch :auto
+	c.switch [:a, :auto]
 	c.action do |global_options, options, args|
 		raise ArgumentError, "Too many arguments" if args.length > 2
 		Glyph.lite_mode = true unless args.blank? 
 		Glyph.run! 'load:config'
 		original_config = Glyph::CONFIG.dup
-		output_targets = Glyph::CONFIG.get('document.output_targets')
+		output_targets = Glyph['system.output_targets']
 		target = nil
 		Glyph['document.output'] = options[:f] if options[:f]
 		target = Glyph['document.output']
@@ -74,7 +74,7 @@ command :compile do |c|
 		end
 
 		# Auto-regeneration
-		if options[:auto] && !Glyph.lite? then
+		if options[:a] && !Glyph.lite? then
 			Glyph.lite_mode = false
 			begin
 				require 'directory_watcher'
@@ -113,11 +113,26 @@ end
 GLI.desc 'Display all project TODO items'
 command :todo do |c|
 	c.action do |global_options, options, args|
+		Glyph['system.quiet'] = true
 		Glyph.run "generate:document"
+		Glyph['system.quiet'] = false
 		unless Glyph.document.todos.blank?
-			Glyph.info "*** TODOs: ***"
-			Glyph.document.todos.each do |t|
-				Glyph.info t
+			puts "====================================="
+			puts "#{Glyph['document.title']} - TODOs"
+			puts "====================================="
+			# Group items
+			if Glyph.document.todos.respond_to? :group_by then
+				Glyph.document.todos.group_by{|e| e[:source]}.each_pair do |k, v|
+					puts
+					puts "=== #{k} "
+					v.each do |i|
+						puts " * #{i[:text]}"
+					end
+				end
+			else
+				Glyph.document.todos.each do |t|
+					Glyph.info t
+				end
 			end
 		else
 			Glyph.info "Nothing left to do."
@@ -125,6 +140,52 @@ command :todo do |c|
 	end
 end
 
+GLI.desc 'Display the document outline'
+command :outline do |c|
+	c.desc "Limit to level N"
+	c.flag :l, :level
+	c.desc "Show file names"
+	c.switch :f, :files
+	c.desc "Show titles"
+	c.switch :t, :titles
+	c.desc "Show IDs"
+	c.switch :i, :ids
+	c.action do |global_options, options, args|
+		levels = options[:l]
+		ids = options[:i]
+		files = options[:f]
+		titles = options[:t]
+		titles = true if !ids && !levels && !files || levels && !ids
+		Glyph['system.quiet'] = true
+		Glyph.run "generate:document"
+		Glyph['system.quiet'] = false
+		puts "====================================="
+		puts "#{Glyph['document.title']} - Outline"
+		puts "====================================="
+		Glyph.document.structure.descend do |n, level|
+			if n.is_a?(Glyph::MacroNode) then
+				case
+				when n[:name].in?(Glyph['system.structure.headers']) then
+					header = Glyph.document.header?(n[:header])
+					next if !header || levels && header[:level]-1 > levels.to_i
+					last_level = header[:level]
+					h_id = ids ? "[##{header[:id]}]" : ""
+					h_title = titles ? "#{header[:title]} " : ""
+					text = ("  "*(header[:level]-1))+"- "+h_title+h_id
+					puts text unless text.blank?
+				when n[:name] == :include then
+					if files && n.find_parent{|p| p[:name] == :document && p.is_a?(Glyph::MacroNode)} then
+						# When using the book or article macros, includes appear twice: 
+						# * in the macro parameters
+						# * as children of the document macro
+						puts "=== #{n.param(0)}" 
+					end
+				end	
+			end
+		end
+	end
+end
+
 GLI.desc 'Get/set configuration settings'
 arg_name "setting [new_value]"
 command :config do |c|
@@ -145,15 +206,19 @@ command :config do |c|
 			raise RuntimeError, "Unknown setting '#{args[0]}'" if setting.blank?
 			Glyph.info setting
 		when 2 then
-			# Remove all overrides
-			Glyph.config_reset
-			# Reload current project config
-			config.read 
-			config.set args[0], args[1]
-			# Write changes to file
-			config.write
-			# Refresh configuration
-			Glyph.config_refresh
+			if args[0].match /^system\..+/ then
+				Glyph.warning "Cannot reset '#@value' setting (system use only)."
+			else
+				# Remove all overrides
+				Glyph.config_reset
+				# Reload current project config
+				config.read 
+				config.set args[0], args[1]
+				# Write changes to file
+				config.write
+				# Refresh configuration
+				Glyph.config_refresh
+			end
 		else
 			raise ArgumentError, "Too many arguments."
 		end
@@ -180,12 +245,14 @@ post do |global,command,options,args|
 end
 
 on_error do |exception|
+	raise if Glyph.library?
 	if exception.is_a? Glyph::MacroError then
-		Glyph.warning exception.message
+		exception.display
 		false
 	else
 		if Glyph.debug? then
-			puts "Exception: #{exception.message}"
+			Glyph.warning exception.message
+			puts "\n"+"-"*20+"[ Backtrace: ]"+"-"*20
 			puts "Backtrace:"
 			exception.backtrace.each do |b|
 				puts b