general 1.2.6 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51f768f306c5565ab2f45487258f72573084c4fb
-  data.tar.gz: b0d5eb3ba4272fa0ea2eca4d6d77eb643c12ba7c
+  metadata.gz: a561694d495a4822d409b79ee059bed5a7aa2d70
+  data.tar.gz: 77160aa8d9d951cf91988cd482796c50b564ff72
 SHA512:
-  metadata.gz: dc98ec51f6b552c5b1dcd78395385fb7f6a294c3503566e16bde090f6887b8f97f5d5fb8c88617fb062b8bbcc7146f84d348649f3bc10abc323190864b479813
-  data.tar.gz: 6adddc64463bb8a49c2c59b410049137e0393997c4de2dabf4f5c5092888537a86cba2d8907ffab849f5a36a6bfc3fc7532f01a6d1e60cb80cb3d2125db80984
+  metadata.gz: 9cf196acb87edb9afe1f21ed2dbc4754bef11395999d0776fe48563e6f491328ac347a0ad5a23e24221324abefdbb931de087df3dfcc39b4fe0aa54024c49b52
+  data.tar.gz: d6d2e2bd5869732dc2677f9176d6bd9796e0743d863c11aa097d3245923877e97e2b6a95683be8ab9219d045da70d72d6959d0f46a8639f95517c9b24b44b7b3

data/lib/general.rb

@@ -1,2 +1,18 @@
+# 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 "gtemplate"
 require_relative "gfile"

data/lib/goperations.rb

@@ -0,0 +1,95 @@
+# 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
+	# Implements placeholder operations
+	#
+	# Author: Anshul Kharbanda
+	# Created: 6 - 3 - 2016
+	module GOperations
+		#-----------------------------------STRING OPERATIONS------------------------------------
+
+		# Capitalizes every word in the string
+		#
+		# Parameter: string - the string being capitalized
+		#
+		# Return: the capitalized string
+		def self.capitalize string
+			return string.split(' ').collect(&:capitalize).join(' ')
+		end
+
+		# Converts every letter in the string to uppercase
+		#
+		# Parameter: string - the string being uppercased
+		#
+		# Return: the uppercased string
+		def self.uppercase string
+			return string.upcase
+		end
+
+		# Converts every letter in the string to lowercase
+		#
+		# Parameter: string - the string being lowercased
+		#
+		# Return: the lowercased string
+		def self.lowercase string
+			return string.downcase
+		end
+
+		#-----------------------------------INTEGER OPERATIONS------------------------------------
+
+		# Returns the integer monetary value (in cents) formatted to USD
+		#
+		# Parameter: integer - the integer being formatted (representing the amount in cents)
+		#
+		# Return: the formatted USD amount
+		def self.dollars integer
+			if integer < 0
+				return "-$" + (integer * -0.01).to_s
+			else
+				return '$' + (integer * 0.01).to_s
+			end
+		end
+
+		# Returns the integer time value (in seconds) formatted to H:MM:SS
+		#
+		# Parameter: integer - the integer being formatted (representing the time in second)
+		#
+		# Return: the formatted H:MM:SS
+		def self.hourminsec integer
+			return format_time "H:MM:SS", integer
+		end
+
+		private
+
+		def self.format_time formatter, value
+			return formatter
+				.sub(/II/, (value / 3600 % 12 + 1).to_s.rjust(2, '0'))
+				.sub(/HH/, (value / 3600).to_s.rjust(2, '0'))
+				.sub(/MM/, (value % 3600 / 60).to_s.rjust(2, '0'))
+				.sub(/SS/, (value % 3600 % 60).to_s.rjust(2, '0'))
+				.sub(/I/, (value / 3600 % 12 + 1).to_s)
+				.sub(/H/, (value / 3600).to_s)
+				.sub(/M/, (value % 3600 / 60).to_s)
+				.sub(/S/, (value % 3600 % 60).to_s)
+				.sub(/A/, value / 3600 > 12 ? 'PM' : 'AM')
+		end
+	end
+end

data/lib/gpartials.rb

