general 1.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1dd9eaba641900ea4e4570380a94b487c9ede48
+  data.tar.gz: 977d55f997291890f0c4c068ade7180fbef8e14e
+SHA512:
+  metadata.gz: 4e1fea13b4dfb11723f4256d1870f96cf6bd72a592f1fb1491cb783123c9cf52c9615bd90983856d7ee751be13291ab1e3666bb225429d22781a172489a94283
+  data.tar.gz: 7bb540fb3b8a4a7f5b47f72429d2d74e46bb947823a42512978c0f31c79e7df7fb4480c507d3db2d36aa62431d08e03fe9cf3df52464a9cbcc535013fae56aa8

data/lib/general.rb

@@ -0,0 +1,2 @@
+require_relative "gtemplate"
+require_relative "gfile"

data/lib/gfile.rb

@@ -0,0 +1,70 @@
+# 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"
+
+# General is a templating system in ruby
+#
+# Author: Anshul Kharbanda
+# Created: 3 - 4 - 2016
+module General
+	# Implements the general file IO
+	#
+	# Author: Anshul Kharbanda
+	# Created: 3 - 4 - 2016
+	class GFile
+		# The general file extention
+		EXTENTION = ".general"
+
+		# Can write to attributes "name" and "path"
+		#
+		# "name" is the name of the target file
+		#
+		# "path" is the path of the target file
+		attr_writer :name, :path
+
+		# Creates a new GFile with the given path
+		#
+		# Paraeter: path the path to the GFile
+		def initialize path
+			@name = File.basename path, EXTENTION
+			@path = File.dirname path
+			@general = General::GTemplate.new IO.read path
+		end
+
+		# Returns the path of the target file
+		#
+		# Return: the path of the target file
+		def target
+			@path + "/" + @name	
+		end
+
+		# Writes the general with the given 
+		# data applied to the target file
+		#
+		# Parameter: data - the data to be applied (merges with defaults)
+		def write data={}
+			IO.write target, @general.apply(data)
+		end
+
+		# Returns the string representation of the GFile
+		#
+		# Return: the string representation of the GFile
+		def to_s
+			"#{@general} >>> #{target}"
+		end
+	end
+end

data/lib/gtemplate.rb

@@ -0,0 +1,152 @@
+# 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 the general templating system for strings
+	#
+	# 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*)\]\s*(?<text>.*?)\s*@\[(?<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)
+
+			parse_string string
+		end
+
+		# Returns a string representation of the string
+		#
+		# Return: a string representation of the string
+		def to_s; @parts.join; end
+
+		# Returns the template with the given data applied
+		#
+		# Parameter: data - the data to be applied (merges with defaults)
+		#
+		# Return: the template with the given data applied
+		def apply data={}
+			applied_data = @defaults.merge data.to_hash
+			applied_parts = @parts.clone
+			applied_data.each do |key, value|
+				if @array[key]
+					@places[key].each do |place|
+						applied_parts[place[:index]] = value.collect {|subvalue| place[:template].apply subvalue}.join(place[:delimeter])
+					end
+				else
+					@places[key].each do |place|
+						applied_parts[place[:index]] = place[:operation].call(value)			
+					end
+				end
+			end
+			return applied_parts.join
+		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_placeholder string
+			return PLACEHOLDER =~ string || ARRAY_PLACEHOLDER =~ string
+		end
+
+		# Parses the string into General template data
+		#
+		# Parameter: string - the string to parse
+		def parse_string string
+			# While match remains in string
+			while has_placeholder string
+				if ARRAY_PLACEHOLDER =~ string
+					# Split match and add parts
+					match = ARRAY_PLACEHOLDER.match string
+					name = match[:name].to_sym
+					@parts << string[0...match.begin(0)] << name
+					string = string[match.end(0)..-1]
+
+					# Get delimeter (if any) and parse array template
+					delimeter = match[:delimeter].nil? ? " " : match[:delimeter]
+					template = GTemplate.new(match[:text])
+
+					# Push place and array information
+					push_place name, {index: @parts.length - 1, template: template, delimeter: delimeter}
+					@array[name] = true
+				elsif PLACEHOLDER =~ string
+					# Split match and add parts
+					match = PLACEHOLDER.match string
+					name = match[:name].to_sym
+					@parts << string[0...match.begin(0)] << name
+					string = string[match.end(0)..-1]
+
+					operation = match[:operation].nil? ? OPERATIONS[:default] : OPERATIONS[match[:operation].to_sym]
+					
+					# Push place and default information
+					push_place name, {index: @parts.length - 1, operation: operation}
+					@defaults[name] = match[:default] unless @defaults.has_key? name
+				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
+		end
+	end
+end

