general 1.4.2 → 1.5.0

data/lib/gpartials/gtext.rb

@@ -0,0 +1,93 @@
+# 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"
+
+# General is a templating system in ruby
+#
+# Author: Anshul Kharbanda
+# Created: 3 - 4 - 2016
+module General
+	# Represents a plain text partial in a GTemplate
+	#
+	# Author:  Anshul Kharbanda
+	# Created: 7 - 1 - 2016
+	class GText < GPartial
+		# Regular expression that matches text partials
+		REGEX = /\A[^@]+?(?=(@|\\@|\z))/m
+
+		# The partial name of a text
+		PTNAME = :gpartialstring
+
+		# Initializes the GText with the given match
+		#
+		# Parameter: match - the match object of the GText
+		def initialize(match)
+			super name: PTNAME
+			@text = match.to_s
+		end
+		
+		# Returns the text
+		#
+		# Parameter: data - the data to apply to the partial
+		#
+		# Returns: the text
+		def apply(data); @text; end
+
+		# Returns the text as a string
+		#
+		# Parameter: first - true if this partial is the first of it's kind in a GTemplate
+		#
+		# Returns: the text as a string
+		def string(first=true); @text.inspect[1...-1]; end
+
+		# Returns the text as a regex
+		#
+		# Parameter: first - true if this partial is the first of it's kind in a GTemplate
+		#
+		# 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/gpartials/gtimeformatplaceholder.rb

@@ -0,0 +1,71 @@
+# 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"
+
+# General is a templating system in ruby
+#
+# Author: Anshul Kharbanda
+# Created: 3 - 4 - 2016
+module General
+	# Represents an timeformat placeholder partial in a GTimeFormat
+	#
+	# Author:  Anshul Kharbanda
+	# Created: 7 - 1 - 2016
+	class GTimeFormatPlaceholder < GPartial
+		# Regular expression that matches timeformat placeholders
+		REGEX = /@(?<name>[A-Z]+)/
+
+		# Returns the value of the timeformat placeholder in the given time value
+		# formatted according to the time format name
+		#
+		# Parameter: value - the time value being applied
+		#
+		# Return: the value of the timeformat placeholder in the given time value
+		# 		  formatted according to the time format name
+		def apply value
+			map = name_map(value).to_s
+			return is_justify? ? map.rjust(@name.length, '0') : map
+		end
+
+		# Returns true if the timeformat placeholder is a justifiable name
+		#
+		# Return: true if the timeformat placeholder is a justifiable name
+		def is_justify?; "HIMS".include? @name[0]; end
+
+		# Returns the string representation of the timeformat placeholder
+		#
+		# Return: the string representation of the timeformat placeholder
+		def to_s; "@#{@name}"; end
+
+		private
+
+		# Returns the value modified according to the raw timeformat name
+		#
+		# Parameter: value - the time value being applied
+		#
+		# Return: the value modified according to the raw timeformat name
+		def name_map value
+			case @name[0]
+				when "H" then (value / 3600)
+				when "I" then (value / 3600 % 12 + 1)
+				when "M" then (value % 3600 / 60)
+				when "S" then (value % 3600 % 60)
+				when "A" then (value / 3600 > 11 ? 'PM' : 'AM')
+			end
+		end
+	end
+end

data/lib/templates/gbasetemplate.rb

@@ -0,0 +1,55 @@
+# 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/>.
+
+# General is a templating system in ruby
+#
+# Author: Anshul Kharbanda
+# Created: 3 - 4 - 2016
+module General
+	# The base class for General template objects
+	# Implementing objects must define a :apply method
+	# Which applies the GTemplate to an object
+	#
+	# Author:  Anshul Kharbanda
+	# Created: 7 - 30 - 2016
+	class GBaseTemplate
+		# Initializes the GBaseTemplate with the given string
+		#
+		# Parameter: string - the string to initialize the GBaseTemplate with
+		def initialize string
+			@partials = []
+		end
+
+		# Applies the given data to the template and returns the generated string
+		#
+		# 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
+
+		# Applies each data structure in the array independently to the template
+		# and returns an array of the generated strings
+		#
+		# Parameter: array - the array of data to be applied 
+		# 				     (each data hash will be merged with defaults)
+		#
+		# Return: array of strings generated from the template with the given 
+		# 		  data applied
+		def apply_all array
+			array.collect { |data| apply(data) }
+		end
+	end
+end

