rgb 0.1.0 → 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5220fed36087348bdf09b5d67a604d0eb64df18c8d4ce7744c8c64d19275dd82
+  data.tar.gz: e6fa4726da09bc76575a17d63b8ae589abc33cb2e7dfff10e363e96e74af7bc7
+SHA512:
+  metadata.gz: 0ae1005d382691de01596d72ded5639a25b903eb4898f53eb79f00dc0f8b20056913f6c52ba561b03e8c4eb94cf9f09c83946c8765f64b7aa59356d482a29137
+  data.tar.gz: af38e0378034c398b7ef5efdc641fe4a43e812e15a57b4fafeef76f3aea497a49290f9db388ee02fde28864fcd1968f39bc57c0cccc903450e5fee395ee9061a

data/lib/rgb/color.rb

@@ -1,139 +1,182 @@
 module RGB
   class Color
-    attr_reader :h, :s, :l
+    attr_reader :hue, :saturation, :lightness # ? HSL
 
-    def self.from_rgb_hex(color)
-      color = "#%.6x" % color if color.is_a? Integer
-      rgb = color[1,7].scan(/.{2}/).map{|component| component.to_i(16)}
-      from_rgb(*rgb)
-    end
-
-    def self.from_rgb(*rgb)
-      rgb.map!{|c| c / 255.0}
-      min_rgb = rgb.min
-      max_rgb = rgb.max
-      delta = max_rgb - min_rgb
-
-      lightness = (max_rgb + min_rgb) / 2.0
+    class << self
+      def from_rgb_hex(color)
+        color = '#%.6x' % color if color.is_a? Integer
+        rgb = color[1,7].scan(/.{2}/).map{ |component| component.to_i(16) }
+        from_rgb(*rgb)
+      end
 
-      if delta < 1e-5
-        hue = 0
-        saturation = 0
-      else
-        saturation = if ( lightness < 0.5 )
-          delta / ( max_rgb + min_rgb )
+      def calc_saturation(max_rgb, min_rgb, delta, lightness)
+        if lightness < 0.5
+          delta / (max_rgb + min_rgb)
         else
-         delta / ( 2 - max_rgb - min_rgb )
+          delta / (2 - max_rgb - min_rgb)
         end
+      end
 
-        deltas = rgb.map{|c| (((max_rgb - c) / 6.0) + (delta / 2.0)) / delta}
+      def from_rgb(*rgb)
+        from_fractions(*rgb_to_hsl(*rgb))
+      end
 
-        hue = if (rgb[0] - max_rgb).abs < 1e-5
-         deltas[2] - deltas[1]
-        elsif (rgb[1] - max_rgb).abs < 1e-5
-         ( 1.0 / 3.0 ) + deltas[0] - deltas[2]
+      def rgb_to_hsl(*rgb)
+        rgb.map!{ |c| c / 255.0 }
+        min_rgb, max_rgb = rgb.min, rgb.max
+        delta = max_rgb - min_rgb
+
+        lightness = (max_rgb + min_rgb) / 2.0
+
+        if delta < 1e-5
+          hue = saturation = 0
         else
-         ( 2.0 / 3.0 ) + deltas[1] - deltas[0]
+          saturation = calc_saturation(max_rgb, min_rgb, delta, lightness)
+          deltas = rgb.map{ |c| (((max_rgb - c) / 6.0) + (delta / 2.0)) / delta }
+
+          hue = if (rgb[0] - max_rgb).abs < 1e-5
+            deltas[2] - deltas[1]
+          elsif (rgb[1] - max_rgb).abs < 1e-5
+            (1.0 / 3.0) + deltas[0] - deltas[2]
+          else
+            (2.0 / 3.0) + deltas[1] - deltas[0]
+          end
+
+          hue += 1 if hue < 0
+          hue -= 1 if hue > 1
         end
-        hue += 1 if hue < 0
-        hue -= 1 if hue > 1
+        [hue, saturation, lightness]
       end
-      from_fractions(hue, saturation, lightness)
-    end
 
-    def self.from_fractions(hue, saturation, lightness)
-      new(360 * hue, saturation, lightness)
+      def from_fractions(hue, saturation, lightness)
+        new(360 * hue, saturation, lightness)
+      end
     end
 
     def initialize(*hsl)
-      self.h, self.s, self.l = hsl
+      self.hue, self.saturation, self.lightness = hsl
     end
 
     def to_rgb
