redgreenblue 0.14.0 → 0.17.0

data/lib/redgreenblue/random.rb

@@ -1,4 +1,4 @@
-class RGB
+class RGB::Color
 
   # Shuffles the object's red, green, and blue values.
   def shuffle!
@@ -6,9 +6,9 @@ class RGB
     self
   end
 
-  # Creates a new RGB object with this object's red, green, and blue values shuffled.
+  # Creates a new RGB::Color with this object's red, green, and blue values shuffled.
   def shuffle
-    RGB.new values.shuffle
+    RGB::Color.new values.shuffle
   end
 
   # Assigns random values to red, green, and blue.
@@ -17,9 +17,23 @@ class RGB
     self
   end
 
-  # Creates a new RGB object with random red, green, and blue values.
+  # Creates a new RGB::Color with random red, green, and blue values.
   def self.rand
     new(Kernel::rand, Kernel::rand, Kernel::rand)
   end
 
 end
+
+
+module RGB
+
+  class << self
+
+    # Creates a new RGB::Color with random red, green, and blue values.
+    def rand
+      Color.rand
+    end
+
+  end
+
+end

data/lib/redgreenblue/rgb565.rb

@@ -1,4 +1,4 @@
-class RGB
+class RGB::Color
 
   # Returns the color in 16-bit RGB565 format.
   def rgb565
@@ -15,7 +15,7 @@ class RGB
     self.b = ( ( v & 0x001f )       ) << 3
   end
 
-  # Creates a new RGB color from 16-bit RGB565 data.
+  # Creates a new RGB::Color from 16-bit RGB565 data.
   def self.rgb565(rgb565_string)
     c = self.new
     c.rgb565 = rgb565_string
@@ -23,3 +23,17 @@ class RGB
   end
 
 end
+
+
+module RGB
+
+  class << self
+
+    # Creates a new RGB::Color from 16-bit RGB565 data.
+    def rgb565(rgb565_string)
+      Color.rgb565(rgb565_string)
+    end
+
+  end
+
+end

data/lib/redgreenblue/terminal.rb

@@ -1,4 +1,4 @@
-class RGB
+class RGB::Color
 
   # With help from:
   # - https://gist.github.com/XVilka/8346728

data/lib/redgreenblue/version.rb

@@ -1,7 +1,7 @@
-class RGB
+module RGB
 
   # redgreenblue version.
-  VERSION = '0.14.0'
+  VERSION = '0.17.0'
 
   # Returns RGB::VERSION.
   def self.version

data/lib/redgreenblue/view.rb

@@ -1,19 +1,25 @@
-class RGB
+class RGB::Color
 
-  # Prints details for the RGB object, using multiple lines.
-  def view
-    puts _inspect_view
+  # Prints a color swatch and details for the RGB::Color object, using multiple lines.
+  #
+  # You can optionally supply a second color to be shown inside the swatch, for comparison.
+  def view(other=nil)
+    puts _inspect_view other
   end
 
   alias v view
 
   private
 
-  def _inspect_view
+  def _inspect_view(other=nil)
     o = []
     o << 3.times.map { terminal_background + "      \e[0m "}
     o << [ "#{_inspect_hex} ", '%-7.7s ' % color_space, '        ' ]
 
+    if other
+      o[0][1] = terminal_background + '  ' + other.terminal_background + '  ' + terminal_background + "  \e[0m "
+    end
+
     o << components.map { |c| c.terminal_background + "  \e[0m " }
     o << %w(R: G: B:)
     o << values.map { |v| '%1.5f ' % v }

data/lib/redgreenblue/web.rb

