glyph 0.4.2 → 0.5.0

data/lib/glyph/system_extensions.rb

@@ -1,12 +1,33 @@
+# Core Symbol class.
 class Symbol
+  # Comparison operator based on the one in the String class.
 	def <=>(b)
 		self.to_s <=> b.to_s
 	end
 end
 
+# Core String class.
 class String
+  # Converts the strings to "title case" (capitalizes each word).
 	def title_case
 		self.snake_case.split('_').map{|s| s.capitalize}.join(' ')
 	end
 end
 
+# Core Hash class.
+class Hash
+  # Converts the hash to a string of Glyph options.
+	def to_options(sep=" ")
+		"".tap do |s|
+			self.each_pair do |k, v|
+				key = k.to_s
+				s += key.length == 1 ? "-" : "--"
+				s += key
+				s += sep
+				s += v.to_s =~ /\s/ ? "\"#{v}\"" : v.to_s
+				s += " "
+			end
+		end.strip
+	end
+end
+

data/lib/glyph/utils.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Glyph
 	#@since 0.4.0
 	module Utils
@@ -51,7 +53,7 @@ module Glyph
 		# @return [String] the contents of the file
 		def file_load(file)
 			result = ""
-			File.open(file.to_s, 'r') do |f|
+			File.open(file.to_s, 'r:utf-8') do |f|
 				while l = f.gets 
 					result << l
 				end
@@ -64,7 +66,7 @@ module Glyph
 		# @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+') do |f|
+			File.open(file.to_s, 'w+:utf-8') do |f|
 				f.print contents
 			end
 			contents
@@ -96,7 +98,7 @@ module Glyph
                 # @yield [src, dest] the source file and the corresponding output file
 		# @since 0.4.0
 		def with_files_from(dir, &block)
-			output = (Glyph['document.output'] == 'pdf') ? 'html' : Glyph['document.output']
+			output =  complex_output? ? 'tmp' : Glyph['document.output']
 			dir_path = Glyph::PROJECT/"output/#{output}/#{dir}"
 			dir_path.mkpath
 			(Glyph::PROJECT/dir).find do |i|
@@ -109,6 +111,13 @@ module Glyph
 			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)
@@ -145,7 +154,7 @@ module Glyph
 
 		# Returns true if the PROJECT constant is set to a valid Glyph project directory
 		def project?
-			children = ["text", "snippets.yml", "config.yml", "document.glyph"].sort
+			children = ["text", "config.yml", "document.glyph"].sort
 			actual_children = PROJECT.children.map{|c| c.basename.to_s}.sort 
 			(actual_children & children) == children
 		end
@@ -155,5 +164,16 @@ module Glyph
 			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
 end

data/macros/block.rb

@@ -0,0 +1,111 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+macro :note do
+	@data[:name] = @name
+	@data[:text] = value
+	render
+end
+
+macro :box do
+	exact_parameters 2
+	@data[:title] = param 0
+	@data[:text] = param 1
+	render
+end
+
+macro :codeblock do
+	exact_parameters 1 
+	@data[:text] = param 0
+	render
+end
+
+macro :image do
+	min_parameters 1
+	max_parameters 3
+	image = param(0)
+	src_file = Glyph.lite? ? image : Glyph::PROJECT/"images/#{image}"
+	dest_file = Glyph.lite? ? image : "images/#{image}"
+	warning "Image '#{image}' not found" unless Pathname.new(src_file).exist? 
+	@data[:attrs] = @node.attrs
+	@data[:src] = Glyph["output.#{Glyph['document.output']}.base"].to_s+dest_file
+	render
+end
+
+macro :figure do
+	min_parameters 1
+	max_parameters 2
+	image = param(0)
+	caption = param(1) rescue nil
+	src_file = Glyph.lite? ? image : Glyph::PROJECT/"images/#{image}"
+	dest_file = Glyph.lite? ? image : "images/#{image}"
+	warning "Figure '#{image}' not found" unless Pathname.new(src_file).exist? 
+	@data[:attrs] = @node.attrs
+	@data[:src] = Glyph["output.#{Glyph['document.output']}.base"].to_s+dest_file
+	@data[:caption] = param(1)
+	render
+end
+
+macro :title do
+	no_parameters
+	unless Glyph["document.title"].blank? then
+		render
+	else
+		""
+	end
+end
+
+macro :subtitle do
+	no_parameters
+	unless Glyph["document.subtitle"].blank? then
+		render
+	else
+		""
+	end
+end
+
+macro :author do
+	no_parameters
+	render
+end
+
+# TODO -- document new param!
+macro :pubdate do
+	max_parameters 1
+	@data[:date] = params(0).blank? ? Time.now.strftime("%B %Y") : params(0)
+	render
+end
+
+macro :revision do
+	no_parameters
+	unless Glyph["document.revision"].blank? then
+		render
+	else
+		""
+	end
+end
+
+macro :navigation do
+	exact_parameters 1
+	topic_id = param(0).to_sym
+	base_url = Glyph["output.#{Glyph['document.output']}.base"]
+	@data[:contents] = render :link, :target => "#{base_url}index.html", :title => "Contents"
+	# Get the previous topic
+	previous_topic = @node[:document].topics.last
+	if previous_topic then
+		@data[:previous] = render :link, :target => "#{base_url}#{previous_topic[:src].gsub(/\..+$/, '.html')}", :title => previous_topic[:title]
+	else
+		@data[:previous] = ""
+	end
+	# The next topic is not going to be available yet, use a placeholder
+	@data[:next] = placeholder do |document|
+		current_topic = document.topics.select{|t| t[:id] == topic_id}[0] rescue nil
+		next_topic = document.topics[document.topics.index(current_topic)+1] rescue nil
+		render :link, :title => next_topic[:title], :target => "#{base_url}#{next_topic[:src].gsub(/\..+$/, '.html')}" if next_topic
+	end
+	render
+end
+
+macro_alias :important => :note
+macro_alias :tip => :note
+macro_alias :caution => :note

