general 1.4.2 → 1.5.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: general
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Anshul Kharbanda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-22 00:00:00.000000000 Z
+date: 2016-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -33,14 +33,30 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
+- Rakefile
+- exp/future.general
+- exp/out.txt
+- exp/sample.general
+- lib/gdothash.rb
 - lib/general.rb
-- lib/gio.rb
 - lib/goperations.rb
-- lib/gpartials.rb
-- lib/gtemplate.rb
-- lib/gtimeformat.rb
-- spec/gio_spec.rb
-- spec/gtemplate_spec.rb
+- lib/gpartials/gpartial.rb
+- lib/gpartials/gplaceholder.rb
+- lib/gpartials/gtext.rb
+- lib/gpartials/gtimeformatplaceholder.rb
+- lib/templates/gbasetemplate.rb
+- lib/templates/gio.rb
+- lib/templates/gtemplate.rb
+- lib/templates/gtimeformat.rb
+- spec/garrayplaceholder_spec.rb
+- spec/gdothash_spec.rb
+- spec/goperations_spec.rb
+- spec/gpartial_spec.rb
+- spec/gplaceholder_spec.rb
+- spec/gtemplates_spec.rb
+- spec/gtext_spec.rb
 - spec/spec_require.rb
 homepage: https://andydevs.github.io/general
 licenses:

data/lib/gpartials.rb

@@ -1,191 +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/>.
-
-# General is a templating system in ruby
-#
-# Author: Anshul Kharbanda
-# Created: 3 - 4 - 2016
-module General
-	private
-
-	# Represents a plain string partial 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, match=nil)
-			@string = match ? string[0...match.begin(0)] : 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 partial 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>[\w+\s+]+))?\)/
-
-		# Read name
-		attr :name
-
-		# Initializes the GPlaceholder 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
-			@name = match[:name].to_sym
-			@operation = match[:operation]
-			@defaults = defaults
-		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
-			# Get value from either data or defaults
-			value = data[@name] || @defaults[@name]
-
-			# Return value (operation performed if one is defined)
-			return (@operation ? General::GOperations.send(@operation, value) : value).to_s
-		end
-
-		# Returns the string representation of the placeholder
-		#
-		# Return: the string representation of the placeholder
-		def to_s
-			str = "@(#{@name}"
-			str += ": #{@defaults[@name]}" if @defaults[@name]
-			str += "-> #{@operation}" if @operation
-			return str + ")"
-		end
-	end
-
-	# Represents an array placeholder partial 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); @template.apply_all(data[@name]).join(@delimeter); end
-
-		# Returns the string representation of the array placeholder
-		#
-		# Return: the string representation of the array placeholder
-		def to_s; "@[#{@name}] #{@template.to_s} @[#{@delimeter.inspect}]"; end
-	end
-
-	# Represents an timeformat placeholder partial in a GTimeFormat
-	#
-	# Author:  Anshul Kharbanda
-	# Created: 7 - 1 - 2016
-	class GTimeFormatPlaceholder
-		# Regular expression that matches timeformat placeholders
-		REGEX = /@(?<type>[A-Z]+)/
-
-		# Read type
-		attr :type
-
-		# Initializes the GTimeFormatPlaceholder with the given match
-		#
-		# Parameter: match - the match data from the string being parsed
-		def initialize(match); @type = match[:type]; end
-
-		# Returns the value of the timeformat placeholder in the given time value
-		# formatted according to the time format type
-		#
-		# 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 type
-		def apply value
-			if value.is_a? Integer
-				map = type_map(value).to_s
-				return is_justify? ? map.rjust(@type.length, '0') : map
-			else
-				raise TypeError.new "Expected Integer, got: #{value.class}"
-			end
-		end
-
-		# Returns true if the timeformat placeholder is a justifiable type
-		#
-		# Return: true if the timeformat placeholder is a justifiable type
-		def is_justify?; "HIMS".include? @type[0]; end
-
-		# Returns the string representation of the timeformat placeholder
-		#
-		# Return: the string representation of the timeformat placeholder
-		def to_s; return "@#{@type}"; end
-
-		private
-
-		# Returns the value modified according to the raw timeformat type
-		#
-		# Parameter: value - the time value being applied
-		#
-		# Return: the value modified according to the raw timeformat type
-		def type_map value
-			case @type[0]
-				when "H" then return (value / 3600)
-				when "I" then return (value / 3600 % 12 + 1)
-				when "M" then return (value % 3600 / 60)
-				when "S" then return (value % 3600 % 60)
-				when "A" then return (value / 3600 > 11 ? 'PM' : 'AM')
-			end
-		end
-	end
-end

data/lib/gtemplate.rb

