general 1.5.0 → 2.0.0

data/spec/garrayplaceholder_spec.rb

@@ -1,163 +0,0 @@
-# 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/gplaceholder_spec.rb

@@ -1,300 +0,0 @@
-# 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"
-
-# Represents a placeholder partial in a GTemplate
-#
-# Author:  Anshul Kharbanda
-# Created: 7 - 1 - 2016
-describe General::GPlaceholder do
-	before :all do
-		# Placename
-		@placename1 = :plac1
-		@placename2 = :plac2
-		@placename3 = :plac3
-		@placename4 = :plac4
-		@placename5 = :"plac5.subarg"
-
-		# Hash
-		@hash = General::GDotHash.new
-		@hash[@placename1] = "foobar"
-		@hash[@placename3] = "barbaz"
-		@hash[@placename4] = "jujar"
-		@hash[@placename5] = "dudar"
-
-		# Default hash
-		@defaults = General::GDotHash.new
-		
-		# ------------PLACEHOLDER------------
-		@result1 = @hash[@placename1]
-		@partial1 = General::GPlaceholder.new [
-			[:name, @placename1]
-		].to_h, @defaults
-		@string1       = "@(#{@placename1})"
-		@string_first1 = "@(#{@placename1})"
-		@regex1        = "\\k<#{@placename1}>"
-		@regex_first1  = "(?<#{@placename1}>.*)"
-
-		# --------------DEFAULT--------------
-		@default2 = "foo2"
-		@result2  = "foo2"
-		@partial2 = General::GPlaceholder.new [
-			[:name,    @placename2],
-			[:default, @default2]
-		].to_h, @defaults
-		@string2       = "@(#{@placename2})"
-		@string_first2 = "@(#{@placename2}:" \
-					   + " #{@default2})"
-		@regex2        = "\\k<#{@placename2}>"
-		@regex_first2  = "(?<#{@placename2}>.*)"
-		
-		# -------------OPERATION-------------
-		@operation3 = "capitalize"
-		@result3  = General::GOperations.send(
-			@operation3.to_sym, 
-			@hash[@placename3]
-		)
-		@partial3 = General::GPlaceholder.new [
-			[:name, 	 @placename3],
-			[:operation, @operation3]
-		].to_h, @defaults
-		@string3       = "@(#{@placename3})"
-		@string_first3 = "@(#{@placename3}" \
-					   + " -> #{@operation3})"
-		@regex3        = "\\k<#{@placename3}>"
-		@regex_first3  = "(?<#{@placename3}>.*)"
-		
-		# -------------ARGUMENTS-------------
-		@operation4 = "capitalize"
-		@arguments4 = ["all"]
-		@result4 = General::GOperations.send(
-			@operation4.to_sym,
-			@hash[@placename4],
-			*@arguments4
-		)
-		@partial4 = General::GPlaceholder.new [
-			[:name, 	 @placename4],
-			[:operation, @operation4],
-			[:arguments, @arguments4.join(" ")]
-		].to_h, @defaults
-		@string4       = "@(#{@placename4})"
-		@string_first4 = "@(#{@placename4}" \
-					   + " -> #{@operation4} " \
-					   + "#{@arguments4.collect {|s| "\"#{s}\""}.join " "})"
-		@regex4        = "\\k<#{@placename4}>"
-		@regex_first4  = "(?<#{@placename4}>.*)"
-
-		# -----------DOT NOTATION------------
-		keys      = @placename5.to_s.split(".").collect(&:to_sym)
-		@result5  = @hash[keys[0]][keys[1]]
-		@partial5 = General::GPlaceholder.new [
-			[:name,  @placename5]
-		].to_h, @defaults
-		@string5       = "@(#{@placename5})"
-		@string_first5 = "@(#{@placename5})"
-		@regex5        = "\\k<#{@placename5}>"
-		@regex_first5  = "(?<#{@placename5}>.*)"
-	end
-
-	# Describe General::GPlaceholder::new
-	# 
-	# Initializes the GPlaceholder with the given match
-	# 
-	# Parameter: match - the match data from the string being parsed
-	describe '::new' do
-		# -------------------------------------PLACEHOLDER---------------------------------------
-		context 'with name given' do
-			it 'creaes a GPlaceholder with the given name' do
-				expect(@partial1).to be_an_instance_of General::GPlaceholder
-				expect(@partial1.instance_variable_get :@name).to eql @placename1
-				expect(@partial1.instance_variable_get :@operation).to be_nil
-				expect(@partial1.instance_variable_get :@arguments).to be_empty
-			end
-		end
-
-		# ---------------------------------------DEFAULT-----------------------------------------
-		context 'with name and default in match object' do
-			it 'creates a GPlaceholder with the given name and default' do
-				expect(@partial2).to be_an_instance_of General::GPlaceholder
-				expect(@partial2.instance_variable_get :@name).to eql @placename2
-				expect(@partial2.instance_variable_get :@operation).to be_nil
-				expect(@partial2.instance_variable_get :@arguments).to be_empty
-				expect(@defaults[@placename2]).to eql @default2
-			end
-		end
-
-		# --------------------------------------OPERATION----------------------------------------
-		context 'with name, default, and operation in match object' do
-			it 'creates a GPlaceholder with the given name and operation' do
-				expect(@partial3).to be_an_instance_of General::GPlaceholder
-				expect(@partial3.instance_variable_get :@name).to eql @placename3
-				expect(@partial3.instance_variable_get :@operation).to eql @operation3
-				expect(@partial3.instance_variable_get :@arguments).to be_empty
-			end
-		end
-
-		# --------------------------------------ARGUMENTS----------------------------------------
-		context 'with name, default, operation, and arguments in match object' do
-			it 'creates a GPlaceholder with the given name, operation, and arguments' do
-				expect(@partial4).to be_an_instance_of General::GPlaceholder
-				expect(@partial4.instance_variable_get :@name).to eql @placename4
-				expect(@partial4.instance_variable_get :@operation).to eql @operation4
-				expect(@partial4.instance_variable_get :@arguments).to eql @arguments4
-			end
-		end
-
-		# --------------------------------------ARGUMENTS----------------------------------------
-		context 'with dot notation name' do
-			it 'creates a GPlaceholder with the given dot notation name' do
-				expect(@partial5).to be_an_instance_of General::GPlaceholder
-				expect(@partial5.instance_variable_get :@name).to eql @placename5
-				expect(@partial5.instance_variable_get :@operation).to be_nil
-				expect(@partial5.instance_variable_get :@arguments).to be_empty
-			end
-		end
-	end
-
-	# Describe General::GPlaceholder#apply
-	# 
-	# Returns the value of the placeholder in the given data 
-	# with the given operation performed on it
-	#
-	# Parameter: data - the data being applied
-	#
-	# Return: the value of the placeholder in the given data 
-	# 		  with the given operation performed on it
-	describe '#apply' do
-		# -------------------------------------PLACEHOLDER---------------------------------------
-		context 'when name is defined in given data' do
-			it 'returns the value in the data at the name' do
-				expect(@partial1.apply @hash).to eql @result1
-			end
-		end
-
-		# ---------------------------------------DEFAULT-----------------------------------------
-		context 'when name is not defined in given data, but defined in defaults' do
-			it 'returns the value in the default at the name' do
-				expect(@partial2.apply @hash).to eql @result2
-			end
-		end
-
-		# --------------------------------------OPERATION----------------------------------------
-		context 'when an operation is defined' do
-			it 'returns the value in the data/default at the name with the operation applied' do
-				expect(@partial3.apply @hash).to eql @result3
-			end
-		end
-
-		# --------------------------------------ARGUMENTS----------------------------------------
-		context 'when an operation and arguments are defined' do
-			it 'returns the value in the data/default at the name with the operation and arguments applied' do
-				expect(@partial4.apply @hash).to eql @result4
-			end
-		end
-
-		# -------------------------------------DOT NOTATION--------------------------------------
-		context 'when dot notation name is given' do
-			it 'returns the value in the data/default at the dot notation name' do
-				expect(@partial5.apply @hash).to eql @result5
-			end
-		end
-	end
-
-	# Describe General::GTemplate#string
-	#
-	# Returns the string representation of the placeholder
-	#
-	# Parameter: first - true if the placeholder is the first of its kind in the GTemplate
-	#
-	# Return: the string representation of the placeholder
-	describe '#string' do
-		# -------------------------------------NO FIRST---------------------------------------
-		context 'when no first argument specified' do
-			it 'returns the first string representation of the placeholder' do
-				expect(@partial1.string).to eql @string_first1
-				expect(@partial2.string).to eql @string_first2
-				expect(@partial3.string).to eql @string_first3
-				expect(@partial4.string).to eql @string_first4
-			end
-		end
-
-		# --------------------------------------FIRST-----------------------------------------
-		context 'when first argument is specified' do
-			# --------------------------------TRUE--------------------------------
-			context 'when first is true' do
-				it 'returns the first string representation of the placeholder' do
-					expect(@partial1.string true).to eql @string_first1
-					expect(@partial2.string true).to eql @string_first2
-					expect(@partial3.string true).to eql @string_first3
-					expect(@partial4.string true).to eql @string_first4
-				end
-			end
-
-			# --------------------------------FALSE-------------------------------
-			context 'when first is false' do
-				it 'returns the string representation of the placeholder' do
-					expect(@partial1.string false).to eql @string1
-					expect(@partial2.string false).to eql @string2
-					expect(@partial3.string false).to eql @string3
-					expect(@partial4.string false).to eql @string4
-				end
-			end
-		end
-	end
-
-	# Describe General::GTemplate#regex
-	#
-	# Returns the string as a regex
-	#
-	# Parameter: first - true if the placeholder is the first of its kind in the GTemplate
-	#
-	# Returns: the string as a regex
-	describe '#regex' do
-		# -------------------------------------NO FIRST---------------------------------------
-		context 'when no first argument specified' do
-			it 'returns the first regex representation of the placeholder' do
-				expect(@partial1.regex).to eql @regex_first1
-				expect(@partial2.regex).to eql @regex_first2
-				expect(@partial3.regex).to eql @regex_first3
-				expect(@partial4.regex).to eql @regex_first4
-			end
-		end
-
-		# --------------------------------------FIRST-----------------------------------------
-		context 'when first argument is specified' do
-			# --------------------------------TRUE--------------------------------
-			context 'when first is true' do
-				it 'returns the first regex representation of the placeholder' do
-					expect(@partial1.regex true).to eql @regex_first1
-					expect(@partial2.regex true).to eql @regex_first2
-					expect(@partial3.regex true).to eql @regex_first3
-					expect(@partial4.regex true).to eql @regex_first4
-				end
-			end
-
-			# --------------------------------FALSE-------------------------------
-			context 'when first is false' do
-				it 'returns the regex representation of the placeholder' do
-					expect(@partial1.regex false).to eql @regex1
-					expect(@partial2.regex false).to eql @regex2
-					expect(@partial3.regex false).to eql @regex3
-					expect(@partial4.regex false).to eql @regex4
-				end
-			end
-		end
-	end
-end