string_dot_gradient 0.1.9 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 229c7c52d938962d064671617bd9c8ae622df4a52fa5dd7df0b4485ec14e55a1
-  data.tar.gz: 0d926f9ed11056c3870c3964a7497c345b890582e8816296baa2c38eaa07836d
+  metadata.gz: edc1903ceea6827357c02ef0efdea7dcf1de66b9e6487f61b43ab01932eae822
+  data.tar.gz: 561e461b724a013786533e03ce752756f224cc8d6aaee6f064ace18ccf7a1e11
 SHA512:
-  metadata.gz: 9baf8ae5b7a5e0285db981cc3d4426493cd44864f40a44cbefecde30b7742602f5424275bfe676a330dd9a8eb5c9117c4c50b055811c76d072c2f9c632ab7e07
-  data.tar.gz: 3186f138e9036fc98801a0810913524c16508a2468126c41a9482d3043b0accaf41bbcbf9aa2c6600365e30d043e6b311aaec8db6b43d83eea6cfe3e75f47565
+  metadata.gz: c072842423ac1aadda79d3c445c6a0e7b347b5ddc67c62ee2a6a9195571e6c23b82485014e514af9d8fb363ad82ab411dd7d71568744cc90463845968f407874
+  data.tar.gz: c302d7acbfca9b35d182fe8b2a0406d6882487cc242b18c2d050b600ea9d087a49f2c9bb85db580c5d91b7207e6f193c4543e142a8700596c099888395353f22

data/lib/string_dot_gradient.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "string_dot_gradient/version"
+require_relative 'string_dot_gradient/version'
+require 'string_dot_gradient/hex_to_rgb.rb'
 require 'string_dot_gradient/gradient.rb'

data/lib/string_dot_gradient/gradient.rb

@@ -46,15 +46,50 @@ class String
 	#
 	# 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, bg: false, exclude_spaces: true, bold: false, blink: false)
+	def gradient(*arg_colours,
+		exclude_spaces: true,
+		bg: false,
+		bold: false,
+		italic: false,
+		underline: false,
+		blink: false,
+		strikethrough: false,
+		double_underline: false,
+		overline: false
+		)
+
+		space, tab = ?\s.freeze, ?\t.freeze
+
+		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 && style
 
 		# r, g, b => starting r, g, b
 		# r2, g2, b2 => stopping r, g, b
@@ -65,8 +100,7 @@ class String
 		init = bg ? 48 : 38
 
 		each_line do |c|
-			temp << "\e[1m".freeze if bold
-			temp << "\e[5m".freeze if blink
+			temp << style if style
 
 			_r, _g, _b = r, g, b
 			chomped = !!c.chomp!(''.freeze)
@@ -77,6 +111,11 @@ class String
 			n_variable = 1 if n_variable < 1
 
 			# colour operator, colour value
+			#
+			# r_op, g_op, b_op are also flags to determine
+			# if the r, g, and b values respectively should change or not
+			# For example, if the given blues are equal, the b_op is nil
+			# So it won't change the colour in the ouput
 			r_op = r_val  = nil
 			g_op = g_val = nil
 			b_op = b_val = nil
@@ -108,7 +147,7 @@ class String
 			while (i += 1) < len
 				_c = c[i]
 
-				if !exclude_spaces || (exclude_spaces && !(_c == ?\s.freeze || _c == ?\t.freeze))
+				if !exclude_spaces || (_c != space && _c != tab)
 					_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
@@ -118,11 +157,11 @@ class String
 				g_to_i = _g.to_i
 				b_to_i = _b.to_i
 
-				f_r = r_to_i < 0 ? 0 : r_to_i > 255 ? 255 : r_to_i
-				f_g = g_to_i < 0 ? 0 : g_to_i > 255 ? 255 : g_to_i
-				f_b = b_to_i < 0 ? 0 : b_to_i > 255 ? 255 : b_to_i
+				clamped_r = r_to_i < 0 ? 0 : r_to_i > 255 ? 255 : r_to_i
+				clamped_g = g_to_i < 0 ? 0 : g_to_i > 255 ? 255 : g_to_i
+				clamped_b = b_to_i < 0 ? 0 : b_to_i > 255 ? 255 : b_to_i
 
-				ret = "\e[#{init};2;#{f_r};#{f_g};#{f_b}m#{_c}"
+				ret = "\e[#{init};2;#{clamped_r};#{clamped_g};#{clamped_b}m#{_c}"
 
 				if block_given
 					yield ret
