commentbox 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c075de18d6c7e47412397f8429b95a4ccf4a510915c412912fecb899ea3c6e37
-  data.tar.gz: 293ef1564eed9d108736d08284df7cc9d7e8f04961e0918fc5be062071d0e7ba
+  metadata.gz: 1ebd9f2c2594225bc341c2f5fe19c715ffbf5cb9baa10282738218f7aae49f5b
+  data.tar.gz: 9b6a3e592d4208f27392d03f74a8e9efcb0a7edd41557695a4b4e9b0e805506f
 SHA512:
-  metadata.gz: 544071b2459e49a38323151808d87d172d0e29785cddb4aa54ef708a74479c93bcfe0a61f13791d672d0c1d38308b59acc9f6e3943f9ed2f669f18c43c9fd8ba
-  data.tar.gz: a5ff842476987796f19f49b0523986e559b5868f3200b8fcf0b6b129407f4d43afeb87a87c43d5cede01ac66cfc842df1194e2502811a0d75fb173969584be6f
+  metadata.gz: b9fc9afd9b06cbb135e0bb0d43602b8e330d43409669d3c0a327b15009f44e8a46c0a4cbcd9cee70025608ea8ca1f2a429e36225b327101218c1b5dbfe37b98f
+  data.tar.gz: f2abc7f8fcdb3d98e1dc280a491e78eda83064bdd8e8aee0e775e7582b9238d41be48df936905ae390179037cbe99dc09c76cf5d7cbb5358ecf75a27e1029cf2

data/lib/commentbox.rb

@@ -1,10 +1,12 @@
+
 module CommentBoxStyles
-private
 	DefaultParams = {
 		style:       :stub,
 		padding:     4,
 		stretch:     0,
 		offset:      2,
+		# TODO next. some people may want their boxes to all be the same width
+		min_width:   0,
 		spacelines:  true,
 		alignment:  :left
 	}
@@ -15,6 +17,8 @@ private
 			evenlines: ['/ ', ' /'],
 			oddcorners: ['=/','/=']
 		},
+		# i should rename this to parallax
+		# what a cool name
 		bars: {
 			hlines: '==',
 			oddlines: ['||', '||'],
@@ -36,12 +40,12 @@ private
 	}
 end
 
-
 module CommentBoxIntegerExtensions
 	def is_even?
 		self % 2 == 0
 	end
 end
+
 module CommentBoxStringExtensions
 	Integer.prepend CommentBoxIntegerExtensions
 	def justify_to (length)
@@ -73,11 +77,30 @@ end
 class CommentBox
 	String.prepend CommentBoxStringExtensions # string align/justify methods
 	Integer.prepend CommentBoxIntegerExtensions # integer is_even? method
-	include CommentBoxStyles
+	@@default_params = CommentBoxStyles::DefaultParams
+	@@styles = CommentBoxStyles::Styles
+
+	# class methods for messing with default values
+	def self.default_params; @@default_params end
+	def self.default_params=(value); @@default_params = value end
+	def self.set_default_params (value = {}); value.each { |key, val| @@default_params[key] = val } end
+	def self.styles; @@styles end
+	def self.add_style(value)
+		value.each do |key, val|
+			if val[:default] || val[:default?] 
+				@@default_params[:style] = key
+				break # set the first default we find and stop the madness immediately
+			end
+		end
+		# I could attempt to remove a :default? key here but it doesn't matter
+		@@styles.merge! value
+	end
 	
+	# instance setter methods
 	attr_writer :padding, :spacelines, :alignment, :offset
 	# I don't know how to call param= methods from the inside so I just use a set_param in private
-	def text= (value); set_text value; self end; def alignment= (value); set_alignment value; self end
+	def text= (value); set_text value; self end;
+	def alignment= (value); set_alignment value; self end
 	def style= (value); set_style value; self end
 	# there is no @stretch, stretch is just added to @max_line_length
 	# but, if stretch= is called, then @max_line_length must be recalculated
@@ -86,7 +109,8 @@ class CommentBox
 		if !@max_line_length.is_even? then @max_line_length += 1 end
 	self end
 
-	def initialize (params) # params: {text: String or Array, style: Symbol, padding: Integer, spacelines: Boolean, alignment: Symbol or Array}
+	# needs more reliance on setter methods. changing instance variables after initialization is a total house of cards right now
+	def initialize (params) # params: {text: String or Array, style: Symbol, padding: Integer, spacelines: Boolean, alignment: Symbol or Array, and some others}
 		# for now require an argument of some sort
 		if params.class != Hash && params.class != String then raise 'CommentBox#initialize : you gotta initialize this with Hash or String.' end
 		
