string_dot_gradient 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46742b73629d3f3bfec9b12628a2ccc174548d06dce6958faa4a7d849ad13d37
-  data.tar.gz: 613d584f92df46117cc9bf33115b80fb655363787ba236b3f28bf7f29823fb1b
+  metadata.gz: 705f4872e8c680732b71c8d5e1e70f2287418d4b38278f92bbf801bb3d838f5a
+  data.tar.gz: bc0c962ecd6615bc40ec1c58f1c90131a752651f1165b6962898e046f38511bf
 SHA512:
-  metadata.gz: cc9e51d4ec0b19c6ae6243544d550958e2ed5f31f8f838d4143fceaf82ac3e1c420382d7acfb1a6da458396f6ee3cb03b3c38c0d7020da600d80d3260420586e
-  data.tar.gz: 25aff2e43cf96421a01b11da8a574c71f894327852befaac4f4a4193985af7bf064e69670d573b5802277680cee556dfedf620ebbb31533dd8e80849c735960b
+  metadata.gz: 234f82023c22e4f0acffc3456eee6080b73cfad4516a34cb645a6a1dcc9a742c743e09368f71e15187721805ada57e3d2fbc892413677eb0daa0889bb98c6cbd
+  data.tar.gz: '095bc1362d552dae0d1e8e56808fc993a92f47a529ef584fd0fdbbc6705cda1cb40237beb06b64d0ba0f28fe828b3179b76712f652e522658a110104bfbc1d57'

data/lib/string_dot_gradient/gradient.rb

@@ -1,8 +1,8 @@
 class String
 	##
-	# = gradient(*arg_colours, bg: false)    # => string or nil
+	# = gradient(*arg_colours, bg: false, exclude_spaces: true)    # => string or nil
 	#
-	# Prettifies your string by adding gradient colours
+	# Prettifies your string by adding gradient colours.
 	#
 	# This method accept a lot of colours. For example:
 	#
@@ -29,7 +29,18 @@ class String
 	#
 	# Adding the option bg will change the background colour, but will keep the foreground colour
 	# defined in the terminal settings.
-	def gradient(*arg_colours, bg: false)
+	#
+	# The option exclude_spaces, is expected to set either true or false.
+	# By default it's set to true.
+	# Enabling this option will not waste colours on white-spaces.
+	# White spaces only include: \s, \t
+	#
+	# Please do note that \u0000 and \r in the middle of the string will not be
+	# counted as a white space, but as a character instead.
+	# 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)
 		colours, line_length = [], -1
 		temp = ''
 		flatten_colours = arg_colours.flatten
@@ -38,7 +49,6 @@ class String
 		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]
@@ -49,11 +59,48 @@ class String
 
 		each_line do |c|
 			_r, _g, _b = r, g, b
+			chomped = !!c.chomp!(''.freeze)
+
 			n = c.length
+			n_variable = exclude_spaces ? c.delete("\t\s".freeze).length : n
+
+			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
+
+			r_comp_op = r_comp_val = nil
+			g_comp_op = g_comp_val = nil
+			b_comp_op = b_comp_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
+			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
+			end
 
-			r_meth = r == r2 ? :itself : r2 > r ? [:+, r2.fdiv(n)] : [:-, r.fdiv(n)]
-			g_meth = g == g2 ? :itself : g2 > g ? [:+, g2.fdiv(n)] : [:-, g.fdiv(n)]
-			b_meth = b == b2 ? :itself : b2 > b ? [:+, b2.fdiv(n)] : [:-, b.fdiv(n)]
+			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
+			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
+			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
+			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
+			end
+
+			# To avoid the value getting adding | subtracted from the initial character
+			# Note that duplication is fine if we don't get a little bit performance loss
+			_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)
 
 			if line_length != n || rotate
 				line_length = n
@@ -61,14 +108,33 @@ class String
 
 				i = -1
 				while (i += 1) < n
-					_r = _r.send(*r_meth)
-					_g = _g.send(*g_meth)
-					_b = _b.send(*b_meth)
+					if exclude_spaces
+						_c = c[i]
+
+						if !(_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)
+						end
+					else
+						# We also have duplication above,
+						# But we are not going to remove this code unless
+						# we find some efficient solution. Using a proc or method
+						# for setting these values and calling that is a way
+						# to make code slower.
+						_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)
+					end
+
+					r_to_i = _r.to_i
+					g_to_i = _g.to_i
+					b_to_i = _b.to_i
 
 					colours << [
-						(_r < 0 ? 0 : _r > 255 ? 255 : _r.to_i),
-						(_g < 0 ? 0 : _g > 255 ? 255 : _g.to_i),
-						_b < 0 ? 0 : _b > 255 ? 255 : _b.to_i
+						r_to_i < 0 ? 0 : r_to_i > 255 ? 255 : r_to_i,
+						g_to_i < 0 ? 0 : g_to_i > 255 ? 255 : g_to_i,
+						b_to_i < 0 ? 0 : b_to_i > 255 ? 255 : b_to_i,
 					]
 				end
 			end
@@ -85,9 +151,17 @@ class String
 			end
 
 			if block_given
-				yield "\e[0m".freeze
+				if !c.empty?
+					yield(chomped ? "\e[0m\n".freeze : "\e[0m".freeze)
+				elsif chomped && c.empty?
+					yield(?\n.freeze)
+				end
 			else
-				temp << "\e[0m".freeze
+				if !c.empty?
+					temp.concat(chomped ? "\e[0m\n".freeze : "\e[0m".freeze)
+				elsif chomped && c.empty?
+					temp.concat(?\n.freeze)
+				end
 			end
 
 			if rotate
@@ -126,7 +200,7 @@ class String
 		elsif clen == 6
 			colour.chars.each_slice(2).map { |x| x.join.to_i(16) }
 		else
-			sli = clen > 6 ? 'too long' : clen < 3 ? 'too short' : 'invalid'
+			sli = clen > 6 ? 'too long'.freeze : clen < 3 ? 'too short'.freeze : 'invalid'.freeze
 			raise ArgumentError, "Invalid Hex Colour ##{colour} (length #{sli})"
 		end
 	end

data/lib/string_dot_gradient/version.rb

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

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: string_dot_gradient
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - Sourav Goswami
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-07 00:00:00.000000000 Z
+date: 2021-01-09 00:00:00.000000000 Z
 dependencies: []
-description: An itty-bitty extension that adds gradient method to String class, for
-  Linux terminals
+description: An itty-bitty extension that adds gradient method to String class that
+  supports any hex colour, for Linux | Unix terminals only
 email:
 - souravgoswami@protonmail.com
 executables: []
@@ -33,7 +33,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -43,6 +43,6 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
-summary: An itty-bitty extension that adds gradient method to String class, for Linux
-  terminals
+summary: An itty-bitty extension that adds gradient method to String class that supports
+  any hex colour, for Linux | Unix terminals only
 test_files: []