data/macros/core.rb

@@ -1,12 +1,12 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
 macro :snippet do
-	no_mutual_inclusion_in 0	
 	ident = value.to_sym
-	if Glyph::SNIPPETS.has_key? ident then
+	if snippet? ident then
 		begin
 			update_source "snippet[#{ident}]"
-			interpret Glyph::SNIPPETS[ident] 
+			interpret snippet?(ident) 
 		rescue Exception => e
 			case 
 			when e.is_a?(Glyph::MutualInclusionError) then
@@ -16,7 +16,6 @@ macro :snippet do
 			else
 				macro_warning e.message, e
 			end
-			macro_todo "Correct errors in snippet '#{ident}'"
 		end
 	else
 		macro_warning "Snippet '#{ident}' does not exist"
@@ -28,7 +27,7 @@ macro "snippet:" do
 	exact_parameters 2
 	ident = param(0)
 	text = param(1)
-	Glyph::SNIPPETS[ident.to_sym] = text
+	snippet ident, text
 	""
 end
 
@@ -43,6 +42,19 @@ macro "macro:" do
 	""
 end
 
+macro :load do
+	safety_check
+	exact_parameters 1
+	file = param 0 
+	path = Glyph::PROJECT/file
+	if path.exist? then
+		file_load path
+	else
+		macro_warning "File '#{file}' no found."
+		"[FILE '#{value}' NOT FOUND]"
+	end
+end
+
 macro :include do
 	safety_check
 	exact_parameters 1
@@ -85,10 +97,8 @@ macro :include do
 				raise
 			rescue Glyph::MacroError => e
 				macro_warning e.message, e
-				macro_todo "Correct errors in file '#{value}'"
 			rescue Exception => e
 				macro_warning e.message, e
-				macro_todo "Correct errors in file '#{value}'"
 			end
 		end
 	else
@@ -137,44 +147,48 @@ macro :condition do
 end
 
 macro :eq do
-	within :condition
-	min_parameters 1
-	max_parameters 2
-	(param(0).to_s == param(1).to_s)	? true : nil
+	exact_parameters 2
+	(param(0) == param(1))	? true : nil
 end
 
 macro :not do
-	within :condition
 	max_parameters 1
 	v = param(0).to_s
 	(v.blank? || v == "false") ? true : nil 
 end
 
 macro :and do
-	within :condition
-	min_parameters 1
-	max_parameters 2
+	exact_parameters 2
 	res_a = !param(0).blank?
 	res_b = !param(1).blank?
 	(res_a && res_b) ? true : nil
 end
 
 macro :or do
-	within :condition
-	min_parameters 1
-	max_parameters 2
+	exact_parameters 2
 	res_a = !param(0).blank?
 	res_b = !param(1).blank?
 	(res_a || res_b) ? true : nil
 end
 
-macro :match do
-	within :condition
+macro :lt do
+	exact_parameters 2
+	(param(0) < param(1)) ? true : nil
+end
+
+macro :lte do
 	exact_parameters 2
-	val = param(0).to_s
-	regexp = param(1).to_s
-	macro_error "Invalid regular expression: #{regexp}" unless regexp.match /^\/.*\/[a-z]?$/
-	val.match(instance_eval(regexp)) ? true : nil
+	(param(0) <= param(1)) ? true : nil
+end
+
+macro :gt do
+	exact_parameters 2
+	(param(0) > param(1)) ? true : nil
+end
+
+macro :gte do
+	exact_parameters 2
+	(param(0) >= param(1)) ? true : nil
 end
 
 macro "alias:" do
@@ -182,16 +196,10 @@ macro "alias:" do
 	Glyph.macro_alias param(0) => param(1)
 end
 
-macro "rewrite:" do
+macro "define:" do
 	safety_check
 	exact_parameters 2
-	macro_name = param(0).to_sym
-	@node.param(1).descend do |n, level|
-		if n[:name] == macro_name then
-			macro_error "Macro '#{macro_name}' cannot be defined by itself"
-		end
-	end
-	Glyph.rewrite macro_name, raw_param(1).dup	
+	Glyph.define param(0).to_sym, raw_param(1).dup	
 	nil
 end
 
@@ -199,6 +207,122 @@ macro "output?" do
 	Glyph['document.output'].in? parameters
 end
 
+macro :layout do
+	dispatch do |node|
+		node[:name] = "layout/#{node[:name]}".to_sym
+		Glyph::Macro.new(node).expand
+	end
+end
+
+macro :let do
+	exact_parameters 1
+	param(0).to_s
+end
+
+macro :attribute do
+	exact_parameters 1
+	a = param(0).to_sym
+	macro_node = @node.find_parent do |n|
+		n.is_a?(Glyph::MacroNode) && n.attr(a)
+	end
+	if macro_node then
+		Glyph::Macro.new(macro_node).attr(a)
+	else
+		nil
+	end
+end
+
+macro "attribute:" do
+	exact_parameters 2
+	a = param(0).to_sym
+	macro_node = @node.find_parent do |n|
+		n.is_a?(Glyph::MacroNode) && n.attr(a)
+	end
+	macro_error "Undeclared attribute '#{a}'" unless macro_node
+	attr_value = param(1)
+	macro_node.attr(a).children.clear
+	macro_node.attr(a) << Glyph::TextNode.new.from(:value => attr_value)	
+	nil
+end
+
+macro :add do
+	min_parameters 2
+	params.inject(0){|sum, n| sum + n.to_i}
+end
+
+macro :subtract do
+	min_parameters 2
+	params[1..params.length-1].inject(params[0].to_i){|diff, n| diff - n.to_i}
+end
+
+macro :multiply do
+	min_parameters 2
+	params.inject(1){|mult, n| mult * n.to_i}
+end
+
+macro :s do
+	dispatch do |node|
+		forbidden = [:each, :each_line, :each_byte, :upto, :intern, :to_sym, :to_f]
+		meth = node[:name]
+		infer_type = lambda do |str|
+			case
+			when str.match(/[+-]?\d+/) then
+				# Integer
+				str.to_i
+			when str.match(/^\/.+?\/[imoxneus]?$/) then
+				# Regexp
+				Kernel.instance_eval str
+			else
+				str
+			end
+		end
+		macro_error "Macro 's/#{meth}' takes at least one parameter" unless node.params.length > 0
+		macro_error "String method '#{meth}' is not supported" if meth.in?(forbidden) || meth.to_s.match(/\!$/)
+		str = node.param(0).evaluate(node, :params => true)
+		begin
+			if node.param(1) then
+				meth_params = node.params[1..node.params.length-1].map{|p| infer_type.call(p.evaluate(node, :params => true))}
+				str.send(meth, *meth_params).to_s
+			else
+				str.send(meth).to_s
+			end
+		rescue Exception => e
+			macro_warning "\"#{str}\".#{meth}(#{meth_params.map{|p| p.inspect}.join(', ') rescue nil}) - #{e.message}", e
+			""
+		end
+	end
+end
+
+macro :while do
+	exact_parameters 2
+	raw_cond = @node.parameter 0
+	raw_body = @node.parameter 1
+	cond = raw_cond.evaluate(@node, :params => true)
+	while (!cond.blank? && cond != "false") do
+		result = raw_body.evaluate(@node, :params => true)
+		cond = raw_cond.evaluate(@node, :params => true)
+		result
+	end
+end
+
+macro :fragment do
+	exact_parameters 2
+	ident, contents = param(0).to_sym, param(1)
+	macro_error "Fragment '#{ident}' is already defined" if @node[:document].fragments.has_key? ident
+	@node[:document].fragments[ident] = contents
+end
+
+macro :embed do
+	exact_parameters 1
+	ident = param(0).to_sym
+	placeholder do |document|
+		fragment = document.fragments[ident]
+		macro_error "Fragment '#{ident}' is not defined" unless fragment
+		fragment
+	end
+end
+
+
 macro_alias '--' => :comment
 macro_alias '&' => :snippet
 macro_alias '&:' => 'snippet:'
@@ -208,4 +332,10 @@ macro_alias '$' => :config
 macro_alias '$:' => 'config:'
 macro_alias '.' => :escape
 macro_alias '?' => :condition
-macro_alias 'rw:' => 'rewrite:'
+macro_alias 'def:' => 'define:'
+macro_alias '@' => :attribute
+macro_alias :attr => :attribute
+macro_alias '@:' => "attribute:"
+macro_alias "attr:" => "attribute:"
+macro_alias "##" => :fragment
+macro_alias "<=" => :embed