data/lib/{gio.rb → templates/gio.rb}

@@ -50,8 +50,7 @@ module General
 			@source = source
 		end
 
-		# Writes the template with the given 
-		# data applied to the target stream
+		# Writes the template with the given data applied to the target stream
 		#
 		# Parameter: ios  - if String, is the name of the file to write to
 		# 					if IO, is the stream to write to

data/lib/templates/gtemplate.rb

@@ -0,0 +1,103 @@
+# 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 "gbasetemplate"
+require_relative "../gpartials/gtext"
+require_relative "../gpartials/gplaceholder"
+
+# General is a templating system in ruby
+#
+# Author: Anshul Kharbanda
+# Created: 3 - 4 - 2016
+module General
+	# Implements the general templating system for strings
+	#
+	# Author: Anshul Kharbanda
+	# Created: 3 - 4 - 2016
+	class GTemplate < GBaseTemplate
+		# Creates a GTemplate with the given template string
+		#
+		# Parameter: string - the string being converted to a template
+		def initialize string
+			super(string)
+			@defaults = General::GDotHash.new
+
+			# The string gets split into partials by placeholder and array template
+			loop do
+				if match = General::GText::REGEX.match(string)
+					@partials << General::GText.new(match)
+				elsif match = General::GSpecial::REGEX.match(string)
+					@partials << General::GSpecial.new(match)
+				elsif match = General::GArrayPlaceholder::REGEX.match(string)
+					@partials << General::GArrayPlaceholder.new(match)
+				elsif match = General::GPlaceholder::REGEX.match(string)
+					@partials << General::GPlaceholder.new(match, @defaults)
+				else
+					return
+				end
+				string = string[match.end(0)..-1]
+			end
+		end
+
+		# Returns a string representation of the string
+		#
+		# Return: a string representation of the string
+		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
+
+		# Returns the string as a regex
+		#
+		# Returns: the string as a regex
+		def regex sub=false
+			first = Hash.new(true); str = ""
+			@partials.each do |part|
+				str += part.regex(first[part.name]);
+				first[part.name] &&= false
+			end
+			return sub ? str : Regexp.new("\\A" + str + "\\z")
+		end
+
+		# Matches the given string against the template and returns the 
+		# collected information. Returns nil if the given string does 
+		# not match.
+		#
+		# If a block is given, it will be run with the generated hash
+		# if the string matches. Alias for:
+		# 
+		# if m = template.match(string)
+		# 	 # Run block
+		# end
+		# 
+		# Parameter: string the string to match
+		# 
+		# Return: Information matched from the string or nil
+		def match string
+			regex.match(string) do |match|
+				hash = match.names.collect { |name|
+					[name.to_sym, match[name.to_sym]]
+				}.to_h
+				yield hash if block_given?
+				return hash
+			end
+		end
+	end
+end

data/lib/templates/gtimeformat.rb

@@ -0,0 +1,62 @@
+# 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 "gbasetemplate"
+require_relative "../gpartials/gtext"
+require_relative "../gpartials/gtimeformatplaceholder"
+
+# General is a templating system in ruby
+#
+# Author: Anshul Kharbanda
+# Created: 3 - 4 - 2016
+module General
+	# A special template used for formatting time strings
+	#
+	# Author:  Anshul Kharbanda
+	# Created: 7 - 2 - 2016
+	class GTimeFormat < GBaseTemplate
+		# Initialize the GTimeFormat with the given string
+		#
+		# Parameter: string - the template string
+		def initialize string
+			super string
+
+			loop do
+				if match = General::GText::REGEX.match(string)
+					@partials << General::GText.new(match)
+				elsif match = General::GTimeFormatPlaceholder::REGEX.match(string)
+					@partials << General::GTimeFormatPlaceholder.new(match)
+				else
+					return
+				end
+				string = string[match.end(0)..-1]
+			end
+		end
+
+		# Applies the given integer value to the template and returns the generated string
+		#
+		# Parameter: value - the value to be applied (as a hash. merges with defaults)
+		#
+		# Return: string of the template with the given value applied
+		def apply value
+			if value.is_a? Integer
+				super value
+			else
+				raise TypeError.new "Expected Integer, got: #{value.class}"
+			end
+		end
+	end
+end

