general 1.2.8 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fc766e79d0ec1c3e71a07ac54fa1193b3b88c43
-  data.tar.gz: fa31d5069f16b9bcf189fcefd01d170d95cf5866
+  metadata.gz: c8069e0ce29ba1633760f2ddcf5ad50e7dbfb007
+  data.tar.gz: bd9199ea2c9b5ee9622466672c8282cc8f14e88b
 SHA512:
-  metadata.gz: b4075d13c08a615e5c2a8b98e25cefce84f4204cd934e89b1f69950d93b1584521b8b3a44513cbb7db94b3892834940463a53006c6ae8a34536c65a4eb54b9fc
-  data.tar.gz: 5e5d75fa9e38506bd9422f9a6879dcbdfa369c85857f20707b999c0e7b7cae0e5df0856453687b0369a50e7810d8c6b17f7cf1bd4e06d7010674d99a62810e5d
+  metadata.gz: 7519b19cf990fd5ddeff22eaca88233396a1130ad56bf78573965cc64cbe6932046c8a588075c5d9a6695dcd7235dd56b69b71091007480853ef951d02950bb9
+  data.tar.gz: c3837725bbe8a263debe367d500f9e60ef0f984edbe3576e01187ec0cd2783a603851f9dee4b6fe10ecdfa4bc32578eeed5768fafa3c3cfbd5ac612f76a62b82

data/lib/general.rb

@@ -15,4 +15,5 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require_relative "gtemplate"
-require_relative "gfile"
+require_relative "gtimeformat"
+require_relative "gio"

data/lib/{gfile.rb → gio.rb}

@@ -21,50 +21,40 @@ require_relative "gtemplate"
 # Author: Anshul Kharbanda
 # Created: 3 - 4 - 2016
 module General
-	# Implements the general file IO
+	# Implements the general IO writer template
 	#
 	# Author: Anshul Kharbanda
 	# Created: 3 - 4 - 2016
-	class GFile
-		# The general file extention
-		EXTENTION = ".general"
+	class GIO < GTemplate
+		# The general file extension
+		EXTENSION = ".general"
 
-		# Can write to attributes "name" and "path"
+		# Loads a GIO from a file with the given path
 		#
-		# "name" is the name of the target file
+		# Parameter: path - the path of the file to load
 		#
-		# "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	
+		# Return: GIO loaded from the file
+		def self.load path
+			file = File.new path
+			gio = self.new file.read
+			file.close
+			return gio
 		end
 
-		# Writes the general with the given 
-		# data applied to the target file
+		# 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)
-		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}"
+		def write ios, data={}
+			if ios.is_a? String
+				IO.write ios, apply(data)
+			elsif ios.is_a? IO
+				ios.write apply(data)
+			else
+				raise TypeError.new "Expected IO or String, got: #{ios.class}"
+			end
 		end
 	end
 end

data/lib/goperations.rb

@@ -68,13 +68,13 @@ module General
 			end
 		end
 
-		# Returns the integer time value (in seconds) formatted to H:MM:SS
+		# Returns the integer time value (in seconds) formatted to I:MM:SS A
 		#
-		# Parameter: integer - the integer being formatted (representing the time in second)
+		# Parameter: integer - the integer being formatted (representing the time in seconds)
 		#
-		# Return: the formatted H:MM:SS
-		def self.hourminsec integer
-			return format_time "H:MM:SS", integer
+		# Return: the formatted I:MM:SS A
+		def self.time integer
+			return format_time "I:MM:SS A", integer
 		end
 
 		private

data/lib/gpartials.rb

@@ -21,7 +21,7 @@
 module General
 	private
 
-	# Represents a plain string part in a GTemplate
+	# Represents a plain string partial in a GTemplate
 	#
 	# Author:  Anshul Kharbanda
 	# Created: 7 - 1 - 2016
@@ -48,7 +48,7 @@ module General
 		end
 	end
 
-	# Represents a placeholder part in a GTemplate
+	# Represents a placeholder partial in a GTemplate
 	#
 	# Author:  Anshul Kharbanda
 	# Created: 7 - 1 - 2016
@@ -92,7 +92,7 @@ module General
 		end
 	end
 
-	# Represents an array placeholder part in a GTemplate
+	# Represents an array placeholder partial in a GTemplate
 	#
 	# Author:  Anshul Kharbanda
 	# Created: 7 - 1 - 2016
@@ -125,5 +125,74 @@ module General
 		def apply data
 			return @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
+			return "@[#{@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

@@ -41,29 +41,23 @@ module General
 		# Returns a string representation of the string
 		#
 		# Return: a string representation of the string
-		def to_s
-			return @partials.collect(&:to_s).join
-		end
+		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={}
-			return @partials.collect { |partial| partial.apply(data) }.join
-		end
+		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: data_array - the array of data to be applied 
+		# 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 data_array
-			return data_array.collect { |data| apply(data) }
-		end
+		def apply_all(array); array.collect { |data| apply(data) }; end
 
 		private
 

data/spec/gio_spec.rb

@@ -0,0 +1,64 @@
+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

@@ -21,6 +21,7 @@ describe General::GTemplate do
 		]}
 		@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',
@@ -52,44 +53,39 @@ describe General::GTemplate do
 	end
 
 	describe "#apply" do
-		context "With no data" do
-			it "Returns the template with the default data applied" 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
+		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
-			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
+		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
+		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
+		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 
+		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

data/spec/spec_require.rb

@@ -1,2 +1,3 @@
 require_relative "../lib/gtemplate"
-require_relative "../lib/gfile"
+require_relative "../lib/gio"
+require_relative "../lib/gtimeformat"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: general
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.3.0
 platform: ruby
 authors:
 - Anshul Kharbanda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-02 00:00:00.000000000 Z
+date: 2016-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -34,11 +34,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/general.rb
-- lib/gfile.rb
+- lib/gio.rb
 - lib/goperations.rb
 - lib/gpartials.rb
 - lib/gtemplate.rb
-- spec/gfile_spec.rb
+- spec/gio_spec.rb
 - spec/gtemplate_spec.rb
 - spec/spec_require.rb
 homepage: https://andydevs.github.io/general

data/spec/gfile_spec.rb

@@ -1,59 +0,0 @@
-require "spec_require"
-
-describe General::GFile do
-	before :all do
-		@filepath = "exp"
-		@filename = "sample.txt"
-		@new_filename = "supersample.txt"
-		@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."
-	end
-
-	before :each do
-		@file = General::GFile.new (@filepath + "/" + @filename + General::GFile::EXTENTION)
-	end
-
-	describe "#new" do
-		it "Creates a new GFile with the given filename" do
-			expect(@file).to be_an_instance_of General::GFile
-		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