ombre 0.0.0 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbf20e9c3c9c4424d3ae4f3675ec90e2532b07d5f127b2dd52ca03dfad89fd82
-  data.tar.gz: 8ec60035f8581e0b5b3b9e70029730db208732b536b0d132f58d0974cada9b6e
+  metadata.gz: 99ef7e0c740ae6704b914f1a85ae7d9a05689ad732f8105c60daeb1d143a499f
+  data.tar.gz: 4580fe57eda1715b5b8ac69e1479cbd694560fb90f997300da334d29d15b7810
 SHA512:
-  metadata.gz: 56050a7bec0ec9a6af03c8fda56a53220cc630b79a0b31a4a88082e5a74ad920841a754f6c0308b6fe418ed0b122b85b812dd2bce8ec75d5fd3085bf54c16848
-  data.tar.gz: e7fac2bd9ca52d54ead214917ffedd620b92a1f50ae582ca328e9a0344cc3ed77f1f5ff60ad01c4842e71277ac3590fa88007f25aa426fc92ad68c2cb0c98429
+  metadata.gz: a1030837e5379c62320c9546297e957ed09fb85f8c0b81baec2db5dd814651bdf3f9164136d35591fa56eac691363a4da3b83822af1286515684b632ad23fa0c
+  data.tar.gz: e913df099cd9d9114d604c95e0d3236dd914b8ec5a70c52834f4fe7f9f133ad095d9e4a3abdf846f3a1c12d53370323e4eef08e2a6ff8ba5865afa3f43f19566

data/README.md

@@ -0,0 +1,53 @@
+# Ruby Ombre
+
+Ombre provides gradients for your terminal between any two hexidecimal RGB values.
+
+## Features
+
+* Horizontal, vertical, and diagonal (both directions) gradients from one color to another.
+## True Color Support
+
+This will only look gook 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 three main functions available for `Ombre`:
+
+```ruby
+# from_color and to_color in the below functions should be 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(from_color, to_color, text)
+Ombre.horizontal("FF0000", "0000FF", "############\n#          #\n# Horiz. ###\n# Ombre ####\n# Test #####\n# From #####\n# Red ######\n# To #######\n# Blue #####\n#          #\n############")
+
+# Returns the block of text marked up with colors to create a vertical gradient from top to bottom
+Ombre.vertical(from_color, to_color, text)
+Ombre.vertical("FF0000", "0000FF", "############\n#          #\n# Vertical #\n# Ombre ####\n# Test #####\n# From #####\n# Red ######\n# To #######\n# Blue #####\n#          #\n############")
+
+# Returns the block of text marked up with colors to create a diagonal gradient
+Ombre.diagonal(from_color, to_color, text)
+# from top-left to bottom-right by default
+Ombre.diagonal("FF0000", "0000FF", "############\n#          #\n# Diagonal #\n# Ombre ####\n# Test #####\n# From #####\n# Red ######\n# To #######\n# Blue #####\n#          #\n############")
+# from bottom-left to top-right changing the last argument
+Ombre.diagonal("FF0000", "0000FF", "############\n#          #\n# Diagonal #\n# Ombre ####\n# Test #####\n# From #####\n# Red ######\n# To #######\n# Blue #####\n#          #\n############", "up")
+```
+
+
+Copyright (c) 2022 Justin Paulson, released under the
+MIT license.

data/lib/ombre.rb

@@ -1,20 +1,28 @@
 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)
     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 color1, color2, 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)
     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 color1, color2, i/text.lines.max.length.to_f
+        color_text red, green, blue, char
+      end.join
+    end.join
+  end
+
+  def self.diagonal color1, color2, text, dir="down"
+    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 = dir=="down" ? (y + x)/(max_y + max_x).to_f : (max_y - y + x)/(max_y + max_x).to_f
+        red, green, blue = get_offset_color color1, color2, ratio
+        color_text red, green, blue, char
       end.join
     end.join
   end
@@ -29,13 +37,19 @@ class Ombre
     [red, green, blue]
   end
 
-  def self.get_steps c1, c2, i
+  def self.get_offset_color c1, c2, ratio
     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]
+    r_dist = (r1-r2).abs * ratio
+    red = r1 > r2 ? r1 - r_dist : r1 + r_dist
+    g_dist = (g1-g2).abs * ratio
+    green = g1 > g2 ? g1 - g_dist : g1 + g_dist
+    b_dist = (b1-b2).abs * ratio
+    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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ombre
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.3
 platform: ruby
 authors:
 - Justin Paulson
@@ -10,14 +10,18 @@ bindir: bin
 cert_chain: []
 date: 2022-04-20 00:00:00.000000000 Z
 dependencies: []
-description: Provides gradient colors for the command line using truecolor
+description: Provides gradient colors for command line output using RGB hex values.
 email: jpaulson@hey.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- MIT-LICENSE.txt
 files:
+- MIT-LICENSE.txt
+- README.md
 - lib/ombre.rb
-homepage: https://rubygems.org/gems/ombre
+homepage: https://github.com/justinpaulson/ombre
 licenses:
 - MIT
 metadata: {}
@@ -39,5 +43,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
-summary: Ombre
+summary: Ombre gradients for your terminal!
 test_files: []