data/spec/gfile_spec.rb

@@ -0,0 +1,60 @@
+require "spec_require"
+
+describe Generic::GFile do
+	before :all do
+		@filepath = "tmp"
+		@filename = "sample.txt"
+		@new_filename = "supersample.txt"
+		@new_filepath = "tmp/supertmp"
+		@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
+
+	before :each do
+		@file = Generic::GFile.new (@filepath + "/" + @filename + Generic::GFile::EXTENTION)
+	end
+
+	describe "#new" do
+		it "Creates a new GFile with the given filename" do
+			expect(@file).to be_an_instance_of Generic::GFile
+			expect(@file.target).to eql (@filepath + "/" + @filename)
+		end
+	end
+
+	describe "#target" do
+		it "Returns the name of the target" do
+			expect(@file.target).to eql (@filepath + "/" + @filename)
+		end
+	end
+
+	describe "#name=" do
+		it "Changes the name of the target" do
+			@file.name = @new_filename
+			expect(@file.target).to eql (@filepath + "/" + @new_filename)
+		end
+	end
+
+	describe "#path=" do
+		it "Changes the path of the target" do
+			@file.path = @new_filepath
+			expect(@file.target).to eql (@new_filepath + "/" + @filename)
+		end
+	end
+
+	describe "#write" do
+		context "With no data" do
+			it "Writes the default data to the target file" do
+				@file.write
+				expect(IO.read(@file.target)).to eql @default_text
+			end
+		end
+
+		context "With given data" do
+			it "Writes the given data to the target file" do
+				@file.write(@data)
+				expect(IO.read(@file.target)).to eql @applied_text
+			end
+		end
+	end
+end

data/spec/gtemplate_spec.rb

@@ -0,0 +1,72 @@
+require "spec_require"
+
+describe Generic::GTemplate do
+	before :all do
+		@template1 = Generic::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"
+
+		@template2 = Generic::GTemplate.new "@[greetings] Hello, @(name)! How is the @(pet)? @[\n]"
+		@data2 = {greetings: [
+			{name: "Joe", pet: "cat"},
+			{name: "Ben", pet: "dog"}, 
+			{name: "Ken", pet: "plant"}
+		]}
+		@applied_text2 = "Hello, Joe! How is the cat?\nHello, Ben! How is the dog?\nHello, Ken! How is the plant?"
+
+		@template3 = Generic::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."
+	end
+
+	describe "#new" do
+		it "Creates a new GTemplate with the given template string" do
+			expect(@template1).to be_an_instance_of Generic::GTemplate
+			expect(@template2).to be_an_instance_of Generic::GTemplate
+			expect(@template3).to be_an_instance_of Generic::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 only name given" do
+			it "Returns the template with the given name and default food applied" do
+				expect(@template1.apply(name: @name)).to eql @name_applied_text
+			end
+		end
+
+		context "With only food given" do
+			it "Returns the template with the default name and given food applied" do
+				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 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
+			end
+		end
+	end
+end

data/spec/spec_require.rb

@@ -0,0 +1,2 @@
+require_relative "../lib/gtemplate"
+require_relative "../lib/gfile"

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: general
+version: !ruby/object:Gem::Version
+  version: 1.2.1
+platform: ruby
+authors:
+- Anshul Kharbanda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-25 00:00:00.000000000 Z
+dependencies: []
+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, read the README for documentation."
+email: akanshul97@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/general.rb
+- lib/gfile.rb
+- lib/gtemplate.rb
+- spec/gfile_spec.rb
+- spec/gtemplate_spec.rb
+- spec/spec_require.rb
+homepage: 
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A templating system for ruby.
+test_files: []