rangops 1.0.0.beta1

data/docs/js/searcher.js

@@ -0,0 +1,229 @@
+Searcher = function(data) {
+  this.data = data;
+  this.handlers = [];
+}
+
+Searcher.prototype = new function() {
+  // search is performed in chunks of 1000 for non-blocking user input
+  var CHUNK_SIZE = 1000;
+  // do not try to find more than 100 results
+  var MAX_RESULTS = 100;
+  var huid = 1;
+  var suid = 1;
+  var runs = 0;
+
+  this.find = function(query) {
+    var queries = splitQuery(query);
+    var regexps = buildRegexps(queries);
+    var highlighters = buildHilighters(queries);
+    var state = { from: 0, pass: 0, limit: MAX_RESULTS, n: suid++};
+    var _this = this;
+
+    this.currentSuid = state.n;
+
+    if (!query) return;
+
+    var run = function() {
+      // stop current search thread if new search started
+      if (state.n != _this.currentSuid) return;
+
+      var results =
+        performSearch(_this.data, regexps, queries, highlighters, state);
+      var hasMore = (state.limit > 0 && state.pass < 4);
+
+      triggerResults.call(_this, results, !hasMore);
+      if (hasMore) {
+        setTimeout(run, 2);
+      }
+      runs++;
+    };
+    runs = 0;
+
+    // start search thread
+    run();
+  }
+
+  /*  ----- Events ------  */
+  this.ready = function(fn) {
+    fn.huid = huid;
+    this.handlers.push(fn);
+  }
+
+  /*  ----- Utilities ------  */
+  function splitQuery(query) {
+    return query.split(/(\s+|::?|\(\)?)/).filter(function(string) {
+      return string.match(/\S/);
+    });
+  }
+
+  function buildRegexps(queries) {
+    return queries.map(function(query) {
+      return new RegExp(query.replace(/(.)/g, '([$1])([^$1]*?)'), 'i');
+    });
+  }
+
+  function buildHilighters(queries) {
+    return queries.map(function(query) {
+      return query.split('').map(function(l, i) {
+        return '\u0001$' + (i*2+1) + '\u0002$' + (i*2+2);
+      }).join('');
+    });
+  }
+
+  // function longMatchRegexp(index, longIndex, regexps) {
+  //     for (var i = regexps.length - 1; i >= 0; i--){
+  //         if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) return false;
+  //     };
+  //     return true;
+  // }
+
+
+  /*  ----- Mathchers ------  */
+
+  /*
+   * This record matches if the index starts with queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassBeginning(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if the longIndex starts with queries[0] and the
+   * longIndex matches all of the regexps
+   */
+  function matchPassLongIndex(index, longIndex, queries, regexps) {
+    if (longIndex.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if the index contains queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassContains(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) == -1) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if regexps[0] matches the index and the record
+   * matches all of the regexps
+   */
+  function matchPassRegexp(index, longIndex, queries, regexps) {
+    if (!index.match(regexps[0])) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+
+  /*  ----- Highlighters ------  */
+  function highlightRegexp(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    for (var i=0, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+
+  function hltSubstring(string, pos, length) {
+    return string.substring(0, pos) + '\u0001' + string.substring(pos, pos + length) + '\u0002' + string.substring(pos + length);
+  }
+
+  function highlightQuery(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    var pos = 0;
+    var lcTitle = result.title.toLowerCase();
+
+    pos = lcTitle.indexOf(queries[0]);
+    if (pos != -1) {
+      result.title = hltSubstring(result.title, pos, queries[0].length);
+    }
+
+    result.namespace = result.namespace.replace(regexps[0], highlighters[0]);
+    for (var i=1, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+
+  function createResult(info) {
+    var result = {};
+    result.title = info[0];
+    result.namespace = info[1];
+    result.path = info[2];
+    result.params = info[3];
+    result.snippet = info[4];
+    result.badge = info[6];
+    return result;
+  }
+
+  /*  ----- Searching ------  */
+  function performSearch(data, regexps, queries, highlighters, state) {
+    var searchIndex = data.searchIndex;
+    var longSearchIndex = data.longSearchIndex;
+    var info = data.info;
+    var result = [];
+    var i = state.from;
+    var l = searchIndex.length;
+    var togo = CHUNK_SIZE;
+    var matchFunc, hltFunc;
+
+    while (state.pass < 4 && state.limit > 0 && togo > 0) {
+      if (state.pass == 0) {
+        matchFunc = matchPassBeginning;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 1) {
+        matchFunc = matchPassLongIndex;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 2) {
+        matchFunc = matchPassContains;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 3) {
+        matchFunc = matchPassRegexp;
+        hltFunc = highlightRegexp;
+      }
+
+      for (; togo > 0 && i < l && state.limit > 0; i++, togo--) {
+        if (info[i].n == state.n) continue;
+        if (matchFunc(searchIndex[i], longSearchIndex[i], queries, regexps)) {
+          info[i].n = state.n;
+          result.push(hltFunc(info[i], queries, regexps, highlighters));
+          state.limit--;
+        }
+      };
+      if (searchIndex.length <= i) {
+        state.pass++;
+        i = state.from = 0;
+      } else {
+        state.from = i;
+      }
+    }
+    return result;
+  }
+
+  function triggerResults(results, isLast) {
+    this.handlers.forEach(function(fn) {
+      fn.call(this, results, isLast)
+    });
+  }
+}
+

data/docs/table_of_contents.html

@@ -0,0 +1,190 @@
+<!DOCTYPE html>
+
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1" />
+
+<title>Table of Contents - Rangops</title>
+
+  <meta name="keywords" content="ruby,documentation,Table of Contents - Rangops">
+
+
+    <meta name="description" content="Table of Contents - Rangops: Rangops Rangops is a simple Ruby extension library that aims to treat Ranges as sets. It provides methods for elementary set related operations and p">
+
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+  var index_rel_prefix = "./";
+</script>
+
+<script src="./js/navigation.js" defer></script>
+<script src="./js/search.js" defer></script>
+<script src="./js/search_index.js" defer></script>
+<script src="./js/searcher.js" defer></script>
+<script src="./js/darkfish.js" defer></script>
+
+<link href="./css/fonts.css" rel="stylesheet">
+<link href="./css/rdoc.css" rel="stylesheet">
+
+
+<body id="top" class="table-of-contents">
+<div id="navigation-toggle" role="button" tabindex="0" aria-label="Toggle sidebar" aria-expanded="true" aria-controls="navigation">
+  <span aria-hidden="true">&#9776;</span>
+</div>
+
+
+<nav id="navigation" role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="./index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="./table_of_contents.html#pages">Pages</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  <footer id="validator-badges" role="contentinfo">
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.14.2.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+
+</nav>
+<main role="main">
+<h1 class="class">Table of Contents - Rangops</h1>
+
+<h2 id="pages">Pages</h2>
+<ul>
+  <li class="file">
+    <a href="README_md.html">README</a>
+
+    <ul>
+      <li><a href="README_md.html#label-Rangops">Rangops</a>
+      <li><a href="README_md.html#label-License">License</a>
+    </ul>
+  </li>
+</ul>
+
+<h2 id="classes">Classes and Modules</h2>
+<ul>
+  <li class="module">
+    <a href="Rangops.html">Rangops</a>
+  </li>
+  <li class="module">
+    <a href="Rangops/Set.html">Rangops::Set</a>
+  </li>
+</ul>
+
+<h2 id="methods">Methods</h2>
+<ul>
+
+  <li class="method">
+    <a href="Rangops/Set.html#method-c-sort_by_boundaries">::sort_by_boundaries</a>
+    &mdash;
+    <span class="container">Rangops::Set</span>
+
+  <li class="method">
+    <a href="Rangops/Set.html#method-i-26">#&amp;</a>
+    &mdash;
+    <span class="container">Rangops::Set</span>
+
+  <li class="method">
+    <a href="Rangops/Set.html#method-i-2B">#+</a>
+    &mdash;
+    <span class="container">Rangops::Set</span>
+
+  <li class="method">
+    <a href="Rangops/Set.html#method-i-2D">#-</a>
+    &mdash;
+    <span class="container">Rangops::Set</span>
+
+  <li class="method">
+    <a href="Rangops/Set.html#method-i-7C">#|</a>
+    &mdash;
+    <span class="container">Rangops::Set</span>
+
+  <li class="method">
+    <a href="Rangops/Set.html#method-i-complement">#complement</a>
+    &mdash;
+    <span class="container">Rangops::Set</span>
+
+  <li class="method">
+    <a href="Rangops/Set.html#method-i-contains-3F">#contains?</a>
+    &mdash;
+    <span class="container">Rangops::Set</span>
+
+  <li class="method">
+    <a href="Rangops/Set.html#method-i-difference">#difference</a>
+    &mdash;
+    <span class="container">Rangops::Set</span>
+
+  <li class="method">
+    <a href="Rangops/Set.html#method-i-disjoint-3F">#disjoint?</a>
+    &mdash;
+    <span class="container">Rangops::Set</span>
+
+  <li class="method">
+    <a href="Rangops/Set.html#method-i-intersect-3F">#intersect?</a>
+    &mdash;
+    <span class="container">Rangops::Set</span>
+
+  <li class="method">
+    <a href="Rangops/Set.html#method-i-intersection">#intersection</a>
+    &mdash;
+    <span class="container">Rangops::Set</span>
+
+  <li class="method">
+    <a href="Rangops/Set.html#method-i-is_contained_by-3F">#is_contained_by?</a>
+    &mdash;
+    <span class="container">Rangops::Set</span>
+
+  <li class="method">
+    <a href="Rangops/Set.html#method-i-proper_subset-3F">#proper_subset?</a>
+    &mdash;
+    <span class="container">Rangops::Set</span>
+
+  <li class="method">
+    <a href="Rangops/Set.html#method-i-proper_superset-3F">#proper_superset?</a>
+    &mdash;
+    <span class="container">Rangops::Set</span>
+
+  <li class="method">
+    <a href="Rangops/Set.html#method-i-subset-3F">#subset?</a>
+    &mdash;
+    <span class="container">Rangops::Set</span>
+
+  <li class="method">
+    <a href="Rangops/Set.html#method-i-superset-3F">#superset?</a>
+    &mdash;
+    <span class="container">Rangops::Set</span>
+
+  <li class="method">
+    <a href="Rangops/Set.html#method-i-union">#union</a>
+    &mdash;
+    <span class="container">Rangops::Set</span>
+</ul>
+</main>
+

data/lib/rangops/set.rb

@@ -0,0 +1,183 @@
+module Rangops
+
+  # Module defining basic set operations that can be performed
+  # on ranges.
+  #
+  # * union
+  # * intersection
+  # * relative complement
+  # * symmetric difference
+  #
+  # along with some convenient aliases and predicates.
+  # Loosely follows conventions of `Set` module from standard library.
+  #
+  # Operations involving 2 ranges require them to overlap to produce result.
+  # If the result of operation cannot be expressed as single range,
+  # an array of ranges is returned.
+  module Set
+
+    # Union of 2 ranges. Returns a range covering sum of all elements
+    # belonging to both ranges. Returns `nil` if ranges don't overlap.
+    #
+    #     (1..10).union(5..15)
+    #     => 1..15
+    #     (5..10) | (9..24)
+    #     => 5..24
+    #     (1...10) + (10..30)
+    #     => nil
+    def union(other)
+      validate_args(self, other)
+      return nil unless intersect?(other)
+
+      lower, upper = Set.sort_by_boundaries(self, other)
+      Range.new(lower.begin, upper.end, upper.exclude_end?)
+    end
+    alias_method :|, :union
+    alias_method :+, :union
+
+    # Intersection of 2 ranges. Returns a range covering elements
+    # common to both ranges. Returns `nil` if ranges don't overlap.
+    #
+    #     (1..10).intersection(5..15)
+    #     => 5..10
+    #
+    #     (5..10) & (9..24)
+    #     => 9..10
+    def intersection(other)
+      validate_args(self, other)
+      return nil unless intersect?(other)
+
+      lower, upper = Set.sort_by_boundaries(self, other)
+      Range.new(upper.begin, lower.end, lower.exclude_end?)
+    end
+    alias_method :&, :intersection
+
+    # Relative complement of 2 ranges. Returns a range covering
+    # elements from `other` that are not covered by `self`.
+    # Returns `nil` if ranges don't overlap.
+    #
+    #     (1..10).complement(5..15)
+    #     => 10..15
+    def complement(other)
+      validate_args(self, other)
+      return nil unless intersect?(other)
+
+      _, upper = Set.sort_by_boundaries(self, other)
+      new_begin = [self.end, other.end].compact.min
+      Range.new(new_begin, upper.end, upper.exclude_end?)
+    end
+
+    # Symmetric difference of 2 ranges. Returns ranges covering
+    # elements of both operands, excluding elements common for both
+    # of them. Returns `nil` if ranges don't overlap.
+    #
+    #     (1..10).difference(5..15)
+    #     => [1..5, 10..15]
+    #
+    #     (11..19) - (15..28)
+    #     => [11..15, 19..28]
+    def difference(other)
+      validate_args(self, other)
+      return nil unless intersect?(other)
+
+      lower, upper = Set.sort_by_boundaries(self, other)
+      [Range.new(lower.begin, upper.begin),
+      Range.new(lower.end, upper.end, upper.exclude_end?)]
+    end
+    alias_method :-, :difference
+
+
+    # Checks if 2 ranges have any common elements.
+    #
+    #      (1..10).intersect?(8..15)
+    #      => true
+    #
+    #      (1..10).intersect?(11..15)
+    #      => false
+    def intersect?(other)
+      lower, upper = Set.sort_by_boundaries(self, other)
+      lower.cover?(upper.begin) || upper.cover?(lower.end)
+    end
+
+
+    # Opposite of `intersect?.
+    def disjoint?(other)
+      !intersect?(other)
+    end
+
+    # Checks if `self` is superset of `other`, i.e. all
+    # elements of `other` fit within `self`.
+    #
+    #     (1..10).superset?(2..5)
+    #     => true
+    #
+    #     (1..10).superset?(1..10)
+    #     => true
+    #
+    #     (1..10).superset?(5..12)
+    #     => false
+    def superset?(other)
+      cover?(other.begin) && cover?(other.end)
+    end
+    alias_method :contains?, :superset?
+
+    # Checks if `self` is proper superset of `other`,
+    # i.e. is superset and has elements not present
+    # in `other`.
+    #
+    #     (1..10).proper_superset?(2..5)
+    #     => true
+    #
+    #     (1..10).proper_superset?(1..10)
+    #     => false
+    def proper_superset?(other)
+      superset?(other) && self != other
+    end
+
+    # Checks if `self` is subset of `other`, i.e. all
+    # elements of `self` fit within `other`.
+    #
+    #     (1..10).subset?(0..12)
+    #     => true
+    #
+    #     (1..10).subset?(1..10)
+    #     => true
+    #
+    #     (1..10).subset?(5..12)
+    #     => false
+    def subset?(other)
+      other.superset?(self)
+    end
+    alias_method :is_contained_by?, :subset?
+
+    # Checks if `self` is proper subset of `other`,
+    # i.e. is subset and has elements not present
+    # in `other`.
+    #
+    #     (1..10).proper_subset?(0..12)
+    #     => true
+    #
+    #     (1..10).proper_subset?(1..10)
+    #     => false
+    def proper_subset?(other)
+      subset?(other) && self != other
+    end
+
+    private
+
+    def validate_args(*args)
+      args.reject{ |a| a.is_a?(Range) }.each do |arg|
+        raise ArgumentError, "expected a Range, got #{other.class} instead"
+      end
+    end
+
+    # Determine which range has lower begin, and which one higher end.
+    def self.sort_by_boundaries(a, b)
+      ary = [a, b]
+      lower = ary.find{ |r| r.begin.nil? } || ary.sort_by(&:begin).first
+      upper = ary.find{ |r| r.end.nil? }   || ary.sort_by(&:end).last
+      [lower, upper]
+    end
+
+  end
+end

data/lib/rangops/version.rb

@@ -0,0 +1,3 @@
+module Rangops
+  VERSION = "1.0.0.beta1"
+end

data/lib/rangops.rb

@@ -0,0 +1,9 @@
+require "rangops/version"
+require "rangops/set"
+
+module Rangops
+end
+
+class Range
+  include Rangops::Set
+end

data/rangops.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rangops/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rangops"
+  spec.version       = Rangops::VERSION
+  spec.authors       = ["Bartosz Pietraszko"]
+  spec.email         = ["bartosz.pietraszko@proton.me"]
+
+  spec.summary       = 'Simple Ruby extension library for set operations on ranges.'
+  spec.homepage      = "https://bartpiet.github.io/rangops/"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+
+end