eggshell 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e4e19e3f5d40c57dfd10437821105c1cb38d836
-  data.tar.gz: d96074a2df9b741327a3a7ebe626afdcab7a27d8
+  metadata.gz: eb6b09972391e525c2214c576105739d3e7e52c3
+  data.tar.gz: 1b244ac23b2f76448562925f5f2ab672f2a2d26c
 SHA512:
-  metadata.gz: a4664c527b16f16c3fe1ad8f908e67e05cc3b11c8b7012fc0224571a184a33d889c2767064da38aca52c48aac2b1d6e520b185af13f7e7d72d104c5df62d705a
-  data.tar.gz: 55e1c0cfc1ec5788ce799446bfd717e9fcd18b211b6fb80ac6453d2c6627246a1abf16de726383a7dcd55434064d6db139f8c488c34bab8e993076e7abe09ea6
+  metadata.gz: e152a0a278690c2b05e1b77e6a62b1ec00287bafc7d1217465d26fee83c2245ff06b8d6014b402d148135d2556ab6086ab93e1a3109c3fbd49fbb03b778b356b
+  data.tar.gz: 714427f89fb5e5bb1ee4db6d4c1b25f324e9ac53fdae1358c16ca0240b19d52c557d548111dc6bfd71e55819612a55067c5411b49c8cc1ea90c8a6ee70a0fc8a

data/bin/eggshell

@@ -1,8 +1,14 @@
 #!/usr/bin/ruby
