general 1.5.0 → 2.0.0

data/lib/gpartials/garrayplaceholder.rb

@@ -0,0 +1,87 @@
+# General is a templating system in ruby
+# Copyright (C) 2016  Anshul Kharbanda
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require_relative "gpartial"
+require_relative "../goperations"
+
+# General is a templating system in ruby
+#
+# Author: Anshul Kharbanda
+# Created: 3 - 4 - 2016
+module General
+	# Represents an array placeholder partial in a GTemplate
+	#
+	# Author:  Anshul Kharbanda
+	# Created: 7 - 1 - 2016
+	class GArrayPlaceholder < GPartial
+		# Regular expression that matches array placeholders
+		REGEX = /\A@\[#{NAME}\s*(#{OPERATION}\s*#{ARGUMENTS}?)?\]( +|\n+)?(?<text>.*?)( +|\n+)?@\[(?<delimeter>.+)?\]/m
+
+		# Default delimeter
+		DEFAULT_DELIMETER = " "
+
+		# Initializes the GArrayPlaceholder with the given match
+		#
+		# Parameter: match - the match data from the string being parsed
+		# Parameter: defaults - the hash of default data from the GTemplate
+		def initialize match, defaults={}
+			super
+			@template = General::GTemplate.new match[:text]
+			@delimeter = match[:delimeter] || DEFAULT_DELIMETER
+			@operation = match[:operation]
+			if match[:arguments]
+				@arguments = match[:arguments].gsub(ARGUMENT).collect { |arg|
+					ARGUMENT.match(arg)[:text]
+				}
+			else
+				@arguments = []
+			end
+		end
+
+		# Returns the value of the array placeholder in the given data
+		# formatted by the given GTemplate and joined by the given delimeter
+		#
+		# Parameter: data - the data being applied
+		#
+		# Return: the value of the array placeholder in the given data
+		# 		  formatted by the given GTemplate and joined by the given delimeter
+		def apply(data)
+			array = (@operation ? General::GOperations.send(@operation, data[@name], *@arguments) : data[@name])
+			return @template.apply_all(array).join(@delimeter)
+		end
+
+		# Throws TypeError
+		# 
+		# Parameter: first - true if the placeholder is the first of it's kind
+		def regex(first=true); raise TypeError.new("Array Templates cannot be matched."); end
+
+		# Returns the string representation of the array placeholder
+		#
+		# Parameter: first - true if the placeholder is the first of it's kind
+		#
+		# Return: the string representation of the array placeholder
+		def string(first=true)
+			str = "@[#{@name}"
+			if @operation
+				str += " -> #{@operation}"
+				unless @arguments.empty?
+					str += @arguments.collect{|s| " \"#{s}\""}.join
+				end
+			end
+			return str + "] #{@template.to_s} @[#{@delimeter.inspect[1...-1]}]"
+		end
+	end
+end

data/lib/gpartials/gfullplaceholder.rb

@@ -0,0 +1,63 @@
+# General is a templating system in ruby
+# Copyright (C) 2016  Anshul Kharbanda
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require_relative "gpartial"
+require_relative "../goperations"
+
+# General is a templating system in ruby
+#
+# Author: Anshul Kharbanda
+# Created: 3 - 4 - 2016
+module General
+	# Inserts the full data value passed into the template
+	#
+	# Author:  Anshul Kharbanda
+	# Created: 1 - 19 - 2016
+	class GFullPlaceholder < GPartial
+		# Matches GFullPlaceholders
+		REGEX = /@#/
+
+		# String representation of GFullPlaceholder
+		STRING = "@#"
+
+		# Initializes the GFullPlaceholder with the given match
+		#
+		# Parameter: match - the match data from the string being parsed
+		# Parameter: defaults - the hash of default data from the GTemplate
+		def initialize(match, defaults={}); super({name: :__full}, defaults); end
+
+		# Returns a string representation of the given data
+		#
+		# Parameter: data - the data being applied
+		#
+		# Returns: a string representation of the given data 
+		def apply(data); data.to_s; end
+
+		# Returns a string representation of the GFullPlaceholder
+		#
+		# Parameter: first - true if this is the first in a given template 
+		#
+		# Returns: a string representation of the GFullPlaceholder
+		def string(first=false); STRING; end
+
+		# Raises TypeError
+		#
+		# Parameter: first - true if this is the first in a given template 
+		#
+		# Raises: TypeError
+		def regex(first=false); raise TypeError.new("GFullPlaceholder cannot be matched"); end
+	end
+end

data/lib/gpartials/gpartial.rb

@@ -27,6 +27,15 @@ module General
 	class GPartial
 		protected
 
+		# Regular expression that matches a single placeholder
+		ARGUMENT = /(?<text>\w+)|((?<qtat>'|")(?<text>.*)\k<qtat>)/
+
+		# Regular expression that matches placeholder arguments
+		ARGUMENTS = /(?<arguments>(#{ARGUMENT}\s*)*)/
+
+		# Regular expression that matches placeholder operations
+		OPERATION = /(->\s*(?<operation>\w+))/
+
 		# Regular expression that matches placeholder names
 		NAME = /(?<name>[a-zA-Z]\w*(\.[a-zA-Z]\w*)*)/
 
@@ -38,6 +47,7 @@ module General
 		# Initializes the GPartial with the given object
 		#
 		# Parameter: obj - the object containing information for the partial
-		def initialize(obj); @name = obj[:name].to_sym; end
+		# Parameter: dft - the hash of default data from the GTemplate
+		def initialize(obj,dft={}); @name = obj[:name].to_sym; end
 	end
 end

data/lib/gpartials/gplaceholder.rb

@@ -29,15 +29,6 @@ module General
 	class GPlaceholder < GPartial
 		private
 
-		# Regular expression that matches a single placeholder
-		ARGUMENT = /(?<text>\w+)|((?<qtat>'|")(?<text>.*)\k<qtat>)/
-
-		# Regular expression that matches placeholder arguments
-		ARGUMENTS = /(?<arguments>(#{ARGUMENT}\s*)*)/
-
-		# Regular expression that matches placeholder operations
-		OPERATION = /(->\s*(?<operation>\w+))/
-
 		# Regular expression that matches placeholder defaults
 		DEFAULT = /(\:\s*(?<default>[^(\-\>)]+))/
 
@@ -51,7 +42,7 @@ module General
 		# Parameter: match    - the match data from the string being parsed
 		# Parameter: defaults - the hash of default data from the GTemplate
 		def initialize match, defaults
-			super match
+			super match, defaults
 			@operation = match[:operation]
 			if match[:arguments]
 				@arguments = match[:arguments].gsub(ARGUMENT).collect { |arg|
@@ -111,46 +102,4 @@ module General
 			return str + ")"
 		end
 	end
-
-	# Represents an array placeholder partial in a GTemplate
-	#
-	# Author:  Anshul Kharbanda
-	# Created: 7 - 1 - 2016
-	class GArrayPlaceholder < GPartial
-		# Regular expression that matches array placeholders
-		REGEX = /\A@\[#{NAME}\]( +|\n+)?(?<text>.*?)( +|\n+)?@\[(?<delimeter>.+)?\]/m
-
-		# Default delimeter
-		DEFAULT_DELIMETER = " "
-
-		# Initializes the GPlaceholder with the given match
-		#
-		# Parameter: match - the match data from the string being parsed
-		def initialize match
-			super
-			@delimeter = match[:delimeter] || DEFAULT_DELIMETER
-			@template = General::GTemplate.new match[:text]
-		end
-
-		# Returns the value of the array placeholder in the given data
-		# formatted by the given GTemplate and joined by the given delimeter
-		#
-		# Parameter: data - the data being applied
-		#
-		# Return: the value of the array placeholder in the given data
-		# 		  formatted by the given GTemplate and joined by the given delimeter
-		def apply(data); @template.apply_all(data[@name]).join(@delimeter); end
-
-		# Throws TypeError
-		# 
-		# Parameter: first - true if the placeholder is the first of it's kind
-		def regex(first=true); raise TypeError.new("Array Templates cannot be matched."); end
-
-		# Returns the string representation of the array placeholder
-		#
-		# Parameter: first - true if the placeholder is the first of it's kind
-		#
-		# Return: the string representation of the array placeholder
-		def string(first=true); "@[#{@name}] #{@template.to_s} @[#{@delimeter.inspect[1...-1]}]"; end
-	end
 end

data/lib/gpartials/gspecial.rb

@@ -0,0 +1,81 @@
+# General is a templating system in ruby
+# Copyright (C) 2016  Anshul Kharbanda
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require_relative "gtext"
+
+# General is a templating system in ruby
+#
+# Author: Anshul Kharbanda
+# Created: 3 - 4 - 2016
+module General
+	# Represents a special character in a GTemplate
+	#
+	# Author:  Anshul Kharbanda
+	# Created: 7 - 29 - 2016
+	class GSpecial < GText
+		# Regular expression that matches special partials
+		REGEX = /\A@(?<key>\w+)\;/
+
+		# Special character information
+		SPECIALS = {
+			at: "@",  pd: "#",
+			lt: "<",  gt: ">",
+			op: "(",  cp: ")",
+			ob: "[",  cb: "]",
+			oc: "{",  cc: "}",
+			ms: "-",  ps: "+", 
+			st: "*",  pc: "%",
+			bs: "\\", fs: "/",
+			dl: "$"
+		}
+
+		# Special regex information
+		REGEXES = {
+			at: /@/,   pd: /#/,
+			lt: /\</, gt: /\>/,
+			op: /\(/, cp: /\)/,
+			ob: /\[/, cb: /\]/,
+			oc: /\{/, cc: /\}/,
+			ms: /\-/, ps: /\+/, 
+			st: /\*/, pc: /\%/,
+			bs: /\\/, fs: /\//,
+			dl: /\$/
+		}
+
+		# Initializes the GSpecial with the given match
+		#
+		# Parameter: match - the match object of the GSpecial
+		# Parameter: defaults - the hash of default data from the GTemplate
+		def initialize(match, defaults={})
+			super SPECIALS[match[:key].to_sym], {}
+			@key = match[:key].to_sym
+		end
+		
+		# Returns the string representation of the GSpecial
+		#
+		# Parameter: first - true if this partial is the first of it's kind in a GTemplate
+		#
+		# Returns: the string representation of the GSpecial
+		def string(first=true); "@#{@key.to_s};"; end
+
+		# Returns the GSpecial as a regex
+		#
+		# Parameter: first - true if this partial is the first of it's kind in a GTemplate
+		#
+		# Returns: the GSpecial as a regex
+		def regex(first=true); REGEXES[@key]; end
+	end
+end

data/lib/gpartials/gtext.rb

@@ -30,13 +30,14 @@ module General
 		REGEX = /\A[^@]+?(?=(@|\\@|\z))/m
 
 		# The partial name of a text
-		PTNAME = :gpartialstring
+		PTNAME = :__text
 
 		# Initializes the GText with the given match
 		#
-		# Parameter: match - the match object of the GText
-		def initialize(match)
-			super name: PTNAME
+		# Parameter: match    - the match object of the GText
+		# Parameter: defaults - the hash of default data from the GTemplate
+		def initialize match, defaults={}
+			super({name: PTNAME}, defaults)
 			@text = match.to_s
 		end
 		
@@ -61,33 +62,4 @@ module General
 		# Returns: the text as a regex
 		def regex(first=true); @text.inspect[1...-1].gsub(/[\.\+\-\*]/) { |s| "\\#{s}" }; end
 	end
-
-	# Represents a special character in a GTemplate
-	#
-	# Author:  Anshul Kharbanda
-	# Created: 7 - 29 - 2016
-	class GSpecial < GText
-		# Regular expression that matches special partials
-		REGEX = /\A@(?<key>\w+)\;/
-
-		# Special character information
-		SPECIALS = {
-			at: "@",  pd: "#",
-			lt: "<",  gt: ">",
-			op: "(",  cp: ")",
-			ob: "[",  cb: "]",
-			oc: "{",  cc: "}",
-			ms: "-",  ps: "+", 
-			st: "*",  pc: "%",
-			bs: "\\", fs: "/",
-			dl: "$",
-		}
-
-		# Initializes the GSpecial with the given match
-		#
-		# Parameter: match - the match object of the GSpecial
-		def initialize(match)
-			super SPECIALS[match[:key].to_sym]
-		end
-	end
 end

data/lib/gprepartials/gextend.rb

@@ -0,0 +1,42 @@
+# General is a templating system in ruby
+# Copyright (C) 2016  Anshul Kharbanda
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Imports
+require_relative "gprepartial"
+require_relative "../gtemplates/gio"
+
+# General is a templating system in ruby
+#
+# Author: Anshul Kharbanda
+# Created: 3 - 4 - 2016
+module General
+	# Includes another file in the template
+	#
+	# Author: Anshul Kharbanda
+	# Created: 1 - 30 - 2017
+	class GExtend < GPrePartial
+		# Regular expression matches GExtend
+		REGEX = /\A@@extend\s+(?<filename>\w+)\r?\n/
+
+		# Read filename
+		attr :filename
+
+		# Creates a new GExtend
+		#
+		# Parameters: match - the match result returned from the parser
+		def initialize(match); super; @filename = match[:filename]; end
+	end
+end

data/lib/gprepartials/ginclude.rb

@@ -0,0 +1,47 @@
+# General is a templating system in ruby
+# Copyright (C) 2016  Anshul Kharbanda
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Imports
+require_relative "gprepartial"
+require_relative "../gtemplates/gio"
+
+# General is a templating system in ruby
+#
+# Author: Anshul Kharbanda
+# Created: 3 - 4 - 2016
+module General
+	# Includes another file in the template
+	#
+	# Author: Anshul Kharbanda
+	# Created: 1 - 30 - 2017
+	class GInclude < GPrePartial
+		# Regular expression matches GInclude
+		REGEX = /\A@@include\s+(?<filename>\w+)\r?\n/
+
+		# Creates a new GInclude
+		#
+		# Parameters: match - the match result returned from the parser
+		def initialize(match)
+			super
+			@filename = match[:filename]
+		end
+
+		# Applies the GInclude
+		#
+		# Return: the value returned from the executed GInclude
+		def apply; IO.read(@filename+General::GIO::EXTENSION) + "\r\n"; end
+	end
+end

data/lib/gprepartials/gprepartial.rb

@@ -0,0 +1,45 @@
+# General is a templating system in ruby
+# Copyright (C) 2016  Anshul Kharbanda
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Imports
+require_relative "../gtemplates/gio"
+
+# General is a templating system in ruby
+#
+# Author: Anshul Kharbanda
+# Created: 3 - 4 - 2016
+module General
+	# Includes another file in the template
+	#
+	# Author: Anshul Kharbanda
+	# Created: 1 - 30 - 2017
+	class GPrePartial
+		# Creates a new GPrePartial
+		#
+		# Parameters: match - the match result returned from the parser
+		def initialize(match); @text = match.to_s; end
+
+		# Applies the GPrePartial
+		#
+		# Return: the value returned from the executed GPrePartial
+		def apply; @text; end
+
+		# Returns the string representation of the GPrePartial
+		#
+		# Return: the string representation of the GPrePartial
+		def to_s; @text; end
+	end
+end

data/lib/gprepartials/gpretext.rb

@@ -0,0 +1,33 @@
+# General is a templating system in ruby
+# Copyright (C) 2016  Anshul Kharbanda
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Imports
+require_relative "gprepartial"
+
+# General is a templating system in ruby
+#
+# Author: Anshul Kharbanda
+# Created: 3 - 4 - 2016
+module General
+	# Matches plain General Text
+	#
+	# Author: Anshul Kharbanda
+	# Created: 1 - 30 - 2017
+	class GPretext < GPrePartial
+		# Regular expression matches GPretext
+		REGEX = /\A(?<text>.+?)(?=@@|\z)/m
+	end
+end

data/lib/gprepartials/gyield.rb

@@ -0,0 +1,33 @@
+# General is a templating system in ruby
+# Copyright (C) 2016  Anshul Kharbanda
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Imports
+require_relative "gprepartial"
+
+# General is a templating system in ruby
+#
+# Author: Anshul Kharbanda
+# Created: 3 - 4 - 2016
+module General
+	# Matches plain General Text
+	#
+	# Author: Anshul Kharbanda
+	# Created: 1 - 30 - 2017
+	class GYield < GPrePartial
+		# Regular expression matches GYield
+		REGEX = /\A@@yield\r?\n/
+	end
+end

data/lib/{templates → gtemplates}/gbasetemplate.rb

@@ -14,6 +14,8 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+require_relative "../gdothash"
+
 # General is a templating system in ruby
 #
 # Author: Anshul Kharbanda
@@ -28,9 +30,31 @@ module General
 	class GBaseTemplate
 		# Initializes the GBaseTemplate with the given string
 		#
-		# Parameter: string - the string to initialize the GBaseTemplate with
-		def initialize string
+		# Parameter: string   - the string to initialize the GBaseTemplate with
+		# Parameter: partials - the partials used to parse the GBaseTemplate string
+		def initialize string, partials
+			# Variables
 			@partials = []
+			@defaults = General::GDotHash.new
+
+			# Partial breakdown algorithm
+			m = nil
+			loop do
+				# Match the front of the string to a partial
+				partial = partials.find { |partial| m = partial::REGEX.match(string) }
+
+				# Raise error if no matching partial can be found
+				raise GError.new("Unmatched partial at #{(string.length <= 5 ? string : string[0..5] + "...").inspect}") if partial.nil?
+				
+				# Add the partial to the array
+				@partials << partial.new(m, @defaults)
+
+				# Trim the front of the string
+				string = string[m.end(0)..-1]
+
+				# End when string is empty
+				return if string.length == 0
+			end
 		end
 
 		# Applies the given data to the template and returns the generated string
@@ -38,7 +62,14 @@ module General
 		# Parameter: data - the data to be applied (as a hash. merges with defaults)
 		#
 		# Return: string of the template with the given data applied
-		def apply(data={}); @partials.collect { |partial| partial.apply(data) }.join; end
+		def apply data={}
+			# Apply generalized data if can be generalized. Else apply regular data
+			if data.respond_to? :generalized
+				return apply(data.generalized)
+			else
+				return @partials.collect { |part| part.apply(data) }.join
+			end
+		end
 
 		# Applies each data structure in the array independently to the template
 		# and returns an array of the generated strings
@@ -51,5 +82,17 @@ module General
 		def apply_all array
 			array.collect { |data| apply(data) }
 		end
+
+		# Returns a string representation of the template
+		#
+		# Return: a string representation of the template
+		def to_s
+			first = Hash.new(true); str = ""
+			@partials.each do |part|
+				str += part.string(first[part.name])
+				first[part.name] &&= false
+			end
+			return str
+		end
 	end
 end