@@ -94,20 +118,22 @@ class CommentBox
 		if params.is_a? String then params = {text: params} end 
 
 		# fill in a bunch of instance variables from params or default values
-		# style_symbol = params[:style] || DefaultParams[:style]; @style = Styles[style_symbol]
-		@padding = params[:padding] || DefaultParams[:padding]
-		@offset = params[:offset] || DefaultParams[:offset]
+		@padding = params[:padding] || @@default_params[:padding]
+		@offset = params[:offset] || @@default_params[:offset]
 		# one of the options for this is false, so it's not gonna play nice with ||
-		@spacelines = (params[:spacelines] != nil) ? params[:spacelines] : DefaultParams[:spacelines] 
+		@spacelines = (params[:spacelines] != nil) ? params[:spacelines] : @@default_params[:spacelines] 
+		@stretch = (params[:stretch] || @@default_params[:stretch]).to_i
+		@min_width = (params[:min_width] || @@default_params[:min_width]).to_i
 
 		# call on some special methods to parse text and alignment
 		set_text params[:text]
 		set_alignment params[:alignment]	
 		set_style params[:style]
-		@max_line_length += (params[:stretch] || DefaultParams[:stretch]).to_i
+		# @max_line_length += (params[:stretch] || @@default_params[:stretch]).to_i
 		if !@max_line_length.is_even? then @max_line_length += 1 end
 	end
 	def to_s
+		# exact value of spaceLine is calculated if @spacelines is true, otherwise it's just an empty string
 		spaceLine = @spacelines ? [@style[:oddlines][0], ' ' * (@max_line_length + @padding * 2), @style[:oddlines][1], "\n"].join : ''
 		
 		# construct an array of lines, join them together and return
@@ -130,35 +156,40 @@ private
 		else
 			raise 'CommentBox#text= : expected String or Array here'
 		end
-		@max_line_length = @text.map(&:length).max
+		@max_line_length = @text.map(&:length).max + @stretch
+		@max_line_length = @min_width unless @max_line_length > @min_width
 		if !@max_line_length.is_even? then @max_line_length += 1 end
 		insert_line_if_even
 	end
 	def set_alignment (align)
 		if align == nil
 		# set default value if no argument is given
-			@alignment = [ DefaultParams[:alignment] ] * (@text.size)
+			@alignment = [ @@default_params[:alignment] ] * (@text.size)
 		else
 		# fill array with align if one symbol is given
 			if align.is_a? Symbol
 				@alignment = [ align ] * (@text.size)
 		# set @alignment directly if an array is given
 			elsif align.is_a? Array
+				align.map! { |a| a.to_sym }
 		# if the array is too short, fill it with the last element
 				if align.size < @text.size then (@text.size - align.size).times { align.push align.last } end
 				@alignment = align
+			elsif align.is_a? String
+				@alignment = [ align.to_sym ] * (@text.size)
 			else
-				raise 'CommentBox#alignment= : expected Symbol or Array here'
+				raise 'CommentBox#alignment= : expected Symbol, Array, or String here'
 			end
 		end
 		# if the number of lines is even, insert a blank line between the first and second lines
 		insert_line_if_even
 	end
 	def set_style (style)
-		if style == nil then @style = Styles[DefaultParams[:style]]
-		elsif style.is_a? Symbol then @style = Styles[style]
+		if style == nil then @style = @@styles[@@default_params[:style]]
+		elsif style.is_a? Symbol then @style = @@styles[style]
 		elsif style.is_a? Hash then @style = style
-		else raise 'CommentBox#style= : expected Symbol or Hash here' end
+		elsif style.is_a? String then @style = @@styles[style.to_sym]
+		else raise 'CommentBox#style= : expected Symbol, Hash, or String here' end
 	end
 	def insert_line_if_even # also will delete a blank line if there is one
 		# stop this function from raising errors we don't really care about if the instance isn't fully constructed yet 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: commentbox
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Leonard H. Phelan IV
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-31 00:00:00.000000000 Z
+date: 2023-01-02 00:00:00.000000000 Z
 dependencies: []
 description: A little gem for generating pretty multiline comment boxes in C/C++ templates
 email: lenny@lenny.beer