-helptext = """
-Process Eggshell files from the command line:
+require_relative '../lib/eggshell.rb'
 
+helptext = """Eggshell (ver. #{Eggshell::VERSION})
+#{'-'*80}
+eggshell -h # this
+eggshell -docs # outputs path of sample documents
 eggshell <source> # outputs to console
+"""
+
+helptext_v2 = """
 eggshell <source> out=filename
 eggshell <source> format=format_hint
 
@@ -12,14 +18,26 @@ Note that 'format' parameter hints at the source file (e.g. supplying 'md' loads
 # @todo parse args
 # @todo set output redirect
 
-require_relative '../lib/eggshell.rb'
+if ARGV[0] == '-h'
+	puts helptext
+	exit
+elsif ARGV[0] == '-docs'
+	puts "Eggshell (ver. #{Eggshell::VERSION})", '-'*80, "Example docs are located at:"
+	puts "\t#{File.realpath(File.dirname(__FILE__))}/doc"
+	exit
+end
+
+$stderr.write "Eggshell (ver. #{Eggshell::VERSION})\n#{'-'*80}\n"
 
 f = ARGV[0]
 if !f || !File.exists?(f)
 	puts "Invalid file: #{f}"
+	puts "use '-h' to show usage"
 	exit
 end
 
+Eggshell::Bundles::Registry.log_level(1)
+
 file_dir = File.realdirpath(File.dirname(f))
 $eggshell = Eggshell::Processor.new
 $eggshell.vars[:include_paths] << file_dir

data/lib/eggshell.rb

@@ -1,5 +1,9 @@
 # Eggshell.
 module Eggshell
+	VERSION_MAJOR = 1
+	VERSION_MINOR = 0
+	VERSION_PATCH = 1
+	VERSION = "#{VERSION_MAJOR}.#{VERSION_MINOR}.#{VERSION_PATCH}"
 	# Encapsulates core parts of a line. Handler can use whatever parts are needed to 
 	# construct final output. Line number is provided for error reporting.
 	class Line

data/lib/eggshell/block-handler.rb

@@ -145,13 +145,27 @@ module Eggshell::BlockHandler
 
 	# Useful methods for generating HTML tags
 	module HtmlUtils
-		def create_tag(tag, attribs, open = true)
-			nattribs = attribs.is_a?(Hash) ? attribs.clone : {}
-			if nattribs[BlockParams::STYLE].is_a?(Hash)
-				nattribs[BlockParams::STYLE] = css_string(nattribs[BlockParams::STYLE])
+		def create_tag(tag, attribs, open = true, body = nil)
+			str_attribs = ''
+			if attribs.is_a?(String)
+				str_attribs = attribs
+			else
+				nattribs = attribs.is_a?(Hash) ? attribs.clone : {}
+				if nattribs[BlockParams::STYLE].is_a?(Hash)
+					nattribs[BlockParams::STYLE] = css_string(nattribs[BlockParams::STYLE])
+				end
+				str_attribs = attrib_string(nattribs, BlockParams::KEYS)
 			end
 
-			"<#{tag}#{attrib_string(nattribs, BlockParams::KEYS)}#{open ? '' : '/'}>"
+			if !open
+				return "<#{tag}#{str_attribs}/>"
+			else
+				if body
+					return "<#{tag}#{str_attribs}>#{body}</#{tag}>"
+				else
+					return "<#{tag}#{str_attribs}>"
+				end
+			end
 		end
 
 		def attrib_string(map, keys = nil)

data/lib/eggshell/bundles.rb

@@ -24,6 +24,11 @@ module Eggshell::Bundles
 	# Maintains central registry of bundles.
 	class Registry
 		@@reg = {}
+		@@log_level = 0
+
+		def self.log_level(lvl)
+			@@log_level = lvl
+		end
 
 		def self.register_bundle(bundle, id)
 			if !bundle.respond_to?(:new_instance)
@@ -33,7 +38,7 @@ module Eggshell::Bundles
 
 			if !@@reg[id]
 				@@reg[id] = bundle
-				$stderr.write "registering bundle #{id} => #{bundle}\n"
+				$stderr.write "registering bundle #{id} => #{bundle}\n" if @@log_level > 0
 			else
 				$stderr.write "registering bundle failed: #{id} already registered\n"
 			end

data/lib/eggshell/bundles/basics.rb

@@ -134,6 +134,8 @@ module Eggshell::Bundles::Basic
 
 	"""
 	/head|head
+	!caption:caption text|att=val|att=val
+	!col:att=val|att=val
 	|col|col|col
 	|>col|>col|>col
 	|!@att=val att2=val2@!col|col
@@ -143,22 +145,25 @@ module Eggshell::Bundles::Basic
 		include BH
 		include BH::BlockParams
 		include BH::HtmlUtils
+		include FH::Utils
 		
 		def initialize
 			@block_types = ['table']
 		end
 
 		# @todo support opening row with !@ (which would then get applied to <tr>)
+		# @todo support thead/tbody/tfoot attributes? maybe these things can be handled same as how caption/colgroup is defined
 		DELIM1 = '|'
 		DELIM2 = '|>'
 		HEADER = '/'
+		SPECIAL_DEF = /^!(\w+):(.+$)/
 		CELL_ATTR_START = '!@'
 		CELL_ATTR_IDX = 1
 		CELL_ATTR_END = '@!'
 
 		def can_handle(line)
 			if !@block_type
-				if line.match(/^(table[(.]?|\||\|>|\/)/)
+				if line.match(/^(table[(.]?|\||\|>|\/)/) || line.match(SPECIAL_DEF)
 					@block_type = 'table'
 					return BH::COLLECT
 				end
@@ -167,7 +172,7 @@ module Eggshell::Bundles::Basic
 		end
 
 		def continue_with(line)
-			if line.match(/^(\||\|>|\/)/)
+			if line.match(/^(\||\|>|\/)/) || line.match(SPECIAL_DEF)
 				return BH::COLLECT
 			end
 			return BH::RETRY
@@ -179,34 +184,58 @@ module Eggshell::Bundles::Basic
 			bp = get_block_params(type, args[0])
 			row_classes = bp['row.classes']
 			row_classes = ['odd', 'even'] if !row_classes.is_a?(Array)
+			
+			o_out = out
+			out = []
 
 			@eggshell.vars[T_ROW] = 0
 			out << create_tag('table', bp)
+			out << "%caption%\n%colgroup%"
+			caption = {:text => '', :atts => {}}
+			colgroup = []
+
 			cols = []
 			rows = 0
 			rc = 0
+			data_started = false
+
 			lines.each do |line_obj|
 				ccount = 0
 				line = line_obj.line
-				if line[0] == '/' && rows == 0
+				special = line.match(SPECIAL_DEF)
+				if special
+					type = special[1]
+					atts = special[2]
+					if type == 'caption'
+						text, atts = atts.split('|', 2)
+						caption[:text] = text
+						caption[:attributes] = parse_args(atts, true)[0]
+					else
+						atts = parse_args(atts, true)[0]
+						puts atts.inspect
+						colgroup << create_tag('col', attrib_string(atts), false)
+					end
+				elsif line[0] == '/' && rc == 0
 					cols = line[1..line.length].split('|')
-					out << "<thead><tr class='#{map['head.class']}'>"
+					out << "<thead><tr class='#{bp['head.class']}'>"
 					cols.each do |col|
 						out << "\t#{fmt_cell(col, true, ccount)}"
 						ccount += 1
 					end
 					out << '</tr></thead>'
-					out << '<tbody>'
 				elsif line[0] == '/'
 					# implies footer
+					out << '</tbody>' if rc > 0
 					cols = line[1..line.length].split('|')
-					out << "<tfoot><tr class='#{map['foot.class']}'>"
+					out << "<tfoot><tr class='#{bp['foot.class']}'>"
 					cols.each do |col|
 						out << "\t#{fmt_cell(col, true, ccount)}"
 						ccount += 1
 					end
 					out << '</tr></tfoot>'
+					break
 				elsif line[0] == DELIM1 || line[0..1] == DELIM2
+					out << '<tbody>' if rc == 0
 					idx = 1
 					sep = /(?<!\\)\|/
 					if line[1] == '>'
@@ -229,11 +258,21 @@ module Eggshell::Bundles::Basic
 				rows += 1
 			end
 
-			out << '</tbody>'
-			if cols.length > 0
-				# @todo process footer
-			end
 			out << "</table>"
+
+			if caption[:text] != ''
+				out[1].gsub!('%caption%', create_tag('caption', attrib_string(caption[:attributes]), true, caption[:text]))
+			else
+				out[1].gsub!("%caption%\n", '')
+			end
+
+			if colgroup.length > 0
+				out[1].gsub!('%colgroup%', "<colgroup>\n\t#{colgroup.join("\n\t")}\n</colgroup>")
+			else
+				out[1].gsub("%colgroup%\n", '')
+			end
+			
+			o_out << out.join("\n")
 		end
 
 		def fmt_cell(val, header = false, colnum = 0)

data/lib/eggshell/format-handler.rb

@@ -11,7 +11,7 @@ module Eggshell::FormatHandler
 		end
 	end
 
-	# @param String tag The opening delimeter.
+	# @param String|MatchData tag The opening delimeter.
 	# @param String str The string between delimeters.
 	def format(tag, str)
 	end
@@ -24,10 +24,19 @@ module Eggshell::FormatHandler
 		# piped args are key-value pairs (use `\\|` to escape) which might
 		# be embedded in the tag or signal some further transformations.
 		#
+		# If any contexts don't use direct arguments, set {{no_direct}} to `true`.
+		# This will produce a 1-element array with a map.
+		#
+		# @param String arg_str A pipe-separated argument list, with first argument
+		# interpreted as a direct arguments list.
+		# @param Boolean no_direct If true, doesn't treat first argument as direct
+		# arguments.
 		# @return An array where the last element is always a {{Hash}}
-		def parse_args(arg_str)
+		def parse_args(arg_str, no_direct = false)
+			return [] if !arg_str || arg_str == ''
 			raw_args = arg_str.split(/(?<!\\)\|/)
-			args = raw_args.shift.split(/ ; /)
+			args = []
+			args << raw_args.shift.split(/ ; /) if !no_direct
 			map = {}
 			raw_args.each do |rarg|
 				k, v = rarg.split('=', 2)

data/lib/eggshell/processor.rb

@@ -241,6 +241,9 @@ module Eggshell
 		end
 
 		BH = Eggshell::BlockHandler
+		
+		COMMENT = '#!'
+		DIRECTIVE = '#>'
 
 		def preprocess(lines, line_count = 0)
 			line_start = line_count
@@ -271,7 +274,7 @@ module Eggshell
 					line_count += 1
 
 					hdr = oline.lstrip[0..1]
-					if hdr == '#!'
+					if hdr == COMMENT
 						next
 					end
 
@@ -527,6 +530,7 @@ module Eggshell
 		# 
 		# @param Array tags Each entry should be a 2- or 3-element array in the
 		# following form: {{[open, close[, non_nest]]}}
+		# @todo if opening tag is regex, don't escape (but make sure it doesn't contain {{^}} or {{$}})
 		def add_format_handler(handler, tags)
 			return if !tags.is_a?(Array)
 			

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eggshell
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kaiser Shahid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-19 00:00:00.000000000 Z
+date: 2017-02-20 00:00:00.000000000 Z
 dependencies: []
 description: From fast and basic HTML to complex decouments and more, Eggshell aims
   to provide you with all the document generation power you need through simple markup.