percept 0.0.1 → 3.0.0

data/Gemfile.lock

@@ -0,0 +1,138 @@
+PATH
+  remote: .
+  specs:
+    percept (3.0.0)
+      rmagick (~> 6.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    coderay (1.1.3)
+    colorize (1.1.0)
+    diff-lcs (1.6.2)
+    docile (1.4.1)
+    ffi (1.17.2-x86_64-darwin)
+    ffi (1.17.2-x86_64-linux-gnu)
+    formatador (1.1.0)
+    guard (2.19.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      logger (~> 1.6)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      ostruct (~> 0.6)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.5.0)
+      guard (~> 2.0)
+      rubocop (< 2.0)
+    json (2.12.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.7.0)
+    lumberjack (1.2.10)
+    method_source (1.1.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    observer (0.1.2)
+    ostruct (0.6.1)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    pkg-config (1.6.2)
+    prism (1.4.0)
+    pry (0.15.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    regexp_parser (2.10.0)
+    rmagick (6.1.1)
+      observer (~> 0.1)
+      pkg-config (~> 1.4)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.3)
+    rtesseract (3.1.4)
+    rubocop (1.75.6)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.6.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    ruby-progressbar (1.13.0)
+    shellany (0.0.1)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.1)
+    simplecov_json_formatter (0.1.4)
+    thor (1.3.2)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+
+PLATFORMS
+  x86_64-darwin-23
+  x86_64-darwin-24
+  x86_64-linux
+
+DEPENDENCIES
+  colorize
+  guard
+  guard-rspec
+  guard-rubocop
+  percept!
+  rake
+  rspec
+  rtesseract
+  rubocop
+  rubocop-rake
+  rubocop-rspec
+  simplecov
+
+BUNDLED WITH
+   2.6.8

data/Guardfile

@@ -0,0 +1,10 @@
+guard :rspec, failed_mode: :keep, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}/" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end
+
+guard :rubocop, all_on_start: false, cli: ['-D'] do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/README.md