@@ -153,36 +192,83 @@ class String
 		block_given ? nil : temp
 	end
 
-	private
-	def hex_to_rgb(hex)
-		# Duplicate colour, even if colour is nil
-		# This workaround is for Ruby 2.0 to Ruby 2.2
-		# Which won't allow duplicate nil.
-		colour = hex && hex.dup.to_s || ''
-		colour.strip!
-		colour.downcase!
-		colour[0] = ''.freeze if colour[0] == ?#.freeze
-
-		# out of range
-		oor = colour.scan(/[^a-f0-9]/)
-
-		unless oor.empty?
-			invalids = colour.chars.map { |x|
-				oor.include?(x) ? "\e[1;31m#{x}\e[0m" : x
-			}.join
-
-			puts "Hex Colour ##{invalids} is Out of Range"
-			raise ArgumentError
-		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
+		)
 
-		clen = colour.length
-		if clen == 3
-			colour.chars.map { |x| x.<<(x).to_i(16) }
-		elsif clen == 6
-			colour.chars.each_slice(2).map { |x| x.join.to_i(16) }
-		else
-			sli = clen > 6 ? 'too long'.freeze : clen < 3 ? 'too short'.freeze : 'invalid'.freeze
-			raise ArgumentError, "Invalid Hex Colour ##{colour} (length #{sli})"
-		end
+		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
 end

data/lib/string_dot_gradient/hex_to_rgb.rb

@@ -0,0 +1,53 @@
+class String
+	# Fast conversion to RGB when Integer is passed.
+	# For example: 0xffffff for white,
+	# 0x000000 or 0x0 for black, 0x00aa00 for deep green
+	# 0xff50a6 for pink, 0xff5555 for light red, etc.
+	#
+	# Similarly:
+	# (255 * 256 * 256) + (255 * 256) + (255) => 0xffffff
+	# (0 * 256 * 256) + (0 * 256) + 0 => 0x0
+	# (255 * 256 * 256) + (85 * 256) + 85 => #ff5555
+	# (85 * 256 * 256) + (85 * 256) + 255 => #5555ff
+	# (255 * 256 * 256) + (170 * 256) + 0 => 0xffaa00
+	# (0 * 256 * 256) + (170 * 256) + 0 => 0x00aa00
+	def hex_to_rgb(hex)
+		return [
+			255 & hex >> 16,
+			255 & hex >> 8,
+			255 & hex
+		] if hex.is_a?(Integer)
+
+		# Duplicate colour, even if colour is nil
+		# This workaround is for Ruby 2.0 to Ruby 2.2
+		# Which won't allow duplicate nil.
+		colour = hex && hex.dup.to_s || ''
+		colour.strip!
+		colour.downcase!
+		colour[0] = ''.freeze if colour[0] == ?#.freeze
+
+		# out of range
+		oor = colour.scan(/[^a-f0-9]/)
+
+		unless oor.empty?
+			invalids = colour.chars.map { |x|
+				oor.include?(x) ? "\e[1;31m#{x}\e[0m" : x
+			}.join
+
+			raise ArgumentError, "\e[0mHex Colour \e[1m##{invalids} is Out of Range\e[0m"
+		end
+
+		clen = colour.length
+
+		if clen == 3
+			colour.chars.map { |x| x.<<(x).to_i(16) }
+		elsif clen == 6
+			colour.chars.each_slice(2).map { |x| x.join.to_i(16) }
+		else
+			sli = clen > 6 ? 'too long'.freeze : clen < 3 ? 'too short'.freeze : 'invalid'.freeze
+			raise ArgumentError, "Invalid Hex Colour ##{colour} (length #{sli})"
+		end
+	end
+
+	private(:hex_to_rgb)
+end

data/lib/string_dot_gradient/version.rb

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

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: string_dot_gradient
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.4.0
 platform: ruby
 authors:
 - Sourav Goswami
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-14 00:00:00.000000000 Z
+date: 2021-06-25 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: []
@@ -20,6 +20,7 @@ extra_rdoc_files: []
 files:
 - lib/string_dot_gradient.rb
 - lib/string_dot_gradient/gradient.rb
+- lib/string_dot_gradient/hex_to_rgb.rb
 - lib/string_dot_gradient/version.rb
 homepage: https://github.com/Souravgoswami/string_dot_gradient
 licenses:
@@ -40,9 +41,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.19
 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: []