ombre 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd24e51a4a0474d903fd3b012848fdcaa3cec7e5e07d5b35cddce11a7b190d1d
-  data.tar.gz: 6abacfc82cfd70b3c7117e0b6ff521aa2d167ebb184826e12fe6fac1c7df18d7
+  metadata.gz: 0d8a4ddbfcbaa0f408f2bfc24ef443a72c8c66dd4167e2be8d68981ac8b29838
+  data.tar.gz: b69094d4367a287bf35a058b8c9b32f8b4af026a92a49045fb5cdc3a87e820b7
 SHA512:
-  metadata.gz: d363322c1244e03111d7e941a7b51281e41b0e9e5e0ed1a54156ea9435dcdbac19213878da9b13da117b92378d6752e7bcd7218e580ff28d70a3804fc0c9202f
-  data.tar.gz: 8896b50a283742f8fd34ebfb522dce8ee2eabecb4bdbf09a6690bb4eef69f8df388d6a4d8a70f55183889458ca0b28c6bf4ba2a5c736979105ad6567f5c83623
+  metadata.gz: 30326d68bfea689327dbb6852fb4cd46fd1cbe84a1fb5e422b58771eb402fccb5c7206116a05c5e6866883be4560bb3249c9e2b167c6613f0273d67cdad86b0d
+  data.tar.gz: 1084d2fecaca0e70de079434a92a54e68f52aa3068e2ab8999c9909f0784bd10113ecc0a0ed431643e8c60a8d5ff652597ce6ad8b96dec258fbbe8d508697f53

data/README.md

@@ -0,0 +1,54 @@
+# Ruby Ombre
+
+Ombre provides gradients for your terminal between any number of RGB values.
+
+## Features
+
+* Horizontal, vertical, and diagonal gradients for any number of colors.
+## True Color Support
+
+This will only look good on terminals that support 24bit colors, for now.
+
+## Setup
+
+Add to `Gemfile`:
+
+```ruby
+gem 'ombre'
+```
+
+and run `bundle install`.
+
+In Ruby do:
+
+```ruby
+require 'ombre'
+```
+
+## Usage
+
+There are four main functions available for `Ombre`:
+
+```ruby
+# colors in the below functions should be an array of 24 bit hexidecimal RGB values as strings.
+
+# Returns the block of text marked up with colors to create a horizontal gradient from left to right
+Ombre.horizontal(text, colors)
+Ombre.horizontal("############\n#          #\n# Horiz. ###\n# Ombre ####\n# Test #####\n# From #####\n# Red ######\n# To #######\n# Blue #####\n#          #\n############", ["FF0000", "0000FF"])
+
+# Returns the block of text marked up with colors to create a vertical gradient from top to bottom
+Ombre.vertical(text, colors)
+Ombre.vertical("############\n#          #\n# Vertical #\n# Ombre ####\n# Test #####\n# From #####\n# Red ######\n# To #######\n# Blue #####\n#          #\n############", ["FF0000", "0000FF"])
+
+# Returns the block of text marked up with colors to create a diagonal gradient from top-left to bottom-right
+Ombre.diagonal(text, colors)
+Ombre.diagonal("############\n#          #\n# Diagonal #\n# Ombre ####\n# Test #####\n# From #####\n# Red ######\n# To #######\n# Blue #####\n#          #\n############", ["FF0000", "0000FF"])
+
+# Returns the block of text marked up with colors to create a diagonal gradient from bottom-left to top-right
+Ombre.diagonal_up(text, colors)
+Ombre.diagonal_up("############\n#          #\n# Diagonal #\n# Ombre ####\n# Test #####\n# From #####\n# Red ######\n# To #######\n# Blue #####\n#          #\n############", ["FF0000", "0000FF"])
+```
+
+
+Copyright (c) 2022 Justin Paulson, released under the
+MIT license.

data/lib/ombre.rb

@@ -1,41 +1,81 @@
 class Ombre
