montoc 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b21f5056dce35ad19543567d62658917b4ca6fa
-  data.tar.gz: b58dd2db4fcf5a0490735464a5b9737b63987c90
+  metadata.gz: 64032cbe3ce6bb3550e177855762814a6538b056
+  data.tar.gz: 960325a626edc2850bc4b4cee3f0d6277a402e87
 SHA512:
-  metadata.gz: ae2d125bb40b28b0b47aa86ebd714bf94c559647f100266926513ffee98232ce74889c48ce29f9f884090a02b98dc4ca937a0f18ce266017c23aa3b5c85fc7df
-  data.tar.gz: 14e7feb96ccee786040a67acfa94ad96166f7164702c8d890c23cf4e1598a7e8b9fe77700ce0eb827e88cbdded9fb955dbc3a5a8d8ee54fba8e917ae923e6cf5
+  metadata.gz: cc8e5b9ab88d4e75bf4b57c83d71e6a7f236f33ffd9da8eddc999d7faa41232f713c3ece848110a10bdcd0f943a022829793f822951ab18c739424f683502206
+  data.tar.gz: 7ca648a7c912437ee60c2143d136ec1a6dd72ee7fe4e97177eca82ef2cc2f87cc8c9f2681c531a104cdb10f0514cd2f593259045a189c55e7f716e56391682a7

data/.gitignore

@@ -13,4 +13,5 @@
 *.so
 *.o
 *.a
+*.gem
 mkmf.log

data/lib/montoc.rb

@@ -9,11 +9,9 @@ module Montoc
 
   	def initialize text = ""
   		@text = text
-  		@rows = rows
-  		@columns = columns
   		@format = :virgin
   		yield self if block_given?
-  		self.class.experience self
+  		DocBox.know self
   	end
 
   	# Override Object#to_s, so that puts or other methods call this 
@@ -25,15 +23,15 @@ module Montoc
   		return @text
   	end
 
-  	@@original_text = {}
-  	def self.experience docbox
+  	@original_text = {}
+  	def self.know docbox
   		fresh_key = docbox.object_id.to_s(36).to_sym
-  		@@original_text[fresh_key] = docbox.instance_eval {@text}
+  		@original_text[fresh_key] = docbox.instance_eval {@text}
   	end
   	
-  	def self.remember docbox
+  	def self.recall docbox
   		fresh_key = docbox.object_id.to_s(36).to_sym
-  		return @@original_text[fresh_key]
+  		return @original_text[fresh_key]
   	end
 
   	def + string
@@ -46,22 +44,34 @@ module Montoc
 
   	def text= string
   		@text = string
-  		self.class.experience self
+  		DocBox.know self
   	end
 
   	# Find the longest lines in text and return the first match.
   	# to_s is called from the longest_line to avoid chomp being called
   	# from nil, in the case of text = ""
-  	def longest_line remove_new_line_char = true
+  	# @note Should be used when the @format is still in the :virgin state.
+  	# @return [String] Return the first longest line in text
+  	def longest_line
   		longest_line = squeeze_space.lines.max_by(&:length)
-  		longest_line = longest_line.to_s.chomp if remove_new_line_char
+  		longest_line = longest_line.to_s.chomp
   		return longest_line
   	end
 
+  	# Find the number of lines in a text or the number of rows if you see
+  	# it as a two dimensional matrix of chars.
+  	# @return [Fixnum] Number of lines in a text
   	def rows
   		return @text.lines.length
   	end
 
+  	# Find the contents of a specific row or line of a text.
+  	# @note The specified number should start from 1 to number of rows. It will 
+  	#   return nil if it's more than the total number of rows and raise 
+  	#   ArgumentError if lower than 1.
+  	# @param row_no [Fixnum] Specific row number, between 1 and total number
+  	#   of rows.
+  	# @return [String] Return line at specified row
   	def row row_no = 1
   		raise ArgumentError, "Row number cannot be lower than 1." \
   			if row_no < 1 
@@ -70,10 +80,22 @@ module Montoc
   		return row_text
   	end
 
+  	# Find the length of the longest line or number of columns in a matricized
+  	# text.
+  	# @return [Fixnum] Number of columns in a text
   	def columns
   		return longest_line.length
 		end
 
+		# Find the contents of a specific column of a text.
+  	# @note Should be used in matricized text, otherwise it could return some
+  	#   nil even though the column number specified less than the longest line.
+  	#   The specified number should start from 1 to number of columns. It will 
+  	#   return nil if it's more than the total number of columns and raise 
+  	#   ArgumentError if lower than 1.
+  	# @param col_no [Fixnum] Specific column number, between 1 and total number
+  	#   of rows.
+  	# @return [String] Return string at specified column of matricized text
 		def column col_no = 1
 			raise ArgumentError, "Column number cannot be lower than 1." \
   			if col_no < 1 
