general 1.4.2 → 1.5.0

data/spec/gtemplates_spec.rb

@@ -0,0 +1,480 @@
+# 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 "spec_require"
+
+# Describe General Templates
+#
+# The system of templates in General
+#
+# Author: Anshul Kharbanda
+# Created: 3 - 4 - 2016
+describe 'General Templates' do
+	# Describe General::GTemplate
+	#
+	# Implements the general templating system for strings
+	#
+	# Author: Anshul Kharbanda
+	# Created: 3 - 4 - 2016
+	describe General::GTemplate do
+		# Before all
+		before :all do
+			@template1 = General::GTemplate.new "There once was a man named @(name: Gordon Ramsay). @(name) loved @(food: Cat Food)!"
+			@template2 = General::GTemplate.new "@(user)@at;@(domain)"
+			@template3 = General::GTemplate.new "@[greetings] Hello, @(name)! How is the @(pet)? @[\n]"
+			@template4 = General::GTemplate.new "@(film: The Dark Knight)\nCrew:\n@[crew] \t@(name): @(role) @[\n]\nScore: @(score)/10"
+			@template5 = General::GTemplate.new "There once was a dog named @(name: dog -> capitalize). @(name -> capitalize) earned @(amount -> money) last week."
+			@template6 = General::GTemplate.new "There once was a cat named @(name -> capitalize all)."
+			@template7 = General::GTemplate.new "The time is @(time -> time)"
+			@template8 = General::GTemplate.new "The time is @(time -> time '@SS <- @MM <- @HH')"
+			@template9 = General::GTemplate.new "The name's @(name.last)... @(name.first) @(name.last)."
+		end
+
+		# Describe General::GTemplate::new
+		#
+		# Creates a GTemplate with the given template string
+		#
+		# Parameter: string - the string being converted to a template
+		describe "::new" do
+			it "creates a new GTemplate with the given template string" do
+				[@template1, @template2, @template3, 
+				 @template4, @template5, @template6, 
+				 @template7, @template8, @template9]
+				.each do |template|
+					expect(template).to be_an_instance_of General::GTemplate
+				end
+			end
+		end
+
+		# Describe General::GTemplate#apply
+		#
+		# 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
+		describe "#apply" do
+			# ------------------------------------BASIC PLACEHOLDER------------------------------------
+
+			# Test basic @(name: default) placeholder
+			context 'with a general template' do
+				# --------------------------------DATA--------------------------------
+
+				before :all do
+					@data1 = {name: "Joe", food: "Joe's Shmoes"}
+					@name  = "Dog"
+					@food  = "Denny's Fennies"
+
+					@default_text = "There once was a man named Gordon Ramsay. Gordon Ramsay loved Cat Food!"
+					@name_text = "There once was a man named Dog. Dog loved Cat Food!"
+					@food_text = "There once was a man named Gordon Ramsay. Gordon Ramsay loved Denny's Fennies!"
+					@all_text = "There once was a man named Joe. Joe loved Joe's Shmoes!"
+				end
+
+				# --------------------------------TEST--------------------------------
+
+				context "with no data" do
+					it "returns the template with the default data applied" do
+						expect(@template1.apply).to eql @default_text
+					end
+				end
+
+				context "with partial data" do
+					it "returns the template with the given data applied to corresponding placeholders and default data applied to the rest" do
+						expect(@template1.apply name: @name).to eql @name_text
+						expect(@template1.apply food: @food).to eql @food_text
+					end
+				end
+
+				context "with all data" do
+					it "returns the template with the given data applied" do
+						expect(@template1.apply @data1).to eql @all_text
+					end
+				end
+			end
+
+			# ------------------------------------SPECIAL CHARACTERS------------------------------------
+
+			# Test special characters
+			context 'with general special characters' do
+				# --------------------------------DATA--------------------------------
+
+				before :all do
+					@data2 = { user: "hillary", domain: "clinton.org" }
+					@text2 = "hillary@clinton.org"
+				end
+
+				# --------------------------------TEST--------------------------------
+
+				it 'returns the templae with the given data applied (including the @ character)' do
+					expect(@template2.apply @data2).to eql @text2
+				end
+			end
+
+			# ------------------------------------ARRAY TEMPLATE------------------------------------
+
+			# Test array template
+			context "with array template" do
+				# --------------------------------DATA--------------------------------
+				before :all do
+					@data3 = {
+						greetings: [
+							{name: "Ben", pet: "dog"}, 
+							{name: "Jen", pet: "cat"},
+							{name: "Ken", pet: "plant"}
+						]
+					}
+					@text3 = "Hello, Ben! How is the dog?\nHello, Jen! How is the cat?\nHello, Ken! How is the plant?"
+
+					@data4 = {
+						film: 'Batman Begins',
+						crew: [
+							{name: 'David S. Goyer', role: 'Writer'},
+							{name: 'Chris Nolan',    role: 'Director'},
+							{name: 'Wally Pfister',  role: 'Director of Photography'},
+							{name: 'Michael Caine',  role: 'Alfred Pennyworth'},
+							{name: 'Christian Bale', role: 'Bruce Wayne/Batman'}
+						],
+						score: 10
+					}
+					@text4 = "Batman Begins\nCrew:\n\tDavid S. Goyer: Writer\n\tChris Nolan: Director\n\tWally Pfister: Director of Photography" \
+									 "\n\tMichael Caine: Alfred Pennyworth\n\tChristian Bale: Bruce Wayne/Batman\nScore: 10/10"
+				end
+
+				# --------------------------------TEST--------------------------------
+
+				context 'with no placeholder' do
+					it "returns the template with the given array data applied and formatted according to the template" do
+						expect(@template3.apply @data3).to eql @text3
+					end
+				end
+
+				context 'with regular placeholder' do
+					it "returns the template with the given data applied (including array data) and formatted according to the template" do
+						expect(@template4.apply @data4).to eql @text4
+					end
+				end
+			end
+
+			# ------------------------------------OPERATIONS------------------------------------
+
+			context "with placeholder operation" do
+				# --------------------------------DATA--------------------------------
+
+				before :all do
+					@data5 = {name: "cat", amount: 19999}
+					@text5 = "There once was a dog named Cat. Cat earned $199.99 last week."
+
+					@data6 = {name: "joe schmoe"}
+					@text6 = "There once was a cat named Joe Schmoe."
+
+					hrs = 3
+					min = 14
+					sec = 12
+					pm = true
+
+					@data78 = {
+						time: ( ((pm ? 11 : 0) + hrs)*3600 + min*60 + sec )
+					}
+
+					@text7 = "The time is #{hrs}:#{min.to_s.rjust(2,'0')}:#{sec.to_s.rjust(2,'0')} #{pm ? 'PM' : 'AM'}"
+					@text8 = "The time is #{sec.to_s.rjust(2,'0')} <- #{min.to_s.rjust(2,'0')} <- #{((pm ? 11 : 0) + hrs).to_s.rjust(2,'0')}"
+				end
+
+				# --------------------------------TEST--------------------------------
+
+				context 'with no arguments' do
+					it "returns the template with the given data applied and formatted according to the format operations" do 
+						expect(@template5.apply @data5).to eql @text5
+						expect(@template7.apply @data78).to eql @text7
+					end
+				end
+
+				context 'with arguments' do
+					it 'returns the template with the given data applied and formatted according to the format operations and arguments' do
+						expect(@template6.apply @data6).to eql @text6
+						expect(@template8.apply @data78).to eql @text8
+					end
+				end
+			end
+
+			# ------------------------------------DOT NOTATION------------------------------------
+
+			context "with dot notation" do
+				# --------------------------------DATA--------------------------------
+
+				before :all do
+					@data9 = General::GDotHash.new name: {first: "Gordon", last: "Ramsay"}
+					@text9 = "The name's Ramsay... Gordon Ramsay."
+				end
+
+				# --------------------------------TEST--------------------------------
+
+				it "returns the template with the given data applied appropriately" do 
+					expect(@template9.apply @data9).to eql @text9
+				end
+			end
+		end
+
+		# Describe General::GTemplate#apply_all
+		#
+		# 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
+		describe '#apply_all' do
+			before :all do
+				@data5 = [
+					{name: "Joe",   food: "Joe's Schmoes"},
+					{name: "Jane",  food: "Jane's Danes"},
+					{name: "Denny", food: "Denny's Fennies"}
+				]
+
+				@text5 = [
+					"There once was a man named Joe. Joe loved Joe's Schmoes!",
+					"There once was a man named Jane. Jane loved Jane's Danes!",
+					"There once was a man named Denny. Denny loved Denny's Fennies!"	
+				]
+			end
+
+			it 'applies all the values in the data array individually' do
+				expect(@template1.apply_all @data5).to eql @text5
+			end
+		end
+
+		# Describe General::GTemplate#regex
+		# 
+		# Returns the string as a regex
+		#
+		# Parameter: sub - true if the template is part of array template
+		#
+		# Returns: the string as a regex
+		describe '#regex' do
+			before :all do
+				@regex1 = /\AThere once was a man named (?<name>.*)\. \k<name> loved (?<food>.*)!\z/
+				@sub_regex1 = "There once was a man named (?<name>.*)\\. \\k<name> loved (?<food>.*)!"
+			end
+
+			context 'if template is not part of array template' do
+				it 'returns the regex created from the GTemplate' do
+					expect(@template1.regex).to eql @regex1
+				end
+			end
+
+			context 'if template is part of array template' do
+				it 'returns the sub regex string created from the GTemplate' do
+					expect(@template1.regex true).to eql @sub_regex1
+				end
+			end
+		end
+
+		# Describe General::GTemplate#match
+		#
+		# 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
+		describe '#match' do
+			context 'when the given string matches the template regex' do
+				it 'returns the data generated from the string' do
+					expect(@template1.match @all_text).to eql @data1
+				end
+			end
+
+			context 'when the given string does not match the template regex' do
+				it 'returns nil' do
+					expect(@template1.match "").to be_nil
+				end
+			end
+
+			context 'with a block given' do
+				it 'passes the hash to the given block' do
+					expect { 
+						@template1.match @all_text do |hash|
+							expect(hash).to eql @data1
+						end
+					}.not_to raise_error
+				end
+			end
+		end
+	end
+
+	# Describe General::GIO
+	#
+	# Implements the general IO writer template
+	#
+	# Author: Anshul Kharbanda
+	# Created: 3 - 4 - 2016
+	describe General::GIO do
+		before :all do
+			@gio = General::GIO.load("exp/sample" + General::GIO::EXTENSION)
+			@out = "exp/out.txt"
+			@phony = 3
+			@default_data = {place: "virginia"}
+			@applied_data = {name: "joe", food: "Joe's Schmoes", place: "kentucky"}
+			@default_text = "There once was a chef name Gordon Ramsay, and he loved eating carrots. He went to Virginia."
+			@applied_text = "There once was a chef name Joe, and he loved eating Joe's Schmoes. He went to Kentucky."
+		end
+
+		# Describe General::GIO::load
+		#
+		# Loads a GIO from a file with the given path
+		#
+		# Parameter: path - the path of the file to load
+		#
+		# Return: GIO loaded from the file
+		describe "::load" do
+			it "creates a new GIO with the given template string" do
+				expect(@gio).to be_an_instance_of General::GIO
+			end
+		end
+
+		# Describe General::GIO#write
+		# 
+		# 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
+		# Parameter: data - the data to be applied (merges with defaults)
+		describe "#write" do
+			# -------------------------------------------DEFAULT-------------------------------------------
+
+			context "with target and default data" do
+				context 'if target is string' do
+					it "writes the default data to the file with the given filename (the target string)" do
+						@gio.write @out, @default_data
+						expect(IO.read(@out)).to eql @default_text
+					end
+				end
+
+				context 'if target is io' do
+					it "writes the default data to the target io" do
+						File.open(@out, "w+") { |ios| @gio.write ios, @default_data }
+						expect(IO.read(@out)).to eql @default_text
+					end
+				end
+
+				context 'if target is not string or io' do
+					it "raises TypeError" do
+						expect{ @gio.write @phony, @default_data }.to raise_error TypeError
+					end
+				end
+			end
+
+			# --------------------------------------------DATA---------------------------------------------
+
+			context "with target and given data" do
+				context 'if target is string' do
+					it "writes the given data to the file with the given filename (the target string)" do
+						@gio.write @out, @applied_data
+						expect(IO.read(@out)).to eql @applied_text
+					end
+				end
+
+				context 'if target is io' do
+					it "writes the given data to the target io" do
+						File.open(@out, "w+") { |ios| @gio.write ios, @applied_data }
+						expect(IO.read(@out)).to eql @applied_text
+					end
+				end
+
+				context 'if target is not string or io' do
+					it "raises TypeError" do
+						expect{ @gio.write @phony, @applied_data }.to raise_error TypeError
+					end
+				end
+			end
+		end
+	end
+
+	# Describe General::GTimeFormat
+	# 
+	# A special template used for formatting time strings
+	#
+	# Author:  Anshul Kharbanda
+	# Created: 7 - 2 - 2016
+	describe General::GTimeFormat do
+		before :all do
+			# Time value
+			@time = (11 + 3)*3600 + 42*60 + 9
+
+			# Phony value
+			@phony = {data: "Time, Yo!"}
+
+			# Formats
+			@format1 = General::GTimeFormat.new "@HH:@MM:@SS"
+			@format2 = General::GTimeFormat.new "@I:@MM:@S @A"
+			@format3 = General::GTimeFormat.new "@SS - @M - @H (@I @A)"
+
+			# Applied values
+			@applied1 = "14:42:09"
+			@applied2 = "3:42:9 PM"
+			@applied3 = "09 - 42 - 14 (3 PM)"
+		end
+
+		# Describe General::GTimeFormat::new
+		# 
+		# Creates the GTimeFormat with the given string
+		#
+		# Parameter: string - the template string
+		describe "::new" do
+			it "creates a new GTimeFormat with the given format string" do
+				expect(@format1).to be_an_instance_of General::GTimeFormat
+				expect(@format2).to be_an_instance_of General::GTimeFormat
+				expect(@format3).to be_an_instance_of General::GTimeFormat
+			end
+		end
+
+		# Describe General::GTimeFormat#apply
+		# 
+		# 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
+		describe "#apply" do
+			context "with integer time value given" do
+				it "returns the given value formatted according to the time format" do
+					expect(@format1.apply(@time)).to eql @applied1
+					expect(@format2.apply(@time)).to eql @applied2
+					expect(@format3.apply(@time)).to eql @applied3
+				end
+			end
+
+			context "if value given is not integer" do
+				it "raises TypeError" do
+					expect{ @format1.apply(@phony) }.to raise_error TypeError
+					expect{ @format2.apply(@phony) }.to raise_error TypeError
+					expect{ @format3.apply(@phony) }.to raise_error TypeError
+				end
+			end
+		end
+	end
+end

