string_dot_gradient 0.1.7 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73df78b09463b558f80961be83861765cf026a674b0be3ab76213f1b1f5c8aed
-  data.tar.gz: 6e561b3415470f06426aab38fc0d97a51289cf82a9ef68bab9b14646d33983fb
+  metadata.gz: dee7487ec82cd9435b163e3c3659c8147e2e8b6b7cd6b4220888d9ad213a6e5c
+  data.tar.gz: 9006ef1191185c26ebef6801c6c33cd3d5fd7ef1371c8924575e82b6055798e9
 SHA512:
-  metadata.gz: 5772433cb33f8756a01efb8a7b2723624ff8874270a6205e9c51f12ba29113cf95fb3a6a924003e416da3c5e4aa676144297df7b7ab6c1c05b4f455fc991fd83
-  data.tar.gz: a35256dc944c405e5652d0cab8792c18f89f2592e0cf1bf918e690f5312b53863ad9048140eeb271d238fd17689f6675510ffc5239737b7d77e09f57f0a239e8
+  metadata.gz: 89ad6e5d4244d86504367ebf61763feace21fd0fa93d381978ecf7ab865e334029a42535cff4b74213daccdb43b0e66c9cd8771f9bb0af4acbd045ae63bd5418
+  data.tar.gz: 84c5f8b2f25a85c2ed0aa94ee902284bafd51e321902ce094043f04e2a7dba64f3bd0eafa428d002ef9e626492d95fa29d79bc8718339e5698a2c553182e76e4

data/lib/string_dot_gradient/gradient.rb

@@ -1,6 +1,6 @@
 class String
 	##
-	# = gradient(*arg_colours, bg: false, exclude_spaces: true)    # => string or nil
+	# = gradient(*arg_colours, bg: false, exclude_spaces: true, bold: false, blink: false)    # => string or nil
 	#
 	# Prettifies your string by adding gradient colours.
 	#
@@ -40,75 +40,108 @@ class String
 	# This is because \r wipes out the previous characters, and using \u0000 in
 	# a string is uncommon, and developers are requested to delete
 	# \u0000 from string if such situations arise.
-	def gradient(*arg_colours, bg: false, exclude_spaces: true)
+	#
+	# The option bold makes texts bold, but it also makes the string bigger.
+	# Set bold to anything truthy or falsey, but better just go with true and false or nil
+	#
+	# The option blink makes the texts blink on supported terminals.
+	# Set blink to anything truthy or falsey, but better just go with true and false or nil
+	def gradient(*arg_colours,
+		exclude_spaces: true,
+		bg: false,
+		bold: false,
+		italic: false,
+		underline: false,
+		blink: false,
+		strikethrough: false,
+		double_underline: false,
+		overline: false
+		)
+
 		temp = ''
 		flatten_colours = arg_colours.flatten
 
+		# Create the styling here rather than creating it in the each_line loop
+		# We also make it a bit different, rather than using \e[1m\e[5m, we will do
+		# \e[1;5m to save the number of characters spit out by this method
+		style = nil
+
+		if bold || italic || underline || blink || strikethrough || double_underline || overline
+			style = "\e["
+
+			style << '1;'.freeze if bold
+			style << '3;'.freeze if italic
+			style << '4;'.freeze if underline
+			style << '5;'.freeze if blink
+			style << '9;'.freeze if strikethrough
+			style << '21;'.freeze if double_underline
+			style << '53;'.freeze if overline
+
+			style.chop!
+			style << ?m.freeze
+		end
+
 		raise ArgumentError, "Wrong numeber of colours (given #{flatten_colours.length}, expected minimum 2)" if flatten_colours.length < 2
 		raise ArgumentError, "Given argument for colour is neither a String nor an Integer" if flatten_colours.any? { |x| !(x.is_a?(String) || x.is_a?(Integer)) }
 
 		all_rgbs = flatten_colours.map!(&method(:hex_to_rgb))
 		block_given = block_given?
 
-		r, g, b = all_rgbs[0]
-		r2, g2, b2 = all_rgbs[1]
+		# r, g, b => starting r, g, b
+		# r2, g2, b2 => stopping r, g, b
+		r, g, b = *all_rgbs[0]
+		r2, g2, b2 = *all_rgbs[1]
 		rotate = all_rgbs.length > 2
 
 		init = bg ? 48 : 38
 
 		each_line do |c|