-      m2 = l <= 0.5 ? l * (s + 1) : l + s - l * s
-      m1 = l * 2 - m2
-      [hue_to_rgb(m1, m2, hp + 1.0/3), hue_to_rgb(m1, m2, hp), hue_to_rgb(m1, m2, hp - 1.0/3)].map { |c| (c * 0xff).round }
+      m2 = if lightness <= 0.5
+        lightness * (saturation + 1)
+      else
+        lightness + saturation - lightness * saturation
+      end
+
+      m1 = lightness * 2 - m2
+
+      [
+        hue_to_rgb(m1, m2, hue_percentage + 1.0 / 3),
+        hue_to_rgb(m1, m2, hue_percentage),
+        hue_to_rgb(m1, m2, hue_percentage - 1.0 / 3)
+      ].map { |c| (c * 0xff).round }
     end
 
     def to_hsl
-      [h,s,l]
+      [hue.to_i, saturation.to_f, lightness.to_f]
+      # [((hue / 255) * 360).to_i, saturation.to_f, lightness.to_f]
     end
 
     def to_rgb_hex
-      "#" + to_rgb.map {|c| "%02X" % c }.join
+      '#' + to_rgb.map {|c| '%02X' % c }.join
     end
 
-    def h=(hue)
-      @h = hue % 360
+    def hue=(value)
+      @hue = value % 360
+      check_hue()
     end
 
-    def s=(saturation)
-      @s = if saturation < 0
+    def saturation=(value)
+      @saturation = if value < 0
         0.0
-      elsif saturation > 1
+      elsif value > 1
         1.0
       else
-        saturation
+        value
       end
     end
 
-    def l=(lightness)
-      @l = if lightness < 0
+    def lightness=(value)
+      @lightness = if value < 0
         0.0
-      elsif lightness > 1
+      elsif value > 1
         1.0
       else
-        lightness
+        value
       end
     end
 
     def lighten!(amount)
-      @l += amount / 100.0
+      @lightness += amount / 100.0
+      check_lightness()
     end
 
     def lighten_percent!(percentage)
-      @l += (1 - @l) * (percentage / 100.0)
+      @lightness += (1 - @lightness) * (percentage / 100.0)
+      check_lightness()
     end
 
     def darken!(amount)
-      @l -= (amount / 100.0)
+      @lightness -= (amount / 100.0)
+      @lightness = 0 if @lightness < 0
+      check_lightness()
     end
 
     def darken_percent!(percentage)
-      @l *= 1.0 - (percentage / 100.0)
+      @lightness *= 1.0 - (percentage / 100.0)
+      check_lightness()
     end
 
     def saturate!(amount)
-      @s += amount / 100.0
+      @saturation += amount / 100.0
+      check_saturation()
     end
 
     def saturate_percent!(percentage)
-      @s += (1 - @s) * (percentage / 100.0)
+      @saturation += (1 - @saturation) * (percentage / 100.0)
+      check_saturation()
     end
 
     def desaturate!(amount)
-      @s -= amount / 100.0
+      @saturation -= amount / 100.0
+      check_saturation()
     end
 
     def desaturate_percent!(percentage)
-      @s *= (1.0 - (percentage / 100.0))
+      @saturation *= (1.0 - (percentage / 100.0))
+      check_saturation()
+    end
+
+    def invert!
+      @hue, @saturation, @lightness = RGB::Color.from_rgb(*self.to_rgb.map{ |c| 255 - c }).to_hsl
+    end
+
+
+    # ? Shamelessly stolen from
+    # ? https://github.com/chriseppstein/compass-colors/blob/master/lib/compass-colors/sass_extensions.rb#L86
+    # ? Though, I've inverted the coefficients, which seems more logical
+    def mix!(other, pct = 50.0)
+      coeff = pct.to_f / 100.0
+      new_rgb = to_rgb.zip(other.to_rgb).map{ |c1, c2| (c1 * (1 - coeff)) + (c2 * coeff) }
+      h, s, l = self.class.rgb_to_hsl(*new_rgb)
+      self.hue, self.saturation, self.lightness = 360 * h, s, l
     end
 
-    # define non-bang methods
+    # ? Define non-bang methods
     [:darken, :darken_percent, :lighten, :lighten_percent, :saturate, :saturate_percent, :desaturate,
-      :desaturate_percent].each do |method_name|
+      :desaturate_percent, :invert, :mix].each do |method_name|
         define_method method_name do |*args|
           dup.tap { |color| color.send(:"#{method_name}!", *args) }
         end
     end
 
   private