@@ -0,0 +1,127 @@
+# 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
+	private
+
+	# Represents a plain string part in a GTemplate
+	#
+	# Author:  Anshul Kharbanda
+	# Created: 7 - 1 - 2016
+	class GPartialString
+		# Initializes the GPartialString with the given string
+		#
+		# Parameter: string - the string value of the GPartialString
+		def initialize(string)
+			@string = string
+		end
+		
+		# Returns the string
+		#
+		# Returns: the string
+		def apply data
+			@string
+		end
+
+		# Returns the string
+		#
+		# Returns: the string
+		def to_s
+			@string
+		end
+	end
+
+	# Represents a placeholder part in a GTemplate
+	#
+	# Author:  Anshul Kharbanda
+	# Created: 7 - 1 - 2016
+	class GPlaceholder
+		# Regular expression that matches placeholders
+		REGEX = /@\((?<name>[a-zA-Z]\w*)\s*(\:\s*(?<default>.*?))?\s*(->\s*(?<operation>[a-zA-Z]\w*))?\)/
+
+		# Read name
+		attr :name
+
+		# Initializes the GPlaceholder with the given match
+		#
+		# Parameter: match - the match data from the string being parsed
+		def initialize match
+			@name = match[:name].to_sym
+			@operation = match[:operation]
+		end
+
+		# 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
+		def apply data
+			if @operation
+				return General::GOperations.send(@operation, data[@name]).to_s
+			else
+				return data[@name].to_s
+			end
+		end
+
+		# Returns the string representation of the placeholder
+		#
+		# Return: the string representation of the placeholder
+		def to_s
+			return "@(#{@name} -> #{@operation})"
+		end
+	end
+
+	# Represents an array placeholder part in a GTemplate
+	#
+	# Author:  Anshul Kharbanda
+	# Created: 7 - 1 - 2016
+	class GArrayPlaceholder
+		# Regular expression that matches array placeholders
+		REGEX = /@\[(?<name>[a-zA-Z]\w*)\]( +|\n+)?(?<text>.*?)( +|\n+)?@\[(?<delimeter>.+)?\]/m
+
+		# Default delimeter
+		DEFAULT_DELIMETER = " "
+
+		# Read name
+		attr :name
+
+		# Initializes the GPlaceholder with the given match
+		#
+		# Parameter: match - the match data from the string being parsed
+		def initialize match
+			@name = match[:name].to_sym
+			@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
+			return @template.apply_all(data[@name]).join(@delimeter)
+		end
+	end
+end

data/lib/gtemplate.rb

@@ -14,6 +14,9 @@
 # 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 "goperations"
+require_relative "gpartials"
+
 # General is a templating system in ruby
 #
 # Author: Anshul Kharbanda
@@ -24,38 +27,13 @@ module General
 	# Author: Anshul Kharbanda
 	# Created: 3 - 4 - 2016
 	class GTemplate
-		# Regular expression that matches placeholders
-		PLACEHOLDER = /@\((?<name>[a-zA-Z]\w*)\s*(\:\s*(?<default>.*?))?\s*(->\s*(?<operation>[a-zA-Z]\w*))?\)/
-
-		# Regular expression that matches array placeholders
-		ARRAY_PLACEHOLDER = /@\[(?<name>[a-zA-Z]\w*)\]( |\n)?(?<text>.*?)( |\n)?@\[(?<delimeter>.+)?\]/m
-
-		# Operations that can be called on placeholder values
-		OPERATIONS = {
-			# String operations
-			default: 	  lambda { |string| return string },
-			capitalize:   lambda { |string| return string.split(" ")
-													   	 .collect(&:capitalize)
-													   	 .join(" ") },
-			uppercase:    lambda { |string| return string.uppercase },
-			lowercase:    lambda { |string| return string.lowercase },
-
-			# Integer operations
-			dollars: 	  lambda { |integer| return "$" + (integer * 0.01).to_s },
-			hourminsec:   lambda { |integer| return (integer / 3600).to_s \
-											+ ":" + (integer % 3600 / 60).to_s \
-											+ ":" + (integer % 3600 % 60).to_s }
-		}
-
 		# Creates a GTemplate with the given template string
 		#
 		# Parameter: string - the string being converted to a template
 		def initialize string
-			@parts    	= []
-			@places   	= {}
-			@defaults 	= {}
-			@operation  = {}
-			@array    	= Hash.new(false)
+			# The string gets split into parts by placeholder and array template
+			@parts    		   = []
+			@defaults 		   = {}
 
 			parse_string string
 		end
@@ -63,7 +41,7 @@ module General
 		# Returns a string representation of the string
 		#
 		# Return: a string representation of the string
-		def to_s; @parts.join; end
+		def to_s; @parts.collect(&:to_s).join; end
 
 		# Applies the given data to the template and returns the generated string
 		#
@@ -71,22 +49,11 @@ module General
 		#
 		# Return: string of the template with the given data applied
 		def apply data={}
+			# Create applied data and parts
 			applied_data = @defaults.merge data.to_hash
-			applied_parts = @parts.clone
-			applied_data.each do |key, value|
-				if @places.has_key? key
-					@places[key].each do |place|
-						if @array[key]
-							applied_parts[place[:index]] = place[:template].apply_all(value).join(place[:delimeter])
-						else
-							applied_parts[place[:index]] = OPERATIONS[place[:operation]].call(value)			
-						end
-					end
-				else
-					throw "Placeholder is not defined in template: @(#{key})"
-				end
-			end
-			return applied_parts.join
+
+			# Apply each part
+			return @parts.inject("") { |string, part| string += part.apply(applied_data) }
 		end
 
 		# Applies each data structure in the array independently to the template
