is_dark 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9dad19d8626d41d0e19a099e5da1439a1159fb484ff836c4c8b3fe42f8f990dd
+  data.tar.gz: f456d8b95650357c374a74b5f5909574d7a8b7f5540fed03f5e2652a51bf2530
+SHA512:
+  metadata.gz: 414aef11db695594ebf025376724235e489a1d8843e93fec57b1862cff0ea5e68e59cf6f7f7d7082dab30cdf12e1339ab4695ec120294524da632fd4026b1362
+  data.tar.gz: 91cdfa5191f92ea826f60ef951df06f5d204d444943ad06b998a3092a7642fbc796824594a090127903135469767eba5a5580ab8098386be29d13b124407ac73

data/lib/is_dark.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require 'rmagick'
+
+# The `Is Dark` class is designed to determine whether a given color or pixel is dark based on luminance
+# standards defined by the W3C. It utilizes the `rmagick` library to handle image processing tasks.
+# The class includes methods to analyze colors from hexadecimal values, individual pixels,
+# and areas within images blobs. It also supports debugging features to visualize the analysis process.
+#
+# Key features include:
+# - **Color Analysis**: Determines if a color is dark based on its luminance.
+# - **- **Pixel Analysis**: Analysis individual pixels from an image.
+# - **Area Analysis**: Evaluates the darkness of a specified area within an image blob.
+# - **Debugging**: Provides options to enable debugging information and visualize the analysis on a PDF file.
+class IsDark
+  BLUE_LUMINANCE_COEFFICIENT = 0.0722
+  GREEN_LUMINANCE_COEFFICIENT = 0.7152
+  HIGH_LUMINANCE_DIVIDER = 1.055
+  HIGH_LUMINANCE_POWER = 2.4
+  LOW_LUMINANCE_DIVIDER = 12.92
+  LUMINANCE_THRESHOLD = 0.05
+  MAXIMUM_COLOR_DEPTH = 255
+  MAX_COLOR_VALUE_MULTIPLIER = 655
+  MAX_COLOR_VALUE = MAX_COLOR_VALUE_MULTIPLIER * MAXIMUM_COLOR_DEPTH
+  LINEAR_LUMINANCE_THRESHOLD = (1 / (LOW_LUMINANCE_DIVIDER * 100.0)) * MAXIMUM_COLOR_DEPTH
+  NONLINEAR_TRANSFORM_DIVIDER = 1.055
+  NONLINEAR_TRANSFORM_OFFSET = 0.055
+  RED_LUMINANCE_COEFFICIENT = 0.2126
+  DEFAULT_PERCENT_OF_DOTS = 80
+  DEFAULT_MATRIX_RANGE = (0..10).freeze
+  DEFAULT_DEBUG_FILE_PATH = '/tmp/is_dark_debug_file.pdf'
+
+  @r = 0
+  @g = 0
+  @b = 0
+  @colorset = MAXIMUM_COLOR_DEPTH
+  @percent = DEFAULT_PERCENT_OF_DOTS
+  @matrix = DEFAULT_MATRIX_RANGE
+  @luminance = LUMINANCE_THRESHOLD
+  @with_not_detected_as_white = true
+  @with_debug = false
+  @with_debug_file = false
+  @debug_file_path = DEFAULT_DEBUG_FILE_PATH
+
+  def initialize(settings = {})
+    configure(settings)
+  end
+
+  def configure(settings = {})
+    @percent = settings[:percent] || DEFAULT_PERCENT_OF_DOTS
+    @matrix = settings[:matrix] || DEFAULT_MATRIX_RANGE
+    @luminance = settings[:luminance] || LUMINANCE_THRESHOLD
+    @with_not_detected_as_white = settings[:with_not_detected_as_white] || true
+    @with_debug = settings[:with_debug] || false
+    @with_debug_file = settings[:with_debug_file] || false
+    @debug_file_path = settings[:debug_file_path] || DEFAULT_DEBUG_FILE_PATH
+  end
+
+  def color(hex)
+    @r, @g, @b = hex.match(/^#(..)(..)(..)$/).captures.map(&:hex)
+    @colorset = MAXIMUM_COLOR_DEPTH
+    dark?
+  end
+
+  def magick_pixel(pix, x = nil, y = nil)
+    @r = pix.red.to_f
+    @g = pix.green.to_f
+    @b = pix.blue.to_f
+    @colorset = MAX_COLOR_VALUE
+    dark?(x, y)
+  end
+
+  def magick_pixel_from_blob(x, y, blob)
+    image = Magick::Image.read(blob).first
+    pix = image.pixel_color(x, y)
+    magick_pixel(pix, x, y)
+  end
+
+  # (x, y) is the left corner of an element over a blob, height and width is the element's size
+  def magick_area_from_blob(x, y, blob, height, width)
+    image = Magick::Image.read(blob).first
+    dark = false
+    dots = []
+    @matrix.each do |xx|
+      @matrix.each do |yy|
+        dots << { x: (x + (width * xx / @matrix.count)).to_i, y: (y + (height * yy / @matrix.count)).to_i }
+      end
+    end
+
+    points = 0
+    if @with_debug_file
+      old_x = false
+      old_y = false
+    end
+    p '==================================================================================' if @with_debug
+    dots.each do |dot|
+      x = dot[:x].to_i
+      y = dot[:y].to_i
+      pix = image.pixel_color(x, y)
+      l = magick_pixel(pix, x, y)
+      points += 1 if l
+      next unless @with_debug_file
+
+      draw_debug_files(image, x, y, old_x, old_y)
+      old_y = y
+      old_x = x
+    end
+    dark = true if points >= (dots.length / 100) * @percent
+    if @with_debug
+      percent_calculated = points/(dots.length / 100)
+      p '=================================================================================='
+      p "Total Points: #{dots.length}, dark points amount:#{points}"
+      p "Is \"invert to white not detectd pixels\" option enabled?:#{@with_not_detected_as_white}"
+      p "Percent of dark dots in the matrix: #{percent_calculated}%"
+      p "Percent to consider as a dark area from settings: #{@percent}%"
+      p "Luminance value is: #{@luminance}"
+      p "Is Area Dark?: #{dark}"
+      p "have a look on #{@debug_file_path} file to see your tested area of a blob" if @with_debug_file
+      p '=================================================================================='
+    end
+    dark
+  end
+
+  def draw_debug_files(image, x, y, old_x, old_y)
+    return unless old_x && old_y
+
+    gc = Magick::Draw.new
+    gc.line(x, y, old_x, old_y)
+    gc.stroke('black')
+    gc.draw(image)
+    image.write(@debug_file_path)
+  end
+
+  # detects a dark color based on luminance W3 standarts ( https://www.w3.org/TR/WCAG20/#relativeluminancedef )
+  def dark?(x = nil, y = nil)
+    dark = false
+    inverted = false
+    pixel = [@r.to_f, @g.to_f, @b.to_f]
+    return true if pixel == [0.00, 0.00, 0.00] # hardcoded exception
+
+    if @with_not_detected_as_white && pixel[0] == 0.0 && pixel[1] == 0.0 && pixel[2] == 0.0
+      pixel = [MAXIMUM_COLOR_DEPTH, MAXIMUM_COLOR_DEPTH, MAXIMUM_COLOR_DEPTH]
+      inverted = true
+    end
+    calculated = []
+    pixel.each do |color|
+      color /= @colorset
+      if color <= LINEAR_LUMINANCE_THRESHOLD
+        color /= LOW_LUMINANCE_DIVIDER
+      else
+        color = ((color + NONLINEAR_TRANSFORM_OFFSET) / NONLINEAR_TRANSFORM_DIVIDER)**HIGH_LUMINANCE_POWER
+      end
+      calculated << color
+    end
+    l = (RED_LUMINANCE_COEFFICIENT * calculated[0]) +
+        (GREEN_LUMINANCE_COEFFICIENT * calculated[1]) +
+        (BLUE_LUMINANCE_COEFFICIENT * calculated[2])
+    dark = true if l <= @luminance
+    if @with_debug
+      debug = { X: x, Y: y, R: @r, G: @g, B: @b, 'luminance value': l, dark?: dark,
+                'inverted to white': inverted }
+      p debug
+    end
+    dark
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: is_dark
+version: !ruby/object:Gem::Version
+  version: 0.2.3
+platform: ruby
+authors:
+- Sergei Illarionov
+- Liamshin Ilia
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.69'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.69'
+description: "Detects a dark color based on luminance W3 standarts ( https://www.w3.org/TR/WCAG20/#relativeluminancedef
+  ). \n\n It has these options: \n * is a hex color dark \n  * is an Imagick pixel
+  dark \n * is an Imagick pixel from a blob dark \n * is an area in a blob over a
+  dark background (uses Imagick for it too). \n\n An example practical aspect: it
+  can be useful to understand will a black colored text be visible or not over an
+  area."
+email: butteff.ru@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/is_dark.rb
+homepage: https://butteff.ru/en/
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/butteff/is_dark_ruby_gem
+  rubygems_mfa_required: 'true'
+post_install_message: You can find docs about is_dark gem on https://butteff.ru/en/extensions
+  or on https://github.com/butteff/is_dark_ruby_gem
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Detects a dark background under an area or by a color code
+test_files: []