-    #hue as a percentage
-    def hp
-      h / 360.0
+    def hue_percentage
+      hue / 360.0
     end
 
-    # helper for making rgb
+    # ? Helper for making rgb
     def hue_to_rgb(m1, m2, h)
       h += 1 if h < 0
       h -= 1 if h > 1
@@ -142,5 +185,26 @@ module RGB
       return m1 + (m2 - m1) * (2.0/3 - h) * 6 if h * 3 < 2
       return m1
     end
+
+    # ? Method to ensure lightness value is valid (0-1)
+    def check_lightness
+      if @lightness > 1; @lightness = 1.0; end;
+      if @lightness < 0; @lightness = 0.0; end;
+      @lightness
+    end
+
+    # ? Method to ensure saturation value is valid (0-1)
+    def check_saturation
+      if @saturation > 1; @saturation = 1.0; end;
+      if @saturation < 0; @saturation = 0.0; end;
+      @saturation
+    end
+
+    # ? Method to ensure hue value is valid (0-360)
+    def check_hue
+      if @hue > 360; @hue = 360; end;
+      if @hue < 0;   @hue = 0;   end;
+      @hue
+    end
   end
 end

data/lib/rgb/version.rb

@@ -0,0 +1,3 @@
+module RGB
+  VERSION = '0.1.2'
+end

data/lib/rgb.rb

@@ -1 +1,5 @@
-require "rgb/color"
+module RGB
+end
+
+require 'rgb/color'
+require 'rgb/version'

metadata

@@ -1,81 +1,104 @@
 --- !ruby/object:Gem::Specification
 name: rgb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.1.2
 platform: ruby
 authors:
-- Dmitry Plashchynski
-autorequire: 
+- Dzmitry Plashchynski
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-02-12 00:00:00.000000000 Z
+date: 2024-05-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.9
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.13.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.22.0
 description: A library built to handle the easy conversion, comparison and manipulation
   of colors with CSS-style hex color notation.
-email: plashchynski@gmail.com
+email:
+- plashchynski@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
 - lib/rgb.rb
 - lib/rgb/color.rb
+- lib/rgb/version.rb
 homepage: https://github.com/plashchynski/rgb
-licenses: []
-post_install_message: 
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.25
-signing_key: 
-specification_version: 3
-summary: A library built to handle the easy conversion, comparison and manipulation
-  of colors with CSS-style hex color notation.
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: A simple Ruby library built to handle easy conversion and manipulation of
+  colors.
 test_files: []

data/README.md

@@ -1,54 +0,0 @@
-rgb
-===
-
-A simple Ruby library built to handle the easy conversion and manipulation of colors. Inspired by compass-colors https://github.com/chriseppstein/compass-colors and jColour.js https://github.com/lingo/jcolour.
-
-Example
-===
-
-  require "rgb"
-  
-  # Supported input data color formas:
-  color = RGB::Color.from_rgb_hex("#333333")
-  color = RGB::Color.from_rgb_hex(0xFF0000)
-  color = RGB::Color.from_rgb(115, 38, 38)
-  color = RGB::Color.from_fractions(0, 1.0, 0.5) # HSL
-
-  # Supported color manipulations:
-  color.darken(20)
-  color.darken_percent(10)
-  color.darken!(20)
-  color.darken_percent!(10)
-  color.lighten(20)
-  color.lighten_percent(20)
-  color.lighten!(20)
-  color.lighten_percent!(20)
-  color.saturate(20)
-  color.saturate_percent(20)
-  color.saturate!(20)
-  color.saturate_percent!(20)
-  color.desaturate(20)
-  color.desaturate_percent(20)
-  color.desaturate!(20)
-  color.desaturate_percent!(20)
-
-  # Also you can adjust color hue, saturation, and lightness values manually:
-  color.h = 0.1
-  color.s = 0.2
-  color.l = 0.3
-
-  # Supported output formats:
-  color.to_rgb_hex
-  => "#732626"
-  color.to_hsl
-  => [0, 1.0, 0.5]
-  color.to_rgb
-  => [115, 38, 38]
-
-
-Resources
-===
-
-* GitHub Source: https://github.com/plashchynski/rgb
-
-Copyright (c) 2013 Dmitry Plashchynski. Released under the MIT open source license.