@@ -27,3 +27,23 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Publishing
+
+1. Set up a personal access token with the `write:packages` scope and add it to
+   your `~/.gem/credentials` file as described in [GitHub's
+   documentation][github-rubygems-registry-doc]. Set your `credentials` file to
+   be only readable by you, if you haven't already:
+   ```
+   chmod 0600 ~/.gem/credentials
+   ```
+2. Build the gem:
+   ```
+   gem build percept.gemspec
+   ```
+3. Publish to Github Packages:
+   ```
+   gem push --key github --host https://rubygems.pkg.github.com/informedk12 percept-<version>.gem`
+   ```
+
+[github-rubygems-registry-doc]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry#authenticating-with-a-personal-access-token

data/Rakefile

@@ -1 +1,19 @@
 require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+task default: [:rubocop, :spec]
+
+RuboCop::RakeTask.new
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--force-color'
+end
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require_relative 'lib/percept'
+  ARGV.clear
+  IRB.start
+end

data/bin/percept

@@ -2,4 +2,11 @@
 
 require_relative '../lib/percept'
 
-Percept::Runner.new.run
+if ARGV.length < 2
+  puts 'need an option and file name as arguments'
+  exit
+elsif ARGV.first == '--lines'
+  Percept::Runner.new.color_lines(ARGV.last)
+elsif ARGV.first == '--fields'
+  Percept::Runner.new.color_fields(ARGV.last)
+end

data/lib/ext/rmagick_pixel.rb

@@ -0,0 +1,19 @@
+module Magick
+
+  class Pixel
+
+    include Percept::PixelUtils
+
+    def scale_down(color_value)
+      return 0 if color_value.zero?
+      (color_value + 1) / 256 - 1
+    end
+
+    def scale_up(color_value)
+      return 0 if color_value.zero?
+      (color_value + 1) * 256 - 1
+    end
+
+  end
+
+end

data/lib/percept/checkbox_collection.rb

@@ -0,0 +1,19 @@
+module Percept
+
+  class CheckboxCollection
+
+    include Enumerable
+
+    attr_accessor :checkboxes
+
+    def initialize
+      self.checkboxes = []
+    end
+
+    def each
+      checkboxes.each { |checkbox| yield(checkbox) }
+    end
+
+  end
+
+end

data/lib/percept/checkbox_detector.rb

@@ -0,0 +1,19 @@
+module Percept
+
+  class CheckboxDetector
+
+    include Percept::Utils
+
+    attr_accessor :image
+
+    def detect_checkboxes(image)
+      self.image = image
+      # checkboxes = checkbox_collection.new
+    end
+
+    def find_checkboxes
+    end
+
+  end
+
+end

data/lib/percept/checkbox_field.rb

@@ -0,0 +1,24 @@
+module Percept
+
+  class CheckboxField
+
+    attr_accessor :start_x, :end_x, :start_y, :end_y
+
+    def initialize(params)
+      self.start_x = params.fetch(:start_x)
+      self.start_y = params.fetch(:start_y)
+      self.end_x = params.fetch(:end_x)
+      self.end_y = params.fetch(:end_y)
+    end
+
+    def width
+      end_x - start_x
+    end
+
+    def height
+      end_y - start_y
+    end
+
+  end
+
+end

data/lib/percept/color_utils.rb

@@ -0,0 +1,17 @@
+module Percept
+
+  module ColorUtils
+
+    def color!(red, green, blue)
+      pixels.each do |pixel|
+        pixel.scaled_red = red
+        pixel.scaled_green = green
+        pixel.scaled_blue = blue
+      end
+
+      store_pixels!
+    end
+
+  end
+
+end

data/lib/percept/config.rb

@@ -0,0 +1,35 @@
+module Percept
+
+  class Config
+
+    ATTRIBUTES = %i[
+      line_length color_tolerance field_padding min_field_height
+      max_field_height image_class output_path max_color_tolerance
+      min_color_tolerance field_edge_buffer max_line_height
+    ].freeze
+
+    attr_accessor(*ATTRIBUTES)
+
+    def initialize(options = {})
+      self.line_length = options.fetch(:line_length) { 30 }
+      self.max_line_height = options.fetch(:max_line_height) { 10 }
+      self.min_color_tolerance = options.fetch(:min_color_tolerance) { 200 }
+      self.max_color_tolerance = options.fetch(:min_color_tolerance) { 230 }
+      self.color_tolerance = min_color_tolerance
+      self.field_padding = options.fetch(:field_padding) { 1 }
+      self.min_field_height = options.fetch(:min_field_height) { 20 }
+      self.max_field_height = options.fetch(:max_field_height) { 60 }
+      self.field_edge_buffer = options.fetch(:field_edge_buffer) { 2 }
+      self.image_class = options.fetch(:image_class) { Percept::RMagickImage }
+      self.output_path = options.fetch(:output_path) { 'output.png' }
+      invalid_keys = options.keys - Config::ATTRIBUTES
+      raise "invalid keys: #{invalid_keys}" if invalid_keys.any?
+    end
+
+    def maximize_color_tolerance!
+      self.color_tolerance = max_color_tolerance
+    end
+
+  end
+
+end

data/lib/percept/field.rb

@@ -0,0 +1,74 @@
+module Percept
+
+  class Field
+
+    include Percept::ColorUtils
+
+    attr_accessor :start_x, :end_x, :start_y, :end_y, :line, :image
+
+    def initialize(params)
+      self.start_x = params.fetch(:start_x)
+      self.end_x = params.fetch(:end_x)
+      self.start_y = params.fetch(:start_y)
+      self.end_y = params.fetch(:end_y)
+      self.line = params.fetch(:line)
+      self.image = params.fetch(:image)
+    end
+
+    def pixels
+      @pixels ||= top_pixels + bottom_pixels + left_pixels + right_pixels
+    end
+
+    def height
+      end_y - start_y
+    end
+
+    def width
+      end_x - start_x
+    end
+
+    def enclosed_pixels
+      image.get_pixels(start_x, start_y, width, height)
+    end
+
+    def blackish_pixels
+      enclosed_pixels.select(&:blackish?)
+    end
+
+    def contains_text?
+      blackish_pixels.size > 100
+    end
+
+    def overlaps?(other)
+      !(start_x > other.end_x || end_x < other.start_x ||
+        start_y > other.end_y || end_y < other.start_y)
+    end
+
+    def store_pixels!
+      image.store_pixels(start_x, start_y, width, 1, top_pixels)
+      image.store_pixels(start_x, end_y - 1, width, 1, bottom_pixels)
+      image.store_pixels(start_x, start_y + 1, 1, height - 2, left_pixels)
+      image.store_pixels(end_x - 1, start_y + 1, 1, height - 2, right_pixels)
+    end
+
+  private
+
+    def top_pixels
+      @top_pixels ||= image.get_pixels(start_x, start_y, width, 1)
+    end
+
+    def bottom_pixels
+      @bottom_pixels ||= image.get_pixels(start_x, end_y - 1, width, 1)
+    end
+
+    def left_pixels
+      @left_pixels ||= image.get_pixels(start_x, start_y + 1, 1, height - 2)
+    end
+
+    def right_pixels
+      @right_pixels ||= image.get_pixels(end_x - 1, start_y + 1, 1, height - 2)
+    end
+
+  end
+
+end

data/lib/percept/field_collection.rb

@@ -0,0 +1,29 @@
+module Percept
+
+  class FieldCollection
+
+    include Enumerable
+
+    attr_accessor :fields
+
+    def initialize
+      self.fields = []
+    end
+
+    def <<(new_field)
+      return if fields.any? { |field| field.overlaps?(new_field) }
+
+      fields << new_field
+    end
+
+    def each
+      fields.each { |field| yield(field) }
+    end
+
+    def size
+      fields.size
+    end
+
+  end
+
+end

data/lib/percept/field_detector.rb

@@ -0,0 +1,56 @@
+module Percept
+
+  class FieldDetector
+
+    def detect_fields(image)
+      field_collection = FieldCollection.new
+
+      image.filtered_lines.map do |line|
+        field = detect_field(line, image)
+        field_collection << field if field
+      end
+
+      field_collection
+    end
+
+    def detect_field(line, image)
+      stopping_point = [0, line.start_y - Percept.config.max_field_height].max
+      starting_point = line.start_y - 2
+      min_index = line.start_y - Percept.config.min_field_height
+
+      return nil unless min_index >= 0
+
+      buffered_start  = line.start_x + Percept.config.field_edge_buffer
+      buffered_length = line.length - 2 * Percept.config.field_edge_buffer
+
+      starting_point.downto(stopping_point) do |index|
+        pixels = image.get_pixels(buffered_start, index, buffered_length, 1)
+        blackish_pixel = pixels.any?(&:blackish?)
+
+        if index >= min_index && blackish_pixel
+          return nil
+        elsif blackish_pixel
+          return Percept::Field.new(
+            start_x: line.start_x,
+            end_x: line.end_x,
+            start_y: index + 1,
+            end_y: line.start_y,
+            line: line,
+            image: image,
+          )
+        end
+      end
+
+      Percept::Field.new(
+        start_x: line.start_x,
+        end_x: line.end_x,
+        start_y: stopping_point,
+        end_y: line.start_y,
+        line: line,
+        image: image,
+      )
+    end
+
+  end
+
+end

data/lib/percept/image.rb

@@ -0,0 +1,60 @@
+module Percept
+
+  class Image
+
+    extend Forwardable
+
+    attr_accessor :file_path
+
+    def initialize(file_path)
+      self.file_path = file_path
+    end
+
+    def config
+      Percept.config
+    end
+
+    def filtered_lines
+      lines.filtered.split
+    end
+
+    def fields
+      @fields ||= FieldDetector.new.detect_fields(self)
+    end
+
+    def checkbox_fields
+      [CheckboxField.new(start_x: 10, end_x: 27, start_y: 5, end_y: 22)]
+    end
+
+    def get_pixels(x, y, columns, rows)
+      retrieve_pixels(x, y, columns, rows)
+    end
+
+    def get_rows(x, y, columns, rows)
+      retrieve_pixels(x, y, columns, rows).each_slice(rows).to_a
+    end
+
+    def retrieve_row(row_number)
+      get_pixels(0, row_number, column_count, 1)
+    end
+
+    def lines
+      @lines ||= LineDetector.new.detect_lines(self)
+    end
+
+    def magick_column(column_number)
+      get_pixels(column_number, 0, 1, row_count)
+    end
+
+    def to_s
+      "#<#{self.class}:#{object_id} " \
+      "columns: #{column_count}, rows: #{row_count}>"
+    end
+
+    def inspect
+      to_s
+    end
+
+  end
+
+end

data/lib/percept/line.rb

@@ -2,17 +2,129 @@ module Percept
 
   class Line
 
-    attr_accessor :start_x, :end_x, :start_y, :end_y, :row
+    include Percept::Utils
+    include Percept::ColorUtils
+
+    attr_accessor :start_x, :end_x, :start_y, :rows, :image
+    attr_reader :end_y
+
     def initialize(params)
       self.start_x = params.fetch(:start_x)
       self.end_x = params.fetch(:end_x)
       self.start_y = params.fetch(:start_y)
-      self.end_y = params.fetch(:end_y) { start_y }
-      self.row = params.fetch(:row)
+      self.end_y = params.fetch(:end_y) { start_y + 1 }
+      self.rows = params.fetch(:rows) { [params.fetch(:row)] }
+      self.image = params.fetch(:image)
     end
 
     def pixels
-      row
+      @pixels ||= rows.flat_map { |row| row[start_x...end_x] }
+    end
+
+    def =~(other)
+      overlaps_x?(other) && overlaps_y?(other)
+    end
+
+    def overlaps_x?(other)
+      !(end_x < other.start_x || start_x > other.end_x)
+    end
+
+    def overlaps_y?(other)
+      !(end_y < other.start_y || start_y > other.end_y)
+    end
+
+    def end_y=(new_end_y)
+      raise 'end_y must be greater than start_y' unless new_end_y > start_y
+      @end_y = new_end_y
+    end
+
+    def to_s
+      attributes.to_s
+    end
+
+    def inspect
+      to_s
+    end
+
+    def attributes
+      {
+        start_x: start_x,
+        end_x: end_x,
+        start_y: start_y,
+        end_y: end_y,
+      }
+    end
+
+    def full_attributes
+      attributes.merge(rows: rows, image: image)
+    end
+
+    def length
+      end_x - start_x
+    end
+
+    def height
+      end_y - start_y
+    end
+
+    def split
+      lines = LineCollection.new
+      next_x = start_x
+      intersections.each do |x_coordinate|
+        if x_coordinate == next_x
+          next_x += 1
+          next
+        end
+        line = copy_line(start_x: next_x, end_x: x_coordinate)
+        next_x = x_coordinate + 1
+        lines << line unless line.short?
+      end
+      if next_x < end_x
+        line = copy_line(start_x: next_x)
+        lines << line unless line.short?
+      end
+      lines
+    end
+
+    def copy_line(params)
+      Line.new(full_attributes.merge(params))
+    end
+
+    def columns_for(x_range, start_y, row_count = 2)
+      x_range.map do |x|
+        next if x > image.column_count || start_y + row_count > image.row_count
+        image.get_pixels(x, start_y, 1, row_count)
+      end.compact
+    end
+
+    def intersections
+      above_columns = columns_for(start_x..end_x, start_y - 4, 4)
+      vertical_dividers = []
+      above_columns.each_with_index do |column, index|
+        vertical_dividers << index if column.any?(&:blackish?)
+      end
+      vertical_dividers.map { |x| x + start_x }
+    end
+
+    def merge!(other)
+      if start_y > other.start_y
+        self.start_y = other.start_y
+      elsif end_y < other.end_y
+        self.end_y = other.end_y
+      end
+
+      self.start_x = other.start_x if start_x > other.start_x
+      self.end_x = other.end_x if end_x < other.end_x
+
+      self.rows += other.rows
+    end
+
+    def short?
+      length < Percept.config.line_length
+    end
+
+    def store_pixels!
+      image.store_pixels(start_x, start_y, length, height, pixels)
     end
 
   end