-  def self.vertical color1, color2, text
-    red1, green1, blue1 = get_colors(color1)
-    red2, green2, blue2 = get_colors(color2)
-    r_step, g_step, b_step = get_steps(color1, color2, text.lines.count)
+  def self.vertical text, colors
     text.lines.each_with_index.map do |line, i|
-      color_text (red1 + i * r_step), (green1 + i * g_step), (blue1 + i * b_step), line
+      red, green, blue = get_offset_color colors, i/text.lines.count.to_f
+      color_text red, green, blue, line
     end.join
   end
 
-  def self.horizontal color1, color2, text
-    red1, green1, blue1 = get_colors(color1)
-    red2, green2, blue2 = get_colors(color2)
-    r_step, g_step, b_step = get_steps(color1, color2, text.lines.max.length)
+  def self.horizontal text, colors
     text.lines.map do |line|
-      line.chars.each_with_index.map do |line, i|
-        color_text (red1 + i * r_step), (green1 + i * g_step), (blue1 + i * b_step), line
+      line.chars.each_with_index.map do |char, i|
+        red, green, blue = get_offset_color colors, i/text.lines.max.length.to_f
+        color_text red, green, blue, char
       end.join
     end.join
   end
 
+  def self.diagonal text, colors
+    max_y = text.lines.count
+    max_x = text.lines.max.length
+    text.lines.each_with_index.map do |line, y|
+      line.chars.each_with_index.map do |char, x|
+        ratio = (y + x)/(max_y + max_x).to_f
+        red, green, blue = get_offset_color colors, ratio
+        color_text red, green, blue, char
+      end.join
+    end.join
+  end
+
+  def self.diagonal_up text, colors
+    max_y = text.lines.count
+    max_x = text.lines.max.length
+    text.lines.each_with_index.map do |line, y|
+      line.chars.each_with_index.map do |char, x|
+        ratio = (max_y - y + x)/(max_y + max_x).to_f
+        red, green, blue = get_offset_color colors, ratio
+        color_text red, green, blue, char
+      end.join
+    end.join
+  end 
+
   private
 
   def self.get_colors color
     color = color.gsub('#','')
+
     red = color[0..1].to_i(16).to_f
     green = color[2..3].to_i(16).to_f
     blue = color[4..5].to_i(16).to_f
+    
     [red, green, blue]
   end
 
-  def self.get_steps c1, c2, i
-    r1, g1, b1 = get_colors c1
-    r2, g2, b2 = get_colors c2
-    [(r2-r1)/i.to_f, (g2-g1)/i.to_f, (b2-b1)/i.to_f]
+  def self.get_offset_color colors, ratio
+    segment = -1
+    segment += 1 while ratio > (segment + 1)/(colors.count - 1).to_f && segment < colors.count - 2
+
+    color1 = colors[segment]
+    color2 = colors[segment+1]
+
+    percent = (ratio - segment/(colors.count-1).to_f)/(1/(colors.count-1).to_f)
+
+    r1, g1, b1 = get_colors color1
+    r2, g2, b2 = get_colors color2
+
+    r_dist = (r1-r2).abs * percent
+    red = r1 > r2 ? r1 - r_dist : r1 + r_dist
+
+    g_dist = (g1-g2).abs * percent
+    green = g1 > g2 ? g1 - g_dist : g1 + g_dist
+
+    b_dist = (b1-b2).abs * percent
+    blue = b1 > b2 ? b1 - b_dist : b1 + b_dist
+
+    [red, green, blue]
   end
 
   def self.color_text r, g, b, text
-    "\x1b[38;2;#{r.to_i};#{g.to_i};#{b.to_i}m#{text}"
+    "\x1b[38;2;#{r.to_i};#{g.to_i};#{b.to_i}m#{text}\x1b[0m"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ombre
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Justin Paulson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-20 00:00:00.000000000 Z
+date: 2022-04-25 00:00:00.000000000 Z
 dependencies: []
 description: Provides gradient colors for command line output using RGB hex values.
 email: jpaulson@hey.com