string_dot_gradient 0.1.8 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f734ad48d80c57969e3fb4598f5a89fafdb35b30c2b5dddbc1bbbf1a835a829
-  data.tar.gz: 80c268d0c7754047bf1040d1ade34a3e9652180441ca3cbf23a0d67f8873d531
+  metadata.gz: 06603caa967d156eea0acf41986eddbd09f651a4f21d64da62edbaa029b878b9
+  data.tar.gz: f5d3c0fbc4b9bfc9caf61ea56b2f4c0518a457ce90a35c9c1425376c5a707963
 SHA512:
-  metadata.gz: 0102ffe6acc5355cc7d29dea013439eb245fc5ec11415eea6cc91f1025a6128f639120b74d29d0dec44ebf085f73d41411d6027480b4270dc832d17e5e353cf7
-  data.tar.gz: d0d2c157c03af2a8688fcba1ade8d5177e0d8656512b9293a26672faf9dddb492a530e409df9e6ffa5f32f75f05d0c6c041ac13f4cc0a75c4067b4fc59bf9144
+  metadata.gz: a03febddbf80cb165467b627e5f91709626d4f1dd0e56d84e1c023f41b450971d6043bddc408ce7a5bba774a3f0f3151d52112598dcefbcb58d1568d6f5836b4
+  data.tar.gz: 9908f51246f7fbf885fa94e4499f0684241cb4159110fb472adfdf8e545251dae8bc8b9628e770a9478ad9217255c71b81f61163d98616ef49ad9494fd14ea5e

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,15 +40,54 @@ 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
+		)
+
+		block_given = block_given?
 		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?
+
+		yield style if block_given
 
 		# r, g, b => starting r, g, b
 		# r2, g2, b2 => stopping r, g, b
@@ -59,6 +98,8 @@ class String
 		init = bg ? 48 : 38
 
 		each_line do |c|
+			temp << style if style
+
 			_r, _g, _b = r, g, b
 			chomped = !!c.chomp!(''.freeze)
 
@@ -144,6 +185,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
@@ -162,8 +283,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.8"
+	VERSION = "0.3.3"
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: string_dot_gradient
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.3.3
 platform: ruby
 authors:
 - Sourav Goswami
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-12 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: []