@@ -97,11 +64,7 @@ module General
 		#
 		# Return: array of strings generated from the template with the given data applied
 		def apply_all data_array
-			string_array = []
-			data_array.each do |data|
-				string_array << apply(data)
-			end
-			return string_array
+			return data_array.collect { |data| apply(data) }
 		end
 
 		private
@@ -112,7 +75,9 @@ module General
 		#
 		# Return: true if given string has a placeholder
 		def has_placeholder string
-			return PLACEHOLDER =~ string || ARRAY_PLACEHOLDER =~ string
+			placeholder = General::GPlaceholder::REGEX =~ string
+			array_placeholder = General::GArrayPlaceholder::REGEX =~ string
+			return !placeholder.nil? && placeholder > -1 || !array_placeholder.nil? && array_placeholder > -1
 		end
 
 		# Parses the string into General template data
@@ -122,67 +87,43 @@ module General
 			# While there is still a placeholder in string
 			while has_placeholder string
 				# Find locations of next placeholder and next array placeholder
-				next_p = PLACEHOLDER =~ string
-				next_a = ARRAY_PLACEHOLDER =~ string
+				next_p = General::GPlaceholder::REGEX =~ string
+				next_a = General::GArrayPlaceholder::REGEX =~ string
 
 				# If found at least one
 				if !(next_a.nil? && next_p.nil?)
 
 					# If found only array placeholder (or if found array placeholder before placeholder)
 					# Process placeholder
-					if next_p.nil? && !next_a.nil? || !(next_a.nil? || next_p.nil?) && next_a < next_p
-						# Split match and add parts
-						match = ARRAY_PLACEHOLDER.match string
-						@parts << string[0...match.begin(0)] << match[:name].to_sym
-						string = string[match.end(0)..-1]
-
-						# Get name
-						name = match[:name].to_sym
-
-						# Get delimeter (if any) and parse array template
-						delimeter = match[:delimeter].nil? ? " " : match[:delimeter]
-						template = GTemplate.new(match[:text])
+					if !(next_a.nil? || next_p.nil?) && next_a < next_p || next_p.nil?
+						# Split match and add part
+						match = General::GArrayPlaceholder::REGEX.match string
+						@parts << General::GPartialString.new(string[0...match.begin(0)])
 
-						# Push place and array information
-						push_place name, {index: @parts.length - 1, template: template, delimeter: delimeter}
-						@array[name] = true
+						# Push array template
+						@parts << General::GArrayPlaceholder.new(match)
 
-					# If found only array placeholder (or if found array placeholder before placeholder)
+					# If found only placeholder (or if found placeholder before array placeholder)
 					# Process placeholder
-					elsif next_a.nil? && !next_p.nil? || !(next_a.nil? || next_p.nil?) && next_p < next_a
-						# Split match and add parts
-						match = PLACEHOLDER.match string
-						@parts << string[0...match.begin(0)] << match[:name].to_sym
-						string = string[match.end(0)..-1]
-
-						# Get name
-						name = match[:name].to_sym
+					elsif !(next_a.nil? || next_p.nil?) && next_p < next_a || next_a.nil?
+						# Split match and add previous part
+						match = General::GPlaceholder::REGEX.match string
+						@parts << General::GPartialString.new(string[0...match.begin(0)])
 
-						# Get operation and arguments (if any)
-						operation = match[:operation].nil? ? :default : match[:operation].to_sym
+						# Add placeholder
+						@parts << General::GPlaceholder.new(match)
 						
-						# Push place and default information
-						push_place name, {index: @parts.length - 1, operation: operation}
-						@defaults[name] = match[:default] unless @defaults.has_key? name
-
+						# Push default information
+						@defaults[match[:name].to_sym] ||= match[:default]
 					end
+
+					# Trim string
+					string = string[match.end(0)..-1]
 				end
 			end
 			
 			# Add end of string
-			@parts << string
-		end
-
-		# Adds the given place for the placeholder of the given name
-		#
-		# Parameter: name  - the name of the placeholder add a place to
-		# Parameter: place - the place information to add
-		def push_place name, place
-			if @places.has_key? name
-				@places[name] << place
-			else
-				@places[name] = [place]
-			end
+			@parts << General::GPartialString.new(string)
 		end
 	end
 end

data/spec/gfile_spec.rb

@@ -2,10 +2,10 @@ require "spec_require"
 
 describe General::GFile do
 	before :all do
-		@filepath = "tmp"
+		@filepath = "exp"
 		@filename = "sample.txt"
 		@new_filename = "supersample.txt"