data/spec/garrayplaceholder_spec.rb

@@ -0,0 +1,163 @@
+# 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 "spec_require"
+
+# Describe General::GArrayPlaceholder
+# 
+# Represents an array placeholder partial in a GTemplate
+#
+# Author:  Anshul Kharbanda
+# Created: 7 - 1 - 2016
+describe General::GArrayPlaceholder do
+	before :all do
+		# -----------DATA-----------
+
+		@arrayname1 = :arg
+		@hash = {
+			arg: [
+				{ subarg: "Eeeeyyy" },
+				{ subarg: "Oyyyeee" },
+				{ subarg: "Aaayyyy" }
+			]
+		}
+		
+		@text  = "Subarg: @(subarg)"
+		@regex = "Subarg: (?<subarg>.*)"
+		@delim = "\n"
+
+		# ---------------------------OUTPUT---------------------------
+		
+		@out1 = @hash[@arrayname1]
+				.collect{|e| "Subarg: #{e[:subarg]}"}
+				.join(General::GArrayPlaceholder::DEFAULT_DELIMETER)
+		@out2 = @hash[@arrayname1]
+				.collect{|e| "Subarg: #{e[:subarg]}"}
+				.join(@delim)
+
+		# ------------------------------------------PARTIALS------------------------------------------
+
+		@partial1 = General::GArrayPlaceholder.new name: @arrayname1, text: @text
+		@partial2 = General::GArrayPlaceholder.new name: @arrayname1, text: @text, delimeter: @delim
+
+		# -------------------------------------------STRING-------------------------------------------
+
+		@string1 = "@[#{@arrayname1}] #{@text} @[ ]"
+		@string2 = "@[#{@arrayname1}] #{@text} @[\\n]"
+
+		# -------------------------------------------REGEX--------------------------------------------
+
+		@regex1 = "(?<#{@arrayname1}>(#{@regex}( )?)+)"
+		@regex2 = "(?<#{@arrayname1}>(#{@regex}(\\n)?)+)"
+	end
+
+	# Describe General::GArrayPlaceholder::new
+	# 
+	# Initializes the GPlaceholder with the given match
+	#
+	# Parameter: match - the match data from the string being parsed
+	describe '::new' do
+		context 'with the given name and text' do
+			it 'creates a new GArrayPlaceholder with the given name and text' do
+				expect(@partial1).to be_an_instance_of General::GArrayPlaceholder
+			end
+		end
+
+		context 'with the given name, text, and delimeter' do
+			it 'creates a new GArrayPlaceholder with the given name and text and delimeter' do
+				expect(@partial1).to be_an_instance_of General::GArrayPlaceholder
+			end
+		end
+	end
+
+	# Describe General::GArrayPlaceholder#apply
+	# 
+	# Returns the value of the array placeholder in the given data
+	# formatted by the given GArrayPlaceholder 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 GArrayPlaceholder and joined by the given delimeter
+	describe '#apply' do
+		it 'applies the given data array formatted according to the given GArrayPlaceholder and joined by the delimeter' do
+			expect(@partial1.apply @hash).to eql @out1
+			expect(@partial2.apply @hash).to eql @out2
+		end
+	end
+
+	# Describe General::GArrayPlaceholder#string
+	#
+	# Returns the string representation of the GArrayPlaceholder
+	#
+	# Parameter: first - true if the GArrayPlaceholder is the first of it's time
+	#
+	# Returns: the string representation of the GArrayPlaceholder
+	describe '#string' do
+		context 'with no first argument is given' do
+			it 'returns the string of the GArrayPlaceholder' do
+				expect(@partial1.string).to eql @string1
+				expect(@partial2.string).to eql @string2
+			end
+		end
+
+		context 'with first argument is given' do
+			context 'when first is true' do
+				it 'returns the string of the GArrayPlaceholder' do
+					expect(@partial1.string true).to eql @string1
+					expect(@partial2.string true).to eql @string2
+				end
+			end
+
+			context 'when first is false' do
+				it 'returns the string of the GArrayPlaceholder' do
+					expect(@partial1.string false).to eql @string1
+					expect(@partial2.string false).to eql @string2					
+				end
+			end
+		end
+	end
+
+	# Describe General::GArrayPlaceholder#regex
+	#
+	# Throws TypeError
+	# 
+	# Parameter: first - true if the placeholder is the first of it's kind
+	describe '#regex' do
+		context 'with no first argument is given' do
+			it 'returns the regex of the GArrayPlaceholder' do
+				expect { @partial1.regex }.to raise_error TypeError
+				expect { @partial2.regex }.to raise_error TypeError
+			end
+		end
+
+		context 'with first argument is given' do
+			context 'when first is true' do
+				it 'returns the regex of the GArrayPlaceholder' do
+					expect { @partial1.regex true }.to raise_error TypeError
+					expect { @partial2.regex true }.to raise_error TypeError
+				end
+			end
+
+			context 'when first is false' do
+				it 'returns the regex of the GArrayPlaceholder' do
+					expect { @partial1.regex false }.to raise_error TypeError
+					expect { @partial2.regex false }.to raise_error TypeError					
+				end
+			end
+		end
+	end
+end

