RubyGems - pagerecognizer - Versions diffs - 0.0.1 - Mend

pagerecognizer 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61a30cc5e39e171b8eabdf26490475ce3fb041b9
+  data.tar.gz: e64d2e3700730de8e9d3fe4d4de57f4743ca98b9
+SHA512:
+  metadata.gz: cd4370f97135ac3df6376c2df1dcbb39cd25a35fac0ad172d29fa86764d8fb82d7ec28da7d4aaf0a547f1684cdda34f2d4de1b14de5c66ed784bb798643e96cd
+  data.tar.gz: e517075c5eb9d4efdb5bc851865136776df7dda1eacaecb96e3d89f211c63c6a5429b0ee4286280d150f7ea338662ceebdc0f9b0039d7df8a6a2778b349629f6

data/LICENSE ADDED

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2020 Victor Maslov
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/lib/pagerecognizer.rb ADDED

@@ -0,0 +1,248 @@
+module PageRecognizer
+  class << self
+    attr_accessor :logger
+  end
+  require "logger"
+  self.logger = Logger.new STDOUT
+  module Dumpable
+    def dump
+      "<html><body>#{
+        map.with_index do |n, i|
+          "<div style='position: absolute; background-color: hsla(#{
+            360 * i / size
+          },100%,50%,0.5); top: #{n.top}; left: #{n.left}; width: #{n.width}; height: #{n.height}'>#{
+            n.node.tag_name.upcase
+          }</div>"
+        end.join
+      }</body></html>"
+    end
+  end
+  def self.load str
+    require "nokogiri"
+    Nokogiri::HTML(str).css("div").map do |n|
+      Struct.new(*%i{ node top left width height }).new Struct.new(:tag_name).new(n.text),
+        *n[:style].scan(/(\S+): ([^\;]+)/).to_h.values_at(
+                      *%w{ top left width height }
+        ).map(&:to_f)
+    end.extend Dumpable
+  end
+  def recognize
+    logger = Module.nesting.first.logger
+    nodes = []
+    try = lambda do
+      prev = nodes
+      code = "( function(node) {
+        var x = scrollX, y = scrollY;
+        var _tap = function(x, f){ f(); return x };
+        var f = function(node) {
+          node.scrollIntoView();
+          var rect = JSON.parse(JSON.stringify(node.getBoundingClientRect()));
+          var child_nodes = Array.from(node.childNodes).filter(function(node) { return node.nodeType == 1 });
+          var clickable;
+          if (node.nodeName == 'svg') {
+            var states = child_nodes.map( function(n){
+              return _tap(n.style ? n.style.display : '', function(){ n.style.display = 'none' } );
+            } );
+            clickable = (node === document.elementFromPoint(rect.x + rect.width/2, rect.y + rect.height/2));
+            var _zip = function(a, b){ return a.map( function(e, i) { return [e, b[i]] } ) };
+            _zip(child_nodes, states).forEach( function(_){ _[0].style.display = _[1] } );
+          } else {
+            clickable = (node === document.elementFromPoint(rect.x + rect.width/2, rect.y + rect.height/2));
+          };
+          rect.top += scrollY;
+          rect.left += scrollX;
+          return [ [
+            rect.top, rect.left, rect.width, rect.height, clickable, node
+          ] ].concat(node.nodeName == 'svg' ? [] : child_nodes.flatMap(f));
+        };
+        return _tap(f(node), function(){ scrollTo(x, y) });
+      } )(arguments[0])"
+      str = Struct.new :top, :left, :width, :height, :clickable, :node
+      nodes = page.evaluate(code, self).map{ |s| str.new *s }
+      nodes.size == prev.size
+    end
+    if defined? Selenium::WebDriver::Wait
+      Selenium::WebDriver::Wait.new(
+        message: "number of DOM elements didn't stop to change"
+      ).until &try
+    else
+      t = Time.now
+      until try.call
+        fail "number of DOM elements didn't stop to change" if Time.now > t + 5
+      end
+    end
+    logger.info "#{nodes.size} DOM nodes found"
+    nodes.select! &:clickable
+    nodes.reject do |n|
+      nodes.any? do |nn|
+        cs = [
+          nn.top <=> n.top,
+          nn.left <=> n.left,
+          n.left + n.width <=> nn.left + nn.width,
+          n.top + n.height <=> nn.top + nn.height,
+        ]
+        cs.include?(1) && !cs.include?(-1)
+      end
+    end.extend Dumpable
+  end
+  private def recognize_more
+    logger = Module.nesting.first.logger
+    nodes = []
+    try = lambda do
+      prev = nodes
+      code = "( function(node) {
+        var x = scrollX, y = scrollY;
+        var _tap = function(x, f){ f(); return x };
+        var f = function(node) {
+          node.scrollIntoView();
+          var rect = JSON.parse(JSON.stringify(node.getBoundingClientRect()));
+          rect.top += scrollY;
+          rect.left += scrollX;
+          return [ [
+            node, JSON.stringify([rect.top, rect.left, rect.width, rect.height])
+          ] ].concat(Array.from(node.childNodes).filter(function(node) { return node.nodeType == 1 }).flatMap(f));
+        };
+        return _tap(f(node), function(){ scrollTo(x, y) });
+      } )(arguments[0])"
+      str = Struct.new :node, :top, :left, :width, :height
+      nodes = page.evaluate(code, self).map{ |node, a| str.new node, *JSON.load(a) }
+      nodes.size == prev.size
+    end
+    if defined? Selenium::WebDriver::Wait
+      Selenium::WebDriver::Wait.new(
+        message: "number of DOM elements didn't stop to change"
+      ).until &try
+    else
+      t = Time.now
+      until try.call
+        fail "number of DOM elements didn't stop to change" if Time.now > t + 10
+      end
+    end
+    logger.info "#{nodes.size} DOM nodes found"
+    nodes.reject!{ |i| i.height.zero? || i.width.zero? }
+    nodes
+  end
+  logging_error = Class.new RuntimeError do
+    attr_reader :dumps
+    def initialize msg, arrays
+      Module.nesting.first.logger.error "#{self.class}: #{msg}"
+      @dumps = arrays.map{ |name, array| [name, array.extend(Dumpable).dump] }.to_h
+      super msg
+    end
+  end
+  class ErrorNotEnoughNodes < logging_error ; end
+  private def split heuristics, hh, ww, tt, ll
+    logger = Module.nesting.first.logger
+    unstale = unless defined? Selenium::WebDriver::Error::StaleElementReferenceError
+      ->(&b){ b.call }
+    else
+      lambda do |&try|
+        t = Time.now
+        begin
+          try.call
+        rescue Selenium::WebDriver::Error::StaleElementReferenceError
+          raise if Time.now > t + 10
+          retry
+        end
+      end
+    end
+    all = unstale.call do recognize_more end.sort_by(&tt)
+    logger.info "all nodes: #{all.size}"
+    rect = page.evaluate("( function(node) { return JSON.parse(JSON.stringify(node.getBoundingClientRect())) } )(arguments[0])", self)
+    inside = all.reject{ |i| i.left < rect["left"] || i.left + i.width > rect["right"] || i.top < rect["top"] || i.top + i.height > rect["bottom"] }
+    raise ErrorNotEnoughNodes.new "no inside nodes", all: all, inside: inside if inside.empty?
+    logger.info "inside nodes: #{inside.size}"
+    nodes = unstale.call do inside.reject{ |i| %w{ button script svg path a img span }.include? i.node.tag_name } end.uniq{ |i| [i[hh], i[ww], i[tt], i[ll]] }
+    logger.info "good nodes: #{nodes.size}"   # only those that might be containers
+    large = nodes#.select{ |i| i[ww] > nodes.map(&ww).max / 4 }
+    logger.info "large enough and unique: #{large.size}"
+    interfere = lambda do |a, b|
+      a[tt] < b[tt] + b[hh] &&
+      b[tt] < a[tt] + a[hh]
+    end
+    rest = large.select.with_index do |a, i|
+      large.each_with_index.none? do |b, j|
+        next if i == j
+        a[tt] >= b[tt] && a[tt] + a[hh] <= b[tt] + b[hh] &&
+        large.all?{ |c| interfere[a, c] == interfere[b, c] }
+      end
+    end
+    logger.info "not nested: #{rest.size}"
+    # rest = rest.sample 50
+    # adding the :area field for faster upcoming computations
+    struct = Struct.new *large.first.members, :area
+    rest.map!{ |i| struct.new *i.values, i.width * i.height }
+    require "pcbr"
+    pcbr = PCBR.new
+    is = []
+    max, past = 0, []
+    prev = nil
+    time = Time.now
+    loop do
+      rest.each_with_index do |node, i|
+        next if is.any?{ |j| i == j || interfere[rest[i], rest[j]] }
+        sol = rest.values_at *is, i
+        pcbr.store [*is, i].sort, [
+          *( is.size                                                                                                                if heuristics.include? :SIZE   ),
+          *( sol.map(&:area).inject(:+)                                                                                             if heuristics.include? :AREA   ),
+          *( -sol.product(sol).map{ |s1, s2| (s1.width              - s2.width             ).abs }.inject(:+) / sol.size / sol.size if heuristics.include? :WIDTH  ),
+          *( -sol.product(sol).map{ |s1, s2| (s1.height             - s2.height            ).abs }.inject(:+) / sol.size / sol.size if heuristics.include? :HEIGHT ),
+          *( -sol.product(sol).map{ |s1, s2| (s1[ll] + s1[ww] / 2.0 - s2[ll] - s2[ww] / 2.0).abs }.inject(:+) / sol.size / sol.size if heuristics.include? :MIDDLE ),
+        ] unless pcbr.table.assoc [*is, i].sort
+      end
+      if prev && Time.now - time > 1 && (Time.now - prev > (prev - time))
+        m = pcbr.table.reject{ |i| i.first.size == 1 }.map(&:last).max
+        break if 1 == pcbr.table.count{ |i| i.last == m } || Time.now - time > 5
+      end
+      break unless t = pcbr.table.reject{ |is,| past.include? is.map{ |i| 2**i }.inject(:+) }.max_by(&:last)
+      if t.last > max
+        prev, max = Time.now, t.last
+        logger.debug [Time.now - time, max, t.first]
+      end
+      past.push (is = t.first).map{ |i| 2**i }.inject(:+)
+    end
+    # TODO: if multiple with max score, take the max by area
+    unless best = pcbr.table.reject{ |is,| is.size == 1 }.max_by(&:last)
+      raise ErrorNotEnoughNodes.new "failed to split <#{tag_name}>", all: all, inside: inside, nodes: nodes, large: large, rest: rest
+    end
+    rest.values_at(*best.first).extend(Dumpable)
+  end
+  def rows *heuristics
+    heuristics = %i{ AREA HEIGHT WIDTH } if heuristics.empty?
+    split heuristics, :height, :width, :top, :left
+  end
+  def cols *heuristics
+    heuristics = %i{ AREA HEIGHT WIDTH } if heuristics.empty?
+    split heuristics, :width, :height, :left, :top
+  end
+end
+if defined? Ferrum::Frame::Runtime
+  Ferrum::Node.include PageRecognizer
+  Ferrum::Frame::Runtime.module_eval do
+    def cyclic? object_id
+      @page.command "Runtime.callFunctionOn", objectId: object_id, returnByValue: true, functionDeclaration: "function(){return false}"
+    end
+  end
+end