-		@new_filepath = "tmp/supertmp"
+		@new_filepath = "exp/superexp"
 		@data = {name: "joe", food: "Joe's Schmoes"}
 		@default_text = "There once was a chef name Gordon Ramsay, and he loved eating carrots."
 		@applied_text = "There once was a chef name Joe, and he loved eating Joe's Schmoes."
@@ -18,7 +18,6 @@ describe General::GFile do
 	describe "#new" do
 		it "Creates a new GFile with the given filename" do
 			expect(@file).to be_an_instance_of General::GFile
-			expect(@file.target).to eql (@filepath + "/" + @filename)
 		end
 	end
 

data/spec/gtemplate_spec.rb

@@ -2,6 +2,7 @@ require "spec_require"
 
 describe General::GTemplate do
 	before :all do
+		# General template test
 		@template1 = General::GTemplate.new "There once was a man named @(name: Gordon Ramsay). @(name) loved @(food: Cat Food)!"
 		@default_text      = "There once was a man named Gordon Ramsay. Gordon Ramsay loved Cat Food!"
 		@all_applied_text  = "There once was a man named Joe. Joe loved Joe's Shmoes!"
@@ -11,17 +12,34 @@ describe General::GTemplate do
 		@name = "Dog"
 		@food = "Denny's Fennies"
 
+		# General array template test
 		@template2 = General::GTemplate.new "@[greetings] Hello, @(name)! How is the @(pet)? @[\n]"
 		@data2 = {greetings: [
-			{name: "Joe", pet: "cat"},
 			{name: "Ben", pet: "dog"}, 
+			{name: "Jen", pet: "cat"},
 			{name: "Ken", pet: "plant"}
 		]}
-		@applied_text2 = "Hello, Joe! How is the cat?\nHello, Ben! How is the dog?\nHello, Ken! How is the plant?"
+		@applied_text2 = "Hello, Ben! How is the dog?\nHello, Jen! How is the cat?\nHello, Ken! How is the plant?"
 
-		@template3 = General::GTemplate.new "There once was a dog named @(name: dog -> capitalize). @(name -> capitalize) earned @(amount -> dollars) last week."
-		@data3 = {name: "cat", amount: 19999}
-		@applied_text3 = "There once was a dog named Cat. Cat earned $199.99 last week."
+		@template3 = General::GTemplate.new "@(film: The Dark Knight)\nCrew:\n@[crew] \t@(name): @(role) @[\n]\nScore: @(score)/10"
+		@data3 = {
+			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
+		}
+		@applied_text3 = "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"
+
+		# General operations test
+		@template4 = General::GTemplate.new "There once was a dog named @(name: dog -> capitalize). @(name -> capitalize) earned @(amount -> dollars) last week."
+		@data4 = {name: "cat", amount: 19999}
+		@applied_text4 = "There once was a dog named Cat. Cat earned $199.99 last week."
 	end
 
 	describe "#new" do
@@ -29,6 +47,7 @@ describe General::GTemplate do
 			expect(@template1).to be_an_instance_of General::GTemplate
 			expect(@template2).to be_an_instance_of General::GTemplate
 			expect(@template3).to be_an_instance_of General::GTemplate
+			expect(@template4).to be_an_instance_of General::GTemplate
 		end
 	end
 
@@ -63,9 +82,15 @@ describe General::GTemplate do
 			end
 		end
 
+		context "With array template and regular placeholder" do
+			it "Returns the template with the given data applied (including array data) and formatted according to the template" do
+				expect(@template3.apply(@data3)).to eql @applied_text3
+			end
+		end
+
 		context "With placeholder operation" do
 			it "Returns the template with the given array data applied and formatted according to the format operations" do 
-				expect(@template3.apply(@data3)).to eql @applied_text3
+				expect(@template4.apply(@data4)).to eql @applied_text4
 			end
 		end
 	end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: general
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.2.7
 platform: ruby
 authors:
 - Anshul Kharbanda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-29 00:00:00.000000000 Z
+date: 2016-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,10 +24,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-description: "General is a simple templating system in ruby that allows you to create
-  templates from both \t\t\t\t\t\tpure strings and files (with the extension .general),
-  as well as create new strings and files \t\t\t\t\t\twith these created objects.
-  For more information, visit the homepage"
+description: General is a simple templating system in ruby that allows you to create
+  templates from bothpure strings and files (with the extension .general), as well
+  as create new strings and fileswith these created objects. For more information,
+  visit the homepage
 email: akanshul97@gmail.com
 executables: []
 extensions: []
@@ -35,6 +35,8 @@ extra_rdoc_files: []
 files:
 - lib/general.rb
 - lib/gfile.rb
+- lib/goperations.rb
+- lib/gpartials.rb
 - lib/gtemplate.rb
 - spec/gfile_spec.rb
 - spec/gtemplate_spec.rb