commentbox 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a43575a5fce78f88644c9bb88e0291a89455ab0431d28ce196fd7c9297817f45
-  data.tar.gz: 4da8a222cdb0bbc9051ac63f42d394754b62d51b1e2582517be3ade0938a7003
+  metadata.gz: 5bf8ca4be9a56802c326ec4f5e1562262bf40d334571113c70ca11847c904195
+  data.tar.gz: ec433e2a0da5b227827e00f35033a626cb521a67668d2dc79a4061e7ffceb98f
 SHA512:
-  metadata.gz: b3c437d82fe9a730adc67f3c54a67d76dd7dd6cc30851d173d24f725ce16cc33a043b105bbe640033455e916a4ad3596e896198e6e1c46a9867e298d3604fcaa
-  data.tar.gz: 33e51c50a9d063ae040b9071d325e2f32dd1535b19a7266e5af3d25551c3dd00cad85c6f34273e967169e661ad338a7aca047d4e576c3cbf2d35d81957972e95
+  metadata.gz: 1aea4172ca5e47d5d2dc79b25249d577e3c4d5d61f9b04e11fa7925ff2d77719dbc43a3418fd198d4e2c92a0b728552049e071933caf50078eceee81c3fd2c87
+  data.tar.gz: 3580327e9e93b7043bfdc64fb48a48ce0fbfc8b4372736aa5a49f527a2e955b4706190ddc5c91032eedbb4f2f6e1a866e2be324a53b8f1c1856b301f4dfccf0b

data/bin/cbwiz

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+
+require 'commentbox'
+
+$HELP_MSG = %q(Usage: cb_script.rb [options] [text]
+Options:
+	-t, --text [text]         Text to be commented. Optional flag for first argument
+	-a, --align [l1, l2...]   Alignment of text: left, center, right
+	-s, --style [style]       Style of comment box: stub, window, parallax, zigzag, or money
+	-p, --padding [padding]   Padding of comment box
+	-o, --offset [offset]     Offset of comment box
+	-w, --stretch [stretch]   Stretch of comment box
+	-sl, --spacelines         Remove space lines (default true)
+	-h, --help                Display this help message
+)
+
+def help_and_exit
+	puts $HELP_MSG
+	exit
+end
+
+if ARGV.empty?
+	help_and_exit
+end
+# if the :text parameter is first, the -t flag is optional
+mode = :text
+options = {}
+# for each argument:
+#   if it's a switch, set the `mode` symbol
+#   if it's a value, set/append to the coresponding `mode` key in `options`
+ARGV.each do |arg|
+	case arg
+	when '-h', '--help', 'help', '-?', '--?'
+		help_and_exit
+	when '-t', '--text'
+		mode = :text
+	when '-a', '--align'
+		mode = :align
+	when '-s', '--style'
+		mode = :style
+	when '-p', '--padding'
+		mode = :padding
+	when '-o', '--offset'
+		mode = :offset
+	when '-w', '--stretch'
+		mode = :stretch
+	when '-sl', '--spacelines'
+		mode = :spacelines
+		# default is true so if it's mentioned, we implicitly assume false
+		# although it remains possible to explicitly specify true
+		options[:spacelines] = false
+	else
+		if options[mode].nil?
+			options[mode] = arg
+		else
+			# hacky line to make sure anything with multiple arguments comes out as a flat array
+			options[mode] = ([ options[mode] ] << arg).flatten
+		end
+	end
+end
+
+
+puts options.to_s
+
+puts CommentBox.new options

data/lib/commentbox.rb

@@ -16,6 +16,12 @@ module CommentBoxStyles
 			evenlines: ['/ ', ' /'],
 			oddcorners: ['=/','/=']
 		},
+		window: {
+			hlines: '**',
+			oddlines: ['\\*', '*\\'],
+			evenlines: ['/+', '+/'],
+			oddcorners: ['+/','/+']
+		},
 		parallax: {
 			hlines: '==',
 			oddlines: ['||', '||'],
@@ -78,9 +84,11 @@ class CommentBox
 	@@styles = CommentBoxStyles::Styles
 
 	# class methods for messing with default values
+	# make sure everything is symbolized that needs to be
 	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.default_params=(value); @@default_params = value.transform_keys(&:to_sym) end
+	# def self.default_params[]= (key, value); @@default_params[key.to_sym] = value end
+	def self.set_default_params (value = {}); value.each { |key, val| @@default_params[key.to_sym] = val } end
 	def self.styles; @@styles end
 	def self.add_style(value)
 		value.each do |key, val|
@@ -90,7 +98,8 @@ class CommentBox
 			end
 		end
 		# I could attempt to remove a :default? key here but it doesn't matter
-		@@styles.merge! value
+		# this is a terse one but trust me
+		@@styles.merge! value.transform_keys(&:to_sym).transform_values { |v| v.transform_keys(&:to_sym) }
 	end
 	
 	# instance setter methods
@@ -115,8 +124,8 @@ class CommentBox
 		if params.is_a? String then params = {text: params} end 
 
 		# fill in a bunch of instance variables from params or default values
-		@padding = params[:padding] || @@default_params[:padding]
-		@offset = params[:offset] || @@default_params[:offset]
+		@padding = params[:padding].to_i || @@default_params[:padding]
+		@offset = params[:offset].to_i || @@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] : @@default_params[:spacelines] 
 		@stretch = (params[:stretch] || @@default_params[:stretch]).to_i
@@ -140,8 +149,8 @@ class CommentBox
 			(0..@text.size - 1).map { |line| fmt_text_line line }, # this is a nested array and must be flattened
 			spaceLine,
 			t_line(:end)
-		# flatten, add offset to each line if it's not empty, join them together, and remove trailing newline
-		].flatten.map { |line| line == '' ? '' : (' ' * @offset) << line}.join.chomp 
+		# flatten, map offset in front of each line if it's not empty, join them together, and remove trailing newline
+		].flatten.map { |line| line == '' ? '' : (' ' * @offset) << line }.join.chomp 
 	end
 
 private
@@ -197,7 +206,7 @@ private
 			else @text.insert(1,''); @alignment.insert(1,:left) end
 		end
 	end
-	def t_line (beginOrEnd)
+	def t_line (beginOrEnd) #t[erminating]_line: top or bottom (begin or end) of the box
 		if beginOrEnd == :begin
 			bchar = '/*'; echar = @style[:oddcorners][0]
 		else

metadata

@@ -1,21 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: commentbox
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Leonard H. Phelan IV
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-02 00:00:00.000000000 Z
+date: 2023-01-13 00:00:00.000000000 Z
 dependencies: []
 description: A little gem for generating pretty multiline comment boxes in C/C++ templates
 email: lenny@lenny.beer
-executables: []
+executables:
+- cbwiz
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/cbwiz
 - lib/commentbox.rb
 homepage: https://github.com/lennyitb/commentbox
 licenses:
@@ -36,7 +38,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.3
 signing_key:
 specification_version: 4
 summary: Lenny C/C++ template CommentBox class