+			temp << style if style
+
 			_r, _g, _b = r, g, b
 			chomped = !!c.chomp!(''.freeze)
 
 			len = c.length
 			n_variable = exclude_spaces ? c.delete("\t\s".freeze).length : len
-			n_variable = 1 if n_variable == 0
-
-			r_op = r_val = r_max = r_min = nil
-			g_op = g_val = g_max = g_min = nil
-			b_op = b_val = b_max = b_min = nil
+			n_variable -= 1
+			n_variable = 1 if n_variable < 1
 
-			r_comp_op = r_comp_val = nil
-			g_comp_op = g_comp_val = nil
-			b_comp_op = b_comp_val = nil
+			# colour operator, colour value
+			r_op = r_val  = nil
+			g_op = g_val = nil
+			b_op = b_val = nil
 
 			if r2 > r
-				r_op, r_val, r_max, r_min = :+, r2.fdiv(n_variable), r2, r
-				r_comp_op, r_comp_val = :<=, r_max
+				r_op, r_val = :+, r2.-(r).fdiv(n_variable)
 			elsif r2 < r
-				r_op, r_val, r_max, r_min = :-, r.fdiv(n_variable), r, r2
-				r_comp_op, r_comp_val = :>=, r_min
+				r_op, r_val = :-, r.-(r2).fdiv(n_variable)
 			end
 
 			if g2 > g
-				g_op, g_val, g_max, g_min = :+, g2.fdiv(n_variable), g2, g
-				g_comp_op, g_comp_val = :<=, g_max
+				g_op, g_val = :+, g2.-(g).fdiv(n_variable)
 			elsif g2 < g
-				g_op, g_val, g_max, g_min = :-, g.fdiv(n_variable), g, g2
-				g_comp_op, g_comp_val = :>=, g_min
+				g_op, g_val = :-, g.-(g2).fdiv(n_variable)
 			end
 
 			if b2 > b
-				b_op, b_val, b_max, b_min = :+, b2.fdiv(n_variable), b2, b
-				b_comp_op, b_comp_val = :<=, b_max
+				b_op, b_val = :+, b2.-(b).fdiv(n_variable)
 			elsif b2 < b
-				b_op, b_val, b_max, b_min = :-, b.fdiv(n_variable), b, b2
-				b_comp_op, b_comp_val = :>=, b_min
+				b_op, b_val = :-, b.-(b2).fdiv(n_variable)
 			end
 
 			# To avoid the value getting adding | subtracted from the initial character
-			_r = _r.send(r_op, r_val * -1) if r_comp_op && _r.send(r_comp_op, r_comp_val)
-			_g = _g.send(g_op, g_val * -1) if g_comp_op && _g.send(g_comp_op, g_comp_val)
-			_b = _b.send(b_op, b_val * -1) if b_comp_op && _b.send(b_comp_op, b_comp_val)
+			_r = _r.send(r_op, r_val * -1) if r_op
+			_g = _g.send(g_op, g_val * -1) if g_op
+			_b = _b.send(b_op, b_val * -1) if b_op
 
 			i = -1
 			while (i += 1) < len
 				_c = c[i]
 
 				if !exclude_spaces || (exclude_spaces && !(_c == ?\s.freeze || _c == ?\t.freeze))
-					_r = _r.send(r_op, r_val) if r_comp_op && _r.send(r_comp_op, r_comp_val)
-					_g = _g.send(g_op, g_val) if g_comp_op && _g.send(g_comp_op, g_comp_val)
-					_b = _b.send(b_op, b_val) if b_comp_op && _b.send(b_comp_op, b_comp_val)
+					_r = _r.send(r_op, r_val) if r_op
+					_g = _g.send(g_op, g_val) if g_op
+					_b = _b.send(b_op, b_val) if b_op
 				end
 
 				r_to_i = _r.to_i
@@ -122,7 +155,11 @@ class String
 				ret = "\e[#{init};2;#{f_r};#{f_g};#{f_b}m#{_c}"
 
 				if block_given