@@ -88,18 +110,36 @@ module Montoc
 			return column_text
 		end
 
-		def matricize align = :left, columns = 80
+		# Make the object plain text into a rectangular (two dimensional 
+		#	matrix) text by filling the empty spaces with spaces.
+		# @note This will do nothing if the text is already a matrix
+		# @param align [Symbol] The alignment or format state, the default
+		#   is `:left`
+		# @param columns [Fixnum] Number of columns to which the plain text
+		#   converted.
+		# @return [DocBox, nil] The DocBox object after the content/text made
+		#   into matrix or nil if the text is already a matrix before this
+		#   method called.
+		def matricize align = :left, column_width = 72
   		if !matrix?
-  			reflow! columns
+  			reflow! column_width
   			method(align.id2name + "!").call
   		end
   	end
 
-  	def matricize! align = :left, columns = 80
+  	# Force making/remaking an object text into a matrix no matter it's 
+  	# already a matrix or not.
+  	# @param (see #matricize)
+  	# @return [DocBox] The DocBox object after the content/text made into
+		#   matrix.
+  	def matricize! align = :left, column_width = 72
   		squeeze_space!
-  		matricize align, columns
+  		matricize align, column_width
   	end
 
+  	# Check if the object text is already a matrix. 
+  	# @return [Boolean] Return `true` if the text already a matrix and
+  	#   `false` if not.
   	def matrix?
   		@text.each_line do |line|
   			return false if line.to_s.chomp.length != columns
@@ -107,7 +147,11 @@ module Montoc
   		return true
   	end
 
-  	def matrix align = :left, columns = 80
+  	# Make two dimensional array of chars from the current object text
+  	# @param (see #matricize)
+  	# @return [Array] Return two dimensional array of chars from the
+  	#   current object text
+  	def matrix align = :left, columns = 72
   		matricize align, columns
   		matrix_arr = []
   		@text.each_line.with_index do |line, index|
@@ -118,7 +162,7 @@ module Montoc
 
   	def virginize
   		@format = :virgin
-  		@text = self.class.remember self
+  		@text = DocBox.recall self
   		return self
   	end
 
@@ -127,18 +171,19 @@ module Montoc
   		return false
   	end
 
+
 		def left
 			new_text = squeeze_space.split("\n").map do |line|
 				line = line.to_s.ljust columns
 			end .join "\n"
-			return self.class.new(new_text)
+			return DocBox.new(new_text)
 		end
 
 		def right
 			new_text = squeeze_space.split("\n").map do |line|
 				line = line.chomp.strip.rjust columns
 			end .join "\n"
-			return self.class.new(new_text)
+			return DocBox.new(new_text)
 		end
 
 		def center
@@ -146,7 +191,7 @@ module Montoc
 				line = line.chomp.strip.rjust columns-(columns-line.length)/2
 				line = line.ljust columns
 			end .join "\n"
-			return self.class.new(new_text)
+			return DocBox.new(new_text)
 		end
 
 		def squeeze_space
@@ -268,7 +313,7 @@ module Montoc
 			newer_text.chomp!
 
 			# return new object with new text
-			return self.class.new(newer_text)
+			return DocBox.new(newer_text)
 		end
 
 		def justify! left_align_EOP = true
@@ -282,7 +327,7 @@ module Montoc
 			return longest_word
 		end
 
-		def reflow column_width = `echo $COLUMNS`.to_i
+		def reflow column_width = 72
 			raise ArgumentError, "Columns cannot be shorter than the longest word." \
 				if columns < longest_word.length
 			new_text = ""
@@ -308,15 +353,15 @@ module Montoc
 			new_text = new_paragraph.join("\n")
 
 			unless @format == :virgin
-				new_text = self.class.new(new_text).method(@format).call.text
+				new_text = DocBox.new(new_text).method(@format).call.text
 			else
-				return self.class.new(new_text).left # default alignment
+				return DocBox.new(new_text).left # default alignment
 			end
 
-			return self.class.new(new_text)
+			return DocBox.new(new_text)
 		end
 
-		def reflow! column_width = `echo $COLUMNS`.to_i
+		def reflow! column_width = 72
 			obj = reflow(column_width)
 			@text = obj.text
 			@format = obj.format

data/lib/montoc/version.rb

@@ -1,3 +1,3 @@
 module Montoc
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: montoc
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Adrian Setyadi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-12 00:00:00.000000000 Z
+date: 2014-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler