glyph 0.1.0

data/spec/files/markdown.markdown

@@ -0,0 +1,8 @@
+section[
+	header[Markdown|md]
+This contains markdown text.
+
+- item 1
+- item 2
+- item 3
+]

data/spec/files/test.sass

@@ -0,0 +1,2 @@
+#main  
+  background-color: #0000ff

data/spec/lib/commands_spec.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+require 'glyph/commands'
+
+describe "glyph" do
+
+	before do
+		create_project_dir
+	end
+
+	after do
+		delete_project
+	end
+
+	it "[init] should create a project in the current directory" do
+		Glyph.enable "project:create"
+		run_command_successfully(['init']).should == false
+		Dir.chdir Glyph::PROJECT.to_s
+		run_command_successfully(['init']).should == true
+	end
+
+	it "[config] should read configuration settings" do
+		create_project
+		run_command_successfully(["config", "-g"]).should == false
+		run_command(["config", "filters.target"]).match(/html/m).should_not == nil
+	end
+
+	it "[config] should write configuration settings" do
+		create_project
+		run_command_successfully(["config", "test_setting", true]).should == true
+		Glyph::CONFIG.get(:test_setting).should == true
+		Glyph::PROJECT_CONFIG.get('test_setting').should == true
+		Glyph::GLOBAL_CONFIG.get('test_setting').should_not == true
+		run_command_successfully(["config", "-g", "another.test", "something else"]).should == true
+		Glyph::CONFIG.get("another.test").should == "something else"
+		Glyph::PROJECT_CONFIG.get('another.test').should_not == "something else"
+		Glyph::GLOBAL_CONFIG.get('another.test').should == "something else"
+		run_command_successfully(["config", "-g", "yet.another.test", "something else", "extra argument"]).should == false
+	end
+
+	it "[add] should create a new text file" do
+		create_project
+		run_command_successfully(["add", "test.textile"]).should == true
+		(Glyph::PROJECT/'text/test.textile').exist?.should == true
+	end
+
+	it "[compile] should compile the project" do
+		create_project
+		run_command(["compile"]).match(/test_project\.html/m).should_not == nil
+		(Glyph::PROJECT/'output/html/test_project.html').exist?.should == true
+	end
+
+	it "[compile] should support a custom source file" do
+		create_project
+		file_copy Glyph::PROJECT/'document.glyph', Glyph::PROJECT/'custom.glyph'
+		run_command(["compile", "-s", "custom.glyph"]).match(/custom\.glyph/m).should_not == nil
+		(Glyph::PROJECT/'output/html/test_project.html').exist?.should == true
+	end
+
+	it "[compile] should continue execution in case of macro errors" do
+		create_project
+		text = %{
+			=>[#invalid1]
+			=>[#invalid2]
+			=>[#valid]
+			&[test]
+			&[invalid3]
+			#[valid|Valid bookmark]
+		}
+		file_write Glyph::PROJECT/'document.glyph', text
+		res = run_command(['-d', "compile"])
+		res.match(/Bookmark 'invalid1' does not exist/).should_not == nil
+		res.match(/Bookmark 'invalid2' does not exist/).should_not == nil
+		res.match(/Bookmark 'valid' does not exist/).should == nil
+		res.match(/Snippet 'invalid3' does not exist/).should_not == nil
+	end
+
+	it "[compile] should not compile the project in case of an unknown output format" do
+		run_command_successfully(["compile", "-f", "wrong"]).should == false
+	end
+
+
+end

data/spec/lib/config_spec.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe Glyph::Config do
+
+	before do 
+		@valid = {:test => true}.to_yaml
+		@invalid = [1,2,3].to_yaml
+		@config_path = Glyph::SPEC_DIR/'config.yml'
+		@write_config_file = lambda do |contents|
+			File.open(@config_path, "w+") { |f| f.write(contents) }
+		end
+		@cfg = Glyph::Config.new :file => @config_path
+	end
+
+	after(:all) do
+		@config_path.delete
+	end
+
+	it "should load a YAML configuration file" do
+		@write_config_file.call @invalid
+		lambda { @cfg.read }.should raise_error
+		@write_config_file.call @valid
+		@cfg.read.should == {:test => true}
+	end
+
+	it "should get and set configuration data through dot notation" do
+		@write_config_file.call @valid
+		@cfg.read
+		lambda { @cfg.set :test, false }.should_not raise_error
+		lambda { @cfg.set "test.wrong", true}.should raise_error
+		lambda { @cfg.set "test2.value", true}.should_not raise_error
+		@cfg.get("test2.value").should == true
+		lambda { @cfg.set "test2.value", "false"}.should_not raise_error
+		@cfg.get("test2.value").should == false
+		@cfg.get("test2.value2").should == nil
+		@cfg.to_hash.should == {:test => false, :test2 => {:value => false}}
+	end
+
+	it "can be resetted with a Hash, if resettable" do
+		lambda { @cfg.reset }.should raise_error
+		cfg2 = Glyph::Config.new :resettable => true
+		cfg2.reset :test => "reset!"
+		cfg2.to_hash.should == {:test => "reset!"}	
+	end
+
+	it "should be set to an empty Hash by default" do
+		cfg2 = Glyph::Config.new
+		cfg2.to_hash.should == {}
+	end
+
+	it "should write a YAML configuration file" do
+		@write_config_file.call @valid
+		@cfg.read
+		@cfg.set :test1, 1
+		@cfg.set :test2, 2
+		@cfg.set :test3, 3
+		@cfg.write
+		cfg2 = Glyph::Config.new :file => @config_path
+		cfg2.read
+		cfg2.to_hash.should == @cfg.to_hash
+	end
+
+	it "should merge with another Config without data loss" do
+		hash1 = {:a =>1, :b => {:b1 => 1, :b2 => 2, :b3 => {:b11 => 1, :b12 =>2}, :b4 => 4}, :c => 3}
+		hash2 = {:a =>1, :b => {:b1 => 1111, :b2 => 2222, :b3 => {:b12 =>2222}}}
+		@write_config_file.call hash1.to_yaml
+		@cfg.read
+		@write_config_file.call hash2.to_yaml
+		cfg2 = Glyph::Config.new :file => @config_path
+		@cfg.update cfg2
+		updated = {:a =>1, :b => {:b1 => 1111, :b2 => 2222, :b3 => {:b11 => 1, :b12 =>2222}, :b4 => 4}, :c=> 3}
+		@cfg.to_hash.should == updated
+		hash1.merge! hash2
+		hash1.should == {:a =>1, :b => {:b1 => 1111, :b2 => 2222, :b3 => {:b12 =>2222}}, :c=> 3}
+	end
+
+
+end

data/spec/lib/document_spec.rb

@@ -0,0 +1,100 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe Glyph::Document do
+
+	before do
+		Glyph.macro :test do |node|
+			"Test: #{node[:value]}"
+		end
+		create_tree = lambda {|text| }
+		create_doc = lambda {|tree| }
+		@tree = create_tree "test[test[test[Test\\|\\]...]]]"
+		@doc = create_doc @tree
+
+	end
+
+	it "should expose document data" do
+		@doc.bookmarks.should == {}
+		@doc.placeholders.should == {}
+		@doc.new?.should == true
+	end
+
+	it "should store bookmarks" do
+		lambda { @doc.bookmark(:id => "test", :title => "Test Bookmark #1")}.should_not raise_error
+		lambda { @doc.bookmark(:id => :test, :title => "Test Bookmark #2")}.should_not raise_error
+		@doc.bookmarks.length.should == 1
+		@doc.bookmarks[:test].should == {:id => :test, :title => "Test Bookmark #2"}
+	end
+
+	it "should store placeholders" do
+		p = lambda { "test" }
+		lambda { @doc.placeholder &p }.should_not raise_error
+		@doc.placeholders["‡‡‡‡‡PLACEHOLDER¤1‡‡‡‡‡".to_sym].should == p
+	end
+
+	it "can inherit data from another document" do
+		@doc.bookmark :id => :test1, :title => "Test #1"
+		@doc.bookmark :id => :test2, :title => "Test #2"
+		@doc.placeholder { "test" }
+		@doc.header :id => :test3, :title => "Test #3", :level => 3
+		doc2 = create_doc @tree
+		doc2.bookmarks.length.should == 0
+		doc2.placeholders.length.should == 0
+		doc2.bookmark :id => :test4, :title => "Test #4"
+		doc2.inherit_from @doc
+		doc2.bookmarks.length.should == 2
+		doc2.placeholders.length.should == 1
+		doc2.headers.length.should == 1
+		doc2.bookmarks[:test3].should == nil
+	end
+
+	it "should analyze the syntax tree and finalize the document" do
+		lambda { @doc.output }.should raise_error
+		lambda { @doc.finalize }.should raise_error
+		lambda { @doc.analyze }.should_not raise_error
+		lambda { @doc.analyze }.should raise_error
+		@doc.analyzed?.should == true
+		lambda { @doc.output }.should raise_error
+		lambda { @doc.finalize }.should_not raise_error
+		@doc.output.should == "Test: Test: Test: Test|]..."
+	end
+
+	it "should expose document structure" do
+		lambda { @doc.structure }.should raise_error
+		@doc.analyze
+		@doc.structure.is_a?(Node).should == true
+	end
+
+	it "should substitute placeholders when finalizing" do
+		Glyph.macro :count_tests do
+			n = placeholder do |document|
+				count = 0
+				document.structure.descend do |node, level|
+					count +=1 if node[:macro] == :test
+				end
+				count
+			end
+			n
+		end
+		text = %{
+		Total: count_tests[] tests.
+		test[
+			test[
+				test[
+					test
+				]
+			]
+			test[test]
+		]
+		}
+		tree = create_tree text
+		doc = create_doc tree
+		doc.analyze
+		doc.finalize
+		doc.output.gsub(/\n|\t/, '')[0..14].should == "Total: 4 tests."
+	end
+
+
+end
+

data/spec/lib/glyph_spec.rb

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe Glyph do
+
+	before do
+		Glyph.enable 'project:create'
+	end
+
+	it "should initialize a rake app and tasks" do
+		Glyph::APP.tasks.length.should > 0
+	end
+
+	it "should run rake tasks" do
+		delete_project_dir
+		create_project_dir
+		Glyph.run 'project:create', Glyph::PROJECT
+		lambda { Glyph.run! 'project:create', Glyph::PROJECT }.should raise_error
+		delete_project_dir
+		create_project_dir
+		lambda { Glyph.run! 'project:create', Glyph::PROJECT }.should_not raise_error
+		delete_project_dir
+	end
+
+	it "should define macros" do
+		lambda { define_em_macro }.should_not raise_error
+		lambda { define_ref_macro }.should_not raise_error
+		Glyph::MACROS.include?(:em).should == true
+		Glyph::MACROS.include?(:ref).should == true
+	end
+
+	it "should support macro aliases" do
+		define_ref_macro
+		lambda { Glyph.macro_alias("->" => :ref)}.should_not raise_error
+		Glyph::MACROS[:"->"].should == Glyph::MACROS[:ref]
+		Glyph.macro_alias :em => :ref
+		Glyph::MACROS[:em].should_not == Glyph::MACROS[:ref]
+	end
+
+	it "should provide a set of default macros and aliases" do
+		delete_project
+		create_project
+		Glyph.run! 'load:macros'
+		macros = [:anchor, :link, :codeph, :fmi, :note, :box, :code, :title, :subtitle,
+		:img, :fig, :author, :pubdate, :table, :td, :tr, :th, :comment, :todo, :snippet,
+		:include, :config, :ruby, :escape, :textile, :markdown, :div, :header, :document, :body,
+		:head, :style, :toc, :section]
+		aliases = [	
+			[[:bookmark, "#"], :anchor],
+			[["=>"], :link],
+			[[:important, :caution, :tip], :note],
+			[["@"], :include],
+			[["&"], :snippet],
+			[["$"], :config],
+			[["%"], :ruby],
+			[["."], :escape],
+			[["--"], :comment],
+			[[:md], :markdown],
+			[[:frontcover, :titlepage, :halftitlepage, :frontmatter, :bodymatter, :backmatter, :backcover], :div]]
+		total = 0
+		macros.each { |v| total+=1; Glyph::MACROS[v.to_sym].should_not == nil }
+		check_aliases = lambda do |arr, target|
+			arr.each {|v| total += 1; Glyph::MACROS[v.to_sym].should == Glyph::MACROS[target.to_sym]}
+		end
+		aliases.each { |v| check_aliases.call v[0], v[1] }
+		check_aliases.call cfg('structure.frontmatter'), :div
+		check_aliases.call cfg('structure.bodymatter'), :div
+		check_aliases.call cfg('structure.backmatter'), :div
+		cfg('structure.frontmatter').length.should == 8
+		cfg('structure.bodymatter').length.should == 4
+		cfg('structure.backmatter').length.should == 13
+		#puts Glyph::MACROS.keys.map{|i| i.to_s}.sort.to_yaml
+		total.should == Glyph::MACROS.length
+	end
+
+end

data/spec/lib/interpreter_spec.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe Glyph::Interpreter do
+
+	before do
+		delete_project
+		create_project
+		Glyph.run! 'load:macros'
+		Glyph.run! 'load:snippets'
+	end
+
+
+	after do
+		delete_project
+	end
+
+	it "should process text and run simple macros" do
+		define_em_macro
+		text = "This is a em[test]. It em[should] work."
+		interpret text
+		@p.document.output.should == "This is a <em>test</em>. It <em>should</em> work."
+		text2 = "This is pointless, but valid: em[]. This em[will] though."
+		interpret text2
+		@p.document.output.should == "This is pointless, but valid: <em></em>. This <em>will</em> though."
+	end
+
+	it "should process and run complex macros" do
+		define_ref_macro
+		text = "This is a ref[http://www.h3rald.com|test]."
+		interpret text
+		@p.document.output.should == "This is a <a href=\"http://www.h3rald.com\">test</a>."
+	end
+
+	it "should support multiline macros" do
+		define_ref_macro
+		text = %{This is a test containing a ref[
+		http://www.h3rald.com
+		|
+		multiline
+		
+		] macro.}
+		interpret text
+		@p.document.output.should == %{This is a test containing a <a href="http://www.h3rald.com">multiline</a> macro.}
+	end
+
+	it "should support escape characters" do
+		define_em_macro
+		text = %{This text contains em[
+			some escaped em\\[content\\]... etc.].}
+		interpret text
+		@p.document.output.should == %{This text contains <em>some escaped em[content]... etc.</em>.}
+	end
+
+	it "should support nested macros" do
+		define_em_macro
+		define_ref_macro
+		text = %{This is an ref[#test|em[emphasized] link]}
+		interpret text
+		@p.document.output.should == %{This is an <a href="#test"><em>emphasized</em> link</a>}
+	end
+
+	it "should store syntax node information in context" do
+		define_em_macro
+		define_ref_macro
+		count = 0
+		Glyph.macro :test_node do |node|
+			node.ascend do |n| 
+				count+=1
+			end
+			node.parent[:macro]
+		end
+		text = %{Test em[test_node[em[test_node[---]]]].}
+		interpret text
+		@p.document.output.should == "Test <em>em</em>."
+		count.should == 8
+	end
+
+	it "should process document.glyph" do
+		interpret file_load(Glyph::PROJECT/'document.glyph')
+		macros = []
+		@p.document.structure.descend do |n, level|
+			macros << {n[:macro] => level} if n[:macro]
+		end
+		macros.should == [{:"@" => 1},{:textile => 2},{:section => 3}, {:header => 4}, 
+			{:"@" => 4}, {:textile => 5}, {:section => 6}, {:header => 7}, 
+			{:"@" => 1}, {:markdown => 2},{:section => 3}, {:header => 4}]
+	end
+
+end