data/spec/gdothash_spec.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 "spec_require"
+
+# Describing General::GDotHash
+#
+# Wrapper for hash objects which implements dot notation
+#
+# Author:  Anshul Kharbanda
+# Created: 9 - 27 - 2016
+describe General::GDotHash do
+	before :all do
+		@hash       = {name: {first: "Joe", last: "Schmoe"}}
+		@key1       = :"name.first"
+		@key2       = :"name.middle"
+		@value1     = @hash[:name][:first]
+		@newvalue1  = "Doe"
+		@newvalue2  = "Bobo"
+		@gdothash   = General::GDotHash.new @hash
+	end
+
+	# Describing General::GDotHash::new
+	# 
+	# Initializes the given GDotHash with the given hash
+	#
+	# Parameter: hash - the hash being manipulated
+	describe "::new" do
+		it 'creates a new GDotHash with the given hash' do
+			expect(@gdothash).to be_an_instance_of General::GDotHash
+			expect(@gdothash.instance_variable_get(:@hash)).to eql @hash
+		end
+	end
+
+	# Returns the string representation of the hash
+	#
+	# Return: the string representation of the hash
+	describe '#to_s' do
+		it 'returns the string representation of the given GDotHash' do
+			expect(@gdothash.to_s).to eql @hash.to_s
+		end
+	end
+
+	# Gets the value at the given key
+	#
+	# Parameter: key - the key to return
+	#
+	# Return: the value at the given key
+	describe '#[]' do
+		it 'returns the value addressed by the given dot notation key' do
+			expect(@gdothash[@key1]).to eql @value1
+		end
+	end
+
+	# Sets the given key to the given value
+	# 
+	# Parameter: key   - the key to set
+	# Parameter: value - the value to set
+	describe '#[]=' do
+		context 'if given position exists' do
+			it 'sets the position addressed by the given dot notation key to the given value' do
+				expect { @gdothash[@key1] = @newvalue1 }.not_to raise_error
+				expect(@gdothash[@key1]).to eql @newvalue1
+			end
+		end
+
+		context 'if given position does not exist' do
+			it 'creates position addressed by the given dot notation key in the given hash and sets it to the given value' do
+				expect { @gdothash[@key2] = @newvalue2 }.not_to raise_error
+				expect(@gdothash[@key2]).to eql @newvalue2
+			end
+		end
+	end
+end