@@ -1,118 +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 "goperations"
-require_relative "gpartials"
-
-# 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
-		# Creates a GTemplate with the given template string
-		#
-		# Parameter: string - the string being converted to a template
-		def initialize string
-			# The string gets split into partials by placeholder and array template
-			@partials = []
-			@defaults = {}
-
-			parse_string string
-		end
-
-		# Returns a string representation of the string
-		#
-		# Return: a string representation of the string
-		def to_s; @partials.collect(&:to_s).join; 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
-
-		private
-
-		# Returns true if given string has a placeholder
-		#
-		# Parameter: string - the string to check for a placeholder
-		#
-		# Return: true if given string has a placeholder
-		def has_next string
-			next_p = General::GPlaceholder::REGEX      =~ string
-			next_a = General::GArrayPlaceholder::REGEX =~ string
-			return !((next_p.nil? || next_p < 0) && (next_a.nil? || next_a < 0))
-		end
-
-		# Returns true if the next placeholder is an aray placeholder
-		#
-		# Parameter: string - the string to check for an array placeholder
-		#
-		# Return: true if the next placeholder is an aray placeholder
-		def next_array_placeholder string
-			next_p = General::GPlaceholder::REGEX      =~ string
-			next_a = General::GArrayPlaceholder::REGEX =~ string
-			return !(next_a.nil? || next_p.nil?) && next_a < next_p
-		end
-
-		# Parses the string into General template data
-		#
-		# Parameter: string - the string to parse
-		def parse_string string
-			# While there is still a placeholder or array placeholder in string
-			while has_next string
-				# If next is array placeholder, process array placeholder
-				if next_array_placeholder string
-					# Split match and add partials
-					match = General::GArrayPlaceholder::REGEX.match string
-					@partials << General::GPartialString.new(string, match) \
-							  << General::GArrayPlaceholder.new(match)
-
-				# Else process placeholder
-				else
-					# Split match and add partials
-					match = General::GPlaceholder::REGEX.match string
-					@partials << General::GPartialString.new(string, match) \
-							  << General::GPlaceholder.new(match, @defaults)
-					
-					# Push default information
-					@defaults[match[:name].to_sym] ||= match[:default]
-				end
-
-				# Trim string
-				string = string[match.end(0)..-1]
-			end
-			
-			# Add end of string
-			@partials << General::GPartialString.new(string)
-		end
-	end
-end

data/lib/gtimeformat.rb

@@ -1,53 +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 "gtemplate"
-require_relative "gpartials"
-
-# 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 < GTemplate
-		private
-
-		# Parses the given string into GTimeFormat partials
-		#
-		# Parameter: string - the string to parse
-		def parse_string string
-			# While a GTimeFormatPlaceholder remains
-			while !(General::GTimeFormatPlaceholder::REGEX =~ string).nil? \
-				&& (General::GTimeFormatPlaceholder::REGEX =~ string) > -1
-
-				# Split match and add partials
-				match = General::GTimeFormatPlaceholder::REGEX.match string
-				@partials << General::GPartialString.new(string, match) \
-						  << General::GTimeFormatPlaceholder.new(match)
-
-				# Trim string
-				string = string[match.end(0)..-1]
-			end
-
-			# Add end partial of string
-			@partials << General::GPartialString.new(string)
-		end
-	end
-end

data/spec/gio_spec.rb

@@ -1,64 +0,0 @@
-require "spec_require"
-
-describe General::GIO do
-	before :all do
-		@gio = General::GIO.load("exp/sample" + General::GIO::EXTENSION)
-		@out = "exp/out.txt"
-		@phony = 3
-		@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."
-	end
-
-	describe "#new" do
-		it "creates a new GIO with the given template string" do
-			expect(@gio).to be_an_instance_of General::GIO
-		end
-	end
-
-	describe "#write" do
-		context "with target and no 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
-					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 }
-					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) }.to raise_error TypeError
-				end
-			end
-		end
-
-		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, @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, @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, @data) }.to raise_error TypeError
-				end
-			end
-		end
-	end
-end

data/spec/gtemplate_spec.rb

@@ -1,93 +0,0 @@
-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!"
-		@name_applied_text = "There once was a man named Dog. Dog loved Cat Food!"
-		@food_applied_text = "There once was a man named Gordon Ramsay. Gordon Ramsay loved Denny's Fennies!"
-		@data1 = {name: "Joe", food: "Joe's Shmoes"}
-		@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: "Ben", pet: "dog"}, 
-			{name: "Jen", pet: "cat"},
-			{name: "Ken", pet: "plant"}
-		]}
-		@applied_text2 = "Hello, Ben! How is the dog?\nHello, Jen! How is the cat?\nHello, Ken! How is the plant?"
-
-		# General array template and placeholders test
-		@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
-		it "Creates a new GTemplate with the given template string" 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
-
-	describe "#apply" do
-		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_applied_text
-				expect(@template1.apply(food: @food)).to eql @food_applied_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_applied_text
-			end
-		end
-
-		context "with array template" do
-			it "returns the template with the given array data applied and formatted according to the template" do
-				expect(@template2.apply(@data2)).to eql @applied_text2
-			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(@template4.apply(@data4)).to eql @applied_text4
-			end
-		end
-	end
-end