-					yield ret
+					if style && i == 0
+						yield style + ret
+					else
+						yield ret
+					end
 				else
 					temp << ret
 				end
@@ -135,7 +172,11 @@ class String
 			end
 
 			if block_given
-				yield ret
+				if style
+					yield style + ret
+				else
+					yield ret
+				end
 			else
 				temp << ret
 			end
@@ -150,6 +191,86 @@ class String
 		block_given ? nil : temp
 	end
 
+	##
+	# = multi_gradient(*n_arg_colours, bg: false, exclude_spaces: true, bold: false, blink: false)    # => string or nil
+	#
+	# Accepts n number of colours. Example:
+	#    'Hello world this is multi_gradient()'.multi_gradient('3eb', '55f', 'f55', 'fa0')
+	#
+	# In this example, multi_gradient() paints the string with 4 colours in one line.
+	#
+	# It Splits up a string with the Calls String#gradient() with the given number of colours
+	# So each call to multi_gradient() involves many calls to String#gradient().
+	# Hence it's slower than String#gradient()
+	def multi_gradient(*colours,
+		exclude_spaces: true,
+		bg: false,
+		bold: false,
+		italic: false,
+		underline: false,
+		blink: false,
+		strikethrough: false,
+		double_underline: false,
+		overline: false,
+		&block
+		)
+
+		len = colours.length
+		raise ArgumentError, "Minimum two colours are required, given #{len}" if len < 2
+
+		div = len - 1
+		div_1 = div - 1
+		ret = ''
+		block_given = block_given?
+
+		params = {
+			exclude_spaces: exclude_spaces,
+			bg: bg,
+			bold: bold,
+			italic: italic,
+			underline: underline,
+			blink: blink,
+			strikethrough: strikethrough,
+			double_underline: double_underline,
+			overline: overline,
+		}
+
+		each_line { |l|
+			_len = l.length
+
+			len, c = _len.fdiv(div).round, colours.dup
+			counter, i, j = -1, -1, 0
+			ch = ''
+
+			while x = l[i += 1] do
+				counter += 1
+
+				# colour % len == 0 is very slow approach
+				if counter == len && j < div_1
+					counter, j = 0, j + 1
+					if block_given
+						ch.gradient(c[0], c[1], **params, &block)
+					else
+						ret << ch.gradient(c[0], c[1], **params)
+					end
+
+					c.rotate!
+					ch.clear
+				end
+
+				ch << x
+			end
+
+			if block_given
+				ch.gradient(c[0], c[1], **params, &block)
+			else
+				ret << ch.gradient(c[0], c[1], **params)
+			end
+		}
+
+		block_given ? nil : ret
+	end
+
 	private
 	def hex_to_rgb(hex)
 		# Duplicate colour, even if colour is nil
@@ -168,8 +289,7 @@ class String
 				oor.include?(x) ? "\e[1;31m#{x}\e[0m" : x
 			}.join
 
-			puts "Hex Colour ##{invalids} is Out of Range"
-			raise ArgumentError
+			raise ArgumentError, "\e[0mHex Colour \e[1m##{invalids} is Out of Range\e[0m"
 		end
 
 		clen = colour.length

data/lib/string_dot_gradient/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StringDotGradient
-	VERSION = "0.1.7"
+	VERSION = "0.3.2"
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: string_dot_gradient
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.3.2
 platform: ruby
 authors:
 - Sourav Goswami
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-10 00:00:00.000000000 Z
+date: 2021-04-01 00:00:00.000000000 Z
 dependencies: []
-description: An itty-bitty extension that adds gradient method to String class that
-  supports any hex colour, for Linux | Unix terminals only
+description: An itty-bitty extension that adds "gradient" method to String class that
+  supports any hex colour, for Linux terminals
 email:
 - souravgoswami@protonmail.com
 executables: []
@@ -40,9 +40,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.13
 signing_key:
 specification_version: 4
-summary: An itty-bitty extension that adds gradient method to String class that supports
-  any hex colour, for Linux | Unix terminals only
+summary: An itty-bitty extension that adds "gradient" method to String class that
+  supports any hex colour, for Linux terminals
 test_files: []