data/spec/gtext_spec.rb

@@ -0,0 +1,150 @@
+# 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 Text Partials
+#
+# Regular text parts of a General Template
+#
+# Author:  Anshul Kharbanda
+# Created: 7 - 29 - 2016
+describe 'General Text Partials' do
+	# Describe General::GText
+	# 
+	# Represents a plain text partial in a GTemplate
+	#
+	# Author:  Anshul Kharbanda
+	# Created: 7 - 1 - 2016
+	describe General::GText do
+		before :all do
+			@text = "foobar"
+			@regex = "foobar"
+			@partial = General::GText.new @text
+		end
+
+		# Describe General::GText::new
+		# 
+		# Creates the GText with the given match
+		#
+		# Parameter: match - the match object of the GText
+		describe '::new' do
+			it 'creates the GText with the given to_s representable object' do
+				expect(@partial).to be_an_instance_of General::GText
+				expect(@partial.name).to eql General::GText::PTNAME
+				expect(@partial.instance_variable_get :@text).to eql @text
+			end
+		end
+
+		# Describe General::GText#apply
+		#
+		# Returns the text
+		#
+		# Parameter: data - the data to apply to the partial
+		#
+		# Returns: the text
+		describe '#apply' do
+			it 'returns the GText string, given a hash of data' do
+				expect(@partial.apply @hash).to eql @text
+			end
+		end
+
+		# Describe General::GText#string
+		#
+		# 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
+		describe '#string' do
+			context 'with no first argument given' do
+				it 'returns the string' do
+					expect(@partial.string).to eql @text
+				end
+			end
+
+			context 'with first argument given' do
+				context 'if first argument is true' do
+					it 'returns the string' do
+						expect(@partial.string true).to eql @text
+					end
+				end
+
+				context 'if first argument is false' do
+					it 'returns the string' do
+						expect(@partial.string false).to eql @text
+					end
+				end
+			end
+		end
+
+		# Describe General::GText#regex
+		# 
+		# 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
+		describe '#regex' do
+			context 'with no first argument given' do
+				it 'returns the regex' do
+					expect(@partial.regex).to eql @regex
+				end
+			end
+
+			context 'with first argument given' do
+				context 'if first argument is true' do
+					it 'returns the regex' do
+						expect(@partial.regex true).to eql @regex
+					end
+				end
+
+				context 'if first argument is false' do
+					it 'returns the regex' do
+						expect(@partial.regex false).to eql @regex
+					end
+				end
+			end
+		end
+	end
+
+	# Describe General::GSpecial
+	# 
+	# Represents a special character in a GTemplate
+	#
+	# Author:  Anshul Kharbanda
+	# Created: 7 - 1 - 2016
+	describe General::GSpecial do
+		before :all do
+			@text    = "@"
+			@regex   = "@"
+			@partial = General::GSpecial.new key: "at"
+		end
+
+		# Describe General::GSpecial::new
+		# 
+		# Creates the GSpecial with the given match
+		#
+		# Parameter: match - the match object of the GSpecial
+		describe '::new' do
+			it 'creates the GSpecial with the given match object' do
+				expect(@partial).to be_an_instance_of General::GSpecial
+				expect(@partial.name).to eql General::GSpecial::PTNAME
+				expect(@partial.instance_variable_get :@text).to eql @text
+			end
+		end
+	end
+end

data/spec/spec_require.rb

@@ -1,3 +1,25 @@
-require_relative "../lib/gtemplate"
-require_relative "../lib/gio"
-require_relative "../lib/gtimeformat"
+# 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 "../lib/gdothash"
+require_relative "../lib/goperations"
+require_relative "../lib/gpartials/gpartial"
+require_relative "../lib/gpartials/gtext"
+require_relative "../lib/gpartials/gplaceholder"
+require_relative "../lib/gpartials/gpartial"
+require_relative "../lib/templates/gtemplate"
+require_relative "../lib/templates/gio"
+require_relative "../lib/templates/gtimeformat"