data/pagerecognizer.gemspec ADDED

@@ -0,0 +1,23 @@
+Gem::Specification.new do |spec|
+  spec.name         = "pagerecognizer"
+  spec.version      = "0.0.1"
+  spec.summary      = "visual HTML page structure recognizer"
+  spec.author       = "Victor Maslov aka Nakilon"
+  spec.email        = "nakilon@gmail.com"
+  spec.license      = "MIT"
+  spec.metadata     = {"source_code_uri" => "https://github.com/nakilon/pagerecognizer"}
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "pcbr"
+  spec.add_dependency "ferrum"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "ruby-prof"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "mll"
+  spec.require_path = "lib"
+  spec.test_file    = "test.rb"
+  spec.files        = %w{ LICENSE pagerecognizer.gemspec lib/pagerecognizer.rb }
+end

data/test.rb ADDED

@@ -0,0 +1,28 @@
+require "minitest/autorun"
+require "ferrum"
+require_relative "lib/pagerecognizer"
+Ferrum::Node.include PageRecognizer
+describe PageRecognizer do
+  it "google" do
+    browser = Ferrum::Browser.new **(ENV.has_key?("FERRUM_NO_SANDBOX") ? {browser_options: {"no-sandbox": nil}} : {})
+    browser.goto "about:blank"
+    browser.execute "document.write(#{File.read("google.htm").inspect})"
+    results = browser.at_css("body").rows
+    width = results.group_by(&:width).max_by{ |w, g| g.size }.first
+    assert_equal [
+      ["https://www.ruby-lang.org/ru/", "Ruby это... динамический язык программирования с о"],
+      ["https://ru.wikibooks.org/wiki/Ruby", "Этот учебник намерен осветить все тонкости програм"],
+      ["https://habr.com/ru/post/433672/", "19 дек. 2018 г. - Взрывной рост интереса к Ruby ос"],
+      ["https://habr.com/ru/hub/ruby/", "Ruby (англ. Ruby — «Рубин») — динамический, рефлек"],
+      ["https://web-creator.ru/articles/ruby", "Ruby разрабатывался на Linux, но работает на многи"],
+      ["http://rusrails.ru/", "Ruby on Rails руководства, учебники, статьи на рус"],
+      ["https://vc.ru/dev/72391-pochemu-my-vybiraem-ruby-d", "20 июн. 2019 г. - Ruby on Rails одним из первых на"],
+      ["https://tproger.ru/tag/ruby/", "Django или Ruby on Rails: какой фреймворк выбрать?"],
+      ["https://rubyrussia.club/", "Главная российская конференция о Ruby. Расширяем г"]
+    ], results.select{ |r| r.width == width }.map(&:node).map(&:rows).map{ |link, desc| [
+      link.node.at_css("a").property("href")[0,50],
+      desc.node.text[0,50],
+    ] }
+  end
+end

metadata ADDED

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: pagerecognizer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Victor Maslov aka Nakilon
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pcbr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ferrum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email: nakilon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/pagerecognizer.rb
+- pagerecognizer.gemspec
+- test.rb
+homepage:
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/nakilon/pagerecognizer
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.5.2.3
+signing_key:
+specification_version: 4
+summary: visual HTML page structure recognizer
+test_files:
+- test.rb