@@ -1,59 +1,4 @@
-class RGB
-
-  #----------------------------------------------------------------------#
-  #                            Class Methods                             #
-  #----------------------------------------------------------------------#
-
-  class << self
-
-    # Returns CSS named colors, as per CSS Color Module Level 4.
-    #
-    # Optional selector argument can be:
-    # - String or Regexp (to select by name)
-    # - RGB color (to select by color)
-    # - Integer (to select by index).
-    # Selection by name (string or regular expression) is case-insensitive by default.
-    #
-    # @example No Selector
-    #  # All colors
-    #  RGB.css
-    #
-    #  # Pastels
-    #  RGB.css.select { |c| c.ostwald_cwk[1] > 0.6 }
-    # @example Select by Name
-    #  # Exact name
-    #  RGB.css 'pink'
-    #
-    #  # Regular expression
-    #  RGB.css /pink|rose/
-    #
-    # @example Select by RGB color
-    #  RGB.css RGB.hex('0ff')
-    def css(selector=nil)
-      @@css ||= load_gpl file: ( File.join File.dirname(__FILE__), 'palettes', 'css.gpl' ), freeze: true
-      case selector
-        when NilClass
-          @@css
-        when String
-          n = selector.downcase
-          @@css.select { |c| c.name == n }.first
-        when Regexp
-          r = Regexp.new selector.source, Regexp::IGNORECASE
-          @@css.select { |c| c.name =~ r }
-        when Integer
-          @@css[selector]
-        when self
-          @@css.select { |c| c == selector }
-        else
-          raise ArgumentError, 'Unsupported selector'
-      end
-    end
-
-  end
-
-  #----------------------------------------------------------------------#
-  #                           Instance Methods                           #
-  #----------------------------------------------------------------------#
+class RGB::Color
 
   # Returns the object's RGB value in hexadecimal notation as used in CSS.
   #
@@ -106,4 +51,61 @@ class RGB
     round ? contrast_ratio.round(8) : contrast_ratio
   end
 
+  # Returns true if this is one of the 216 so-called "web safe" colors, otherwise false.
+  def web_safe?
+    ( values - [0.0, 0.2, 0.4, 0.6, 0.8, 1.0] ).empty?
+  end
+
+end
+
+
+module RGB
+
+  class << self
+
+    # Returns CSS named colors, as per CSS Color Module Level 4.
+    #
+    # Optional selector argument can be:
+    # - String or Regexp (to select by name)
+    # - RGB color (to select by color)
+    # - Integer (to select by index).
+    # Selection by name (string or regular expression) is case-insensitive by default.
+    #
+    # @example No Selector
+    #  # All colors
+    #  RGB.css
+    #
+    #  # Pastels
+    #  RGB.css.select { |c| c.ostwald_cwk[1] > 0.6 }
+    # @example Select by Name
+    #  # Exact name
+    #  RGB.css 'pink'
+    #
+    #  # Regular expression
+    #  RGB.css /pink|rose/
+    #
+    # @example Select by RGB color
+    #  RGB.css RGB.hex('0ff')
+    def css(selector=nil)
+      @@css ||= load_gpl file: ( File.join File.dirname(__FILE__), 'palettes', 'css.gpl' ), freeze: true
+      case selector
+        when NilClass
+          @@css
+        when String
+          n = selector.downcase
+          @@css.select { |c| c.name == n }.first
+        when Regexp
+          r = Regexp.new selector.source, Regexp::IGNORECASE
+          @@css.select { |c| c.name =~ r }
+        when Integer
+          @@css[selector]
+        when RGB::Color
+          @@css.select { |c| c == selector }
+        else
+          raise ArgumentError, 'Unsupported selector'
+      end
+    end
+
+  end
+
 end

data/lib/redgreenblue.rb

@@ -1,4 +1,23 @@
-class RGB
+# The RGB module is the main namespace for redgreenblue.
+#
+# This module has many helper methods for creating RGB::Color objects.
+# The example below shows seven ways to create an RGB::Color object for the exact same color.
+# @example
+#  require 'redgreenblue'
+#
+#  pink = RGB.new(1, 0.6, 0.8)
+#  pink = RGB.rgb(255, 153, 204)
+#  pink = RGB.rrggbb(65535, 39321, 52428)
+#  pink = RGB.hex('f9c')
+#  pink = RGB.hsl(330, 1, 0.8)
+#  pink = RGB.hsv(330, 0.4, 1)
+#  pink = RGB.at(16751052)
+module RGB
+
+  # This class represents an RGB color.
+  class Color
+  end
+
 end
 
 %w(
@@ -15,7 +34,7 @@ end
 
   gamma
 
-  cie_1931 cie_1976
+  cie_1931 cie_1976 cie_1994
 
   name
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redgreenblue
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.17.0
 platform: ruby
 authors:
 - lllist.eu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-03 00:00:00.000000000 Z
+date: 2022-07-18 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -23,6 +23,7 @@ files:
 - lib/redgreenblue/bgr24bit.rb
 - lib/redgreenblue/cie_1931.rb
 - lib/redgreenblue/cie_1976.rb
+- lib/redgreenblue/cie_1994.rb
 - lib/redgreenblue/gamma.rb
 - lib/redgreenblue/gif.rb
 - lib/redgreenblue/gpl.rb
@@ -74,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: A simple Ruby library for handling RGB colors.