glyph 0.1.0

data/glyph.gemspec

@@ -0,0 +1,138 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{glyph}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Fabio Cevasco"]
+  s.date = %q{2010-04-09}
+  s.default_executable = %q{glyph}
+  s.description = %q{Glyph is a framework for structured document authoring.}
+  s.email = %q{h3rald@h3rald.com}
+  s.executables = ["glyph"]
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    "README.textile",
+     "Rakefile",
+     "VERSION",
+     "bin/glyph",
+     "book/config.yml",
+     "book/document.glyph",
+     "book/images/glyph.png",
+     "book/images/glyph.svg",
+     "book/lib/macros/reference.rb",
+     "book/output/html/glyph.html",
+     "book/output/html/images/glyph.png",
+     "book/output/html/images/glyph.svg",
+     "book/output/pdf/glyph.pdf",
+     "book/snippets.yml",
+     "book/styles/css3.css",
+     "book/styles/default.css",
+     "book/text/authoring.textile",
+     "book/text/extending.textile",
+     "book/text/getting_started.textile",
+     "book/text/introduction.textile",
+     "book/text/ref_commands.textile",
+     "book/text/ref_config.textile",
+     "book/text/ref_macros.textile",
+     "book/text/troubleshooting.textile",
+     "config.yml",
+     "document.glyph",
+     "glyph.gemspec",
+     "lib/glyph.rb",
+     "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/node.rb",
+     "lib/glyph/system_extensions.rb",
+     "macros/common.rb",
+     "macros/filters.rb",
+     "macros/html/block.rb",
+     "macros/html/inline.rb",
+     "macros/html/structure.rb",
+     "spec/files/container.textile",
+     "spec/files/document.glyph",
+     "spec/files/document_with_toc.glyph",
+     "spec/files/included.textile",
+     "spec/files/ligature.jpg",
+     "spec/files/markdown.markdown",
+     "spec/files/test.sass",
+     "spec/lib/commands_spec.rb",
+     "spec/lib/config_spec.rb",
+     "spec/lib/document_spec.rb",
+     "spec/lib/glyph_spec.rb",
+     "spec/lib/interpreter_spec.rb",
+     "spec/lib/macro_spec.rb",
+     "spec/lib/node_spec.rb",
+     "spec/macros/filters_spec.rb",
+     "spec/macros/macros_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/tasks/generate_spec.rb",
+     "spec/tasks/load_spec.rb",
+     "spec/tasks/project_spec.rb",
+     "styles/css3.css",
+     "styles/default.css",
+     "tasks/generate.rake",
+     "tasks/load.rake",
+     "tasks/project.rake"
+  ]
+  s.homepage = %q{http://www.h3rald.com/glyph/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Glyph -- A Ruby-powered Document Authoring Framework}
+  s.test_files = [
+    "spec/macros/filters_spec.rb",
+     "spec/macros/macros_spec.rb",
+     "spec/lib/interpreter_spec.rb",
+     "spec/lib/commands_spec.rb",
+     "spec/lib/node_spec.rb",
+     "spec/lib/macro_spec.rb",
+     "spec/lib/config_spec.rb",
+     "spec/lib/glyph_spec.rb",
+     "spec/lib/document_spec.rb",
+     "spec/tasks/load_spec.rb",
+     "spec/tasks/generate_spec.rb",
+     "spec/tasks/project_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    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>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    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>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    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>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/lib/glyph.rb

@@ -0,0 +1,128 @@
+# Copyright (c) 2009-2010 Fabio Cevasco
+# website: http://www.h3rald.com/glyph
+# license: BSD
+
+require 'rubygems'
+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.
+module Glyph
+
+	LIB = Pathname(__FILE__).dirname.expand_path/'glyph'
+
+	HOME = LIB/'../../'
+
+	require LIB/'system_extensions'
+	require LIB/'config'
+	require LIB/'node'
+	require LIB/'document'
+	require LIB/'glyph_language'
+	require LIB/'macro'
+	require LIB/'interpreter'
+
+	VERSION = file_load HOME/'VERSION'
+
+	SPEC_DIR = Pathname(__FILE__).dirname.expand_path/'../spec'
+
+	TASKS_DIR = Pathname(__FILE__).dirname.expand_path/'../tasks'
+
+	APP = Rake.application
+
+	SNIPPETS = {}
+
+	MACROS = {}
+
+	TODOS = []
+
+	ERRORS = []
+
+	# Returns true if Glyph is running in test mode
+	def self.testing?
+		const_defined? :TEST_MODE rescue false
+	end
+
+	PROJECT = (Glyph.testing?) ? Glyph::SPEC_DIR/"test_project" : Pathname.new(Dir.pwd)
+
+	CONFIG = Glyph::Config.new :resettable => true, :mutable => false
+
+	home_dir = Pathname.new(RUBY_PLATFORM.match(/win32|mingw/) ? ENV['HOMEPATH'] : ENV['HOME'])
+	SYSTEM_CONFIG = Glyph::Config.new(:file => HOME/'config.yml')
+	GLOBAL_CONFIG = Glyph.testing? ? Glyph::Config.new(:file => SPEC_DIR/'.glyphrc') : Glyph::Config.new(:file => home_dir/'.glyphrc')
+	PROJECT_CONFIG = Glyph::Config.new(:file => PROJECT/'config.yml')
+
+	# Loads all Rake tasks
+	def self.setup
+		FileList["#{TASKS_DIR}/**/*.rake"].each do |f|
+			load f
+		end	
+	end
+
+	# Overrides a configuration setting
+	# @param setting [String, Symbol] the configuration setting to change
+	# @param value the new value
+	def self.config_override(setting, value)
+		PROJECT_CONFIG.set setting, value
+		reset_config
+	end
+
+	# Resets Glyph configuration
+	def self.reset_config
+		CONFIG.merge!(SYSTEM_CONFIG.merge(GLOBAL_CONFIG.merge(PROJECT_CONFIG)))
+	end
+
+	# Returns true if the PROJECT constant is set to a valid Glyph project directory
+	def self.project?
+		children = ["styles", "text", "output", "snippets.yml", "config.yml", "document.glyph"].sort
+		actual_children = PROJECT.children.map{|c| c.basename.to_s}.sort 
+		(actual_children & children) == children
+	end
+
+	# Enables a Rake task
+	# @param task the task to enable
+	def self.enable(task)
+		Rake::Task[task].reenable
+	end
+
+	# Reenables and runs a Rake task
+	# @param task the task to enable
+	# @param *args the task arguments
+	def self.run!(task, *args)
+		Rake::Task[task].reenable
+		self.run task, *args
+	end
+
+	# Runs a Rake task
+	# @param task the task to enable
+	# @param *args the task arguments
+	def self.run(task, *args)
+		Rake::Task[task].invoke *args
+	end
+
+	# Defines a new macro
+	# @param name [Symbol, String] the name of the macro
+	def self.macro(name, &block)
+		MACROS[name] = block
+	end
+
+	# Defines an alias for an existing macro
+	# @param [Hash] pair the single-key hash defining the alias
+	# @example
+	# 	{:old_name => :new_name}
+	def self.macro_alias(pair)
+		name = pair.keys[0].to_sym
+		found = MACROS[name]
+		if found then
+			warning "Invalid alias: macro '#{name}' already exists."
+			return
+		end
+		MACROS[name] = MACROS[pair.values[0].to_sym]
+	end
+	
+end
+
+Glyph.setup

data/lib/glyph/commands.rb

@@ -0,0 +1,124 @@
+include GLI
+
+
+GLI.desc "Enable debugging"
+switch [:d, :debug]
+
+GLI.desc 'Create a new Glyph project'
+command :init do |c|
+	c.action do |global_options,options,args|
+		Glyph.run 'project:create', Dir.pwd
+	end
+end
+
+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?
+		Glyph.run 'project:add', args[0]
+	end
+end
+
+GLI.desc 'Compile the project'
+arg_name "[output_target]"
+command :compile do |c|
+	c.desc "Specify a glyph file to compile (default: document.glyph)"
+	c.flag [:s, :source]
+	c.desc "Specify the format of the output file (default: html)"
+	c.flag [:f, :format]
+	c.action do |global_options, options, args|
+		Glyph.run 'load:config'
+		output_targets = Glyph::CONFIG.get('document.output_targets')
+		target = nil
+		Glyph.config_override('document.output', options[:f]) if options[:f]
+		target = cfg('document.output')
+		target = nil if target.blank?
+		target ||= cfg('filters.target')
+		Glyph.config_override('document.source', options[:s]) if options[:s]
+		raise ArgumentError, "Output target not specified" unless target
+		raise ArgumentError, "Unknown output target '#{target}'" unless output_targets.include? target.to_sym
+		Glyph.run "generate:#{target}"
+	end
+end
+
+GLI.desc 'Display all project TODO items'
+command :todo do |c|
+	c.action do |global_options, options, args|
+		Glyph.run "generate:document"
+		unless Glyph::TODOS.blank?
+			info "*** TODOs: ***"
+			Glyph::TODOS.each do |t|
+				info t
+			end
+		else
+			info "Nothing left to do."
+		end
+	end
+end
+
+GLI.desc 'Get/set configuration settings'
+arg_name "setting [new_value]"
+command :config do |c|
+	c.desc "Save to global configuration"
+	c.switch [:g, :global]
+	c.action do |global_options,options,args|
+		Glyph.run 'load:config'
+		if options[:g] then
+			cfg = Glyph::GLOBAL_CONFIG
+		else
+			cfg = Glyph::PROJECT_CONFIG
+		end
+		case args.length
+		when 0 then
+			raise ArgumentError, "Too few arguments."
+		when 1 then # read current config
+			setting = cfg(args[0])
+			raise RuntimeError, "Unknown setting '#{args[0]}'" if setting.blank?
+			info Glyph::CONFIG.get(args[0])
+		when 2 then
+			cfg.set args[0], args[1]
+			Glyph.reset_config
+		else
+			raise ArgumentError, "Too many arguments."
+		end
+	end
+end
+
+pre do |global,command,options,args|
+	# Pre logic here
+	# Return true to proceed; false to abourt and not call the
+	# chosen command
+	if global[:d] then
+		Glyph::DEBUG = true
+	end
+	if !command || command.name == :help then
+		puts "====================================="
+		puts "Glyph v#{Glyph::VERSION}"
+		puts "====================================="
+	end
+	true
+end
+
+post do |global,command,options,args|
+	# Post logic here
+end
+
+on_error do |exception|
+	if exception.is_a? MacroError then
+		#warning exception.message
+		puts exception.message
+		false
+	else
+		if Glyph.const_defined? :DEBUG then
+			puts "Exception: #{exception.message}"
+			puts "Backtrace:"
+			exception.backtrace.each do |b|
+				puts b
+			end
+		end
+		true
+	end
+	# Error logic here
+	# return false to skip default error handling
+end

data/lib/glyph/config.rb

@@ -0,0 +1,152 @@
+module Glyph
+
+	# The Glyph::Config class is used (you don't say!) to store configuration data. Essentially it wraps a Hash of Hashes
+	# and provides some useful methods to access keys and subkeys.
+	class Config
+
+		# Initializes the configuration with a hash of options:
+		# * :file (default: nil) - A YAML file to read data from
+		# * :data (default: {})- The initial contents
+		# * :resettable (default: false) - Whether the configuration can be reset (cleared) or not
+		# * :mutable (default: true) - Whether the configuration can be changed or not
+		#
+		# @param [Hash] options the configuration options (merged with the the defaults)
+		def initialize(options={})
+			default_options = {:file => nil, :data => {}, :resettable => false, :mutable => true}
+			@options = default_options.merge options
+			@file = @options[:file]
+			@data = @options[:data]
+			read if @file
+		end
+
+		# Returns the underlying data hash
+		# @return [Hash] Configuration data
+		def to_hash
+			@data
+		end
+
+		# Resets all configuration data
+		# @param [Hash] hash the new configuration data to store
+		# @raise [RuntimeError] unless the configuration is resettable or if no hash is passed
+		# @return [Hash] Configuration data 
+		def reset(hash={})
+			raise RuntimeError, "Configuration cannot be reset" unless @options[:resettable]
+			raise RuntimeError, "Configuration data is not stored in a Hash" unless hash.is_a? Hash
+			@data = hash
+		end
+
+		# Updates configuration data by applying Hash#update to each sub-hash of data, recursively.
+		# @param [Glyph::Config] cfg the configuration to update from
+		# @raise [ArgumentError] unless cfg is a Glyph::Config
+		# @return self
+		def update(cfg)
+			merge_or_update cfg, :update
+		end
+
+		# Merges configuration data by applying Hash#merge to each sub-hash of data, recursively.
+		# @param [Glyph::Config] cfg the configuration to merge with
+		# @raise [ArgumentError] unless cfg is a Glyph::Config
+		# @return [Glyph::Config] a new merged configuration 
+		def merge(cfg)
+			merge_or_update cfg, :merge
+		end
+
+		alias merge! update
+
+		# Reads the contents of a file and stores them as configuration data
+		# @return [Hash] Configuration data
+		# @raise [RuntimeError] if self is not linked to a file or if the file does not contain a serialized Hash
+		def read
+			raise RuntimeError, "Configuration is not stored in a file." if @file.blank?
+			if @file.exist? then 
+				contents = yaml_load @file
+				raise RuntimeError, "Invalid configuration file '#{@file}'" unless contents.is_a? Hash
+				@data = contents
+			else
+				@data = {}
+			end
+			@data
+		end
+
+		# Updates a configuration setting
+		# @param [String, Symbol] setting the setting to update
+		# @param [Object] value the value to store. Where applicable (Array, Hash, Boolean, Nil), attempts 
+		# 	to evaluate string values
+		# @return [Object] the new value
+		# @raise [RuntimeError] unless the configuration is mutable
+		# @raise [ArgumentError] if the setting refers to an invalid namespace
+		# @example
+		# 	cfg = Glyph::Config.new
+		# 	cfg.set "quiet", true 								# Sets :quiet => true
+		# 	cfg.set "test.test_value", "[1,2,3]" # Sets :test => {:test_value => [1,2,3]}
+		# 	cfg.sef :quiet, "false" 							# Sets :quiet => false
+		def set(setting, value)
+			raise RuntimeError, "Configuration cannot be changed" unless @options[:mutable]
+			if value.is_a?(String) && value.match(/^(["'].*["']|:.+|\[.*\]|\{.*\}|true|false|nil)$/) then
+				value = Kernel.instance_eval value
+			end
+			hash = @data
+			path = setting.to_s.split(".").map{|s| s.intern}
+			count = 1
+			path.each do |s|
+				if hash.has_key? s then
+					if count == path.length then 
+						# destination
+						hash[s] = value
+					else
+						if hash[s].is_a?(Hash) then
+							hash = hash[s]
+							count +=1
+						else
+							raise ArgumentError, "Invalid namespace #{s}"
+						end
+					end
+				else
+					# key not found
+					if count == path.length then # destination
+						hash[s] = value
+					else
+						# create a new namespace
+						hash[s] = {}
+						hash = hash[s]
+						count +=1
+					end
+				end
+			end
+			value
+		end
+
+		# Returns a configuration setting
+		# @param [String, Symbol] setting the setting to retrieve
+		# @return [Object] the new value
+		# @see Glyph::Config#set
+		# @example
+		# 	cfg = Glyph::Config.new
+		# 	cfg.get :quiet							# true
+		# 	cfg.get "test.test_value"	# [1,2,3]
+		def get(setting)
+			@data.instance_eval "self#{setting.to_s.split(".").map{|key| "[:#{key}]" }.join}" rescue nil
+		end
+
+		# Serialize configuration data and writes it to a file
+		# @raise [RuntimeError] if the configuration is not linked to a file
+		def write
+			raise RuntimeError, "Configuration is not stored in a file." if @file.blank?
+			yaml_dump @file, @data
+		end
+
+		private
+
+		def merge_or_update(cfg, method=:merge)
+			raise ArgumentError, "#{cfg} is not a Glyph::Config" unless cfg.is_a? Glyph::Config
+			block = lambda do |key, v1, v2|
+				(v1.is_a?(Hash) && v2.is_a?(Hash)) ? v1.send(method, v2, &block) :	v2
+			end
+			new_data = @data.send(method, cfg.to_hash, &block)
+			opts = @options.merge :data => new_data, :file => nil
+			(method == :merge) ? Config.new(opts) : self
+		end
+
+	end
+
+end