cosmos-unpacking_interface 1.0.0

data/doc/js/search.js

@@ -0,0 +1,109 @@
+Search = function(data, input, result) {
+  this.data = data;
+  this.$input = $(input);
+  this.$result = $(result);
+
+  this.$current = null;
+  this.$view = this.$result.parent();
+  this.searcher = new Searcher(data.index);
+  this.init();
+}
+
+Search.prototype = $.extend({}, Navigation, new function() {
+  var suid = 1;
+
+  this.init = function() {
+    var _this = this;
+    var observer = function(e) {
+      switch(e.originalEvent.keyCode) {
+        case 38: // Event.KEY_UP
+        case 40: // Event.KEY_DOWN
+          return;
+      }
+      _this.search(_this.$input[0].value);
+    };
+    this.$input.keyup(observer);
+    this.$input.click(observer); // mac's clear field
+
+    this.searcher.ready(function(results, isLast) {
+      _this.addResults(results, isLast);
+    })
+
+    this.initNavigation();
+    this.setNavigationActive(false);
+  }
+
+  this.search = function(value, selectFirstMatch) {
+    value = jQuery.trim(value).toLowerCase();
+    if (value) {
+      this.setNavigationActive(true);
+    } else {
+      this.setNavigationActive(false);
+    }
+
+    if (value == '') {
+      this.lastQuery = value;
+      this.$result.empty();
+      this.$result.attr('aria-expanded', 'false');
+      this.setNavigationActive(false);
+    } else if (value != this.lastQuery) {
+      this.lastQuery = value;
+      this.$result.attr('aria-busy',     'true');
+      this.$result.attr('aria-expanded', 'true');
+      this.firstRun = true;
+      this.searcher.find(value);
+    }
+  }
+
+  this.addResults = function(results, isLast) {
+    var target = this.$result.get(0);
+    if (this.firstRun && (results.length > 0 || isLast)) {
+      this.$current = null;
+      this.$result.empty();
+    }
+
+    for (var i=0, l = results.length; i < l; i++) {
+      var item = this.renderItem.call(this, results[i]);
+      item.setAttribute('id', 'search-result-' + target.childElementCount);
+      target.appendChild(item);
+    };
+
+    if (this.firstRun && results.length > 0) {
+      this.firstRun = false;
+      this.$current = $(target.firstChild);
+      this.$current.addClass('search-selected');
+    }
+    if (jQuery.browser.msie) this.$element[0].className += '';
+
+    if (isLast) this.$result.attr('aria-busy', 'false');
+  }
+
+  this.move = function(isDown) {
+    if (!this.$current) return;
+    var $next = this.$current[isDown ? 'next' : 'prev']();
+    if ($next.length) {
+      this.$current.removeClass('search-selected');
+      $next.addClass('search-selected');
+      this.$input.attr('aria-activedescendant', $next.attr('id'));
+      this.scrollIntoView($next[0], this.$view[0]);
+      this.$current = $next;
+      this.$input.val($next[0].firstChild.firstChild.text);
+      this.$input.select();
+    }
+    return true;
+  }
+
+  this.hlt = function(html) {
+    return this.escapeHTML(html).
+      replace(/\u0001/g, '<em>').
+      replace(/\u0002/g, '</em>');
+  }
+
+  this.escapeHTML = function(html) {
+    return html.replace(/[&<>]/g, function(c) {
+      return '&#' + c.charCodeAt(0) + ';';
+    });
+  }
+
+});
+

data/doc/js/search_index.js

@@ -0,0 +1 @@
+var search_data = {"index":{"searchIndex":["cosmos","aggregatepacketmapper","aggregatepacketprocesser","basenamemap","unpackinginterface","unpackinginterface","_extract_map()","_field_arity()","_max_arity()","agg_pkt_map()","build_map()","connect()","extract_all()","new()","new()","packet_mapper()","process()","read()","size()","target()","transforms()","unpack()"],"longSearchIndex":["cosmos","cosmos::aggregatepacketmapper","cosmos::aggregatepacketprocesser","cosmos::basenamemap","cosmos::unpackinginterface","unpackinginterface","cosmos::aggregatepacketprocesser#_extract_map()","cosmos::basenamemap#_field_arity()","cosmos::basenamemap#_max_arity()","cosmos::unpackinginterface#agg_pkt_map()","cosmos::aggregatepacketmapper#build_map()","cosmos::unpackinginterface#connect()","cosmos::basenamemap#extract_all()","cosmos::aggregatepacketprocesser::new()","cosmos::basenamemap::new()","cosmos::unpackinginterface#packet_mapper()","cosmos::unpackinginterface#process()","cosmos::unpackinginterface#read()","cosmos::basenamemap#size()","cosmos::unpackinginterface#target()","cosmos::unpackinginterface#transforms()","cosmos::aggregatepacketprocesser#unpack()"],"info":[["Cosmos","","Cosmos.html","","<p>Encapsulates the conversion of an aggregate packet into a BaseNameMap, our internal representation of …\n"],["Cosmos::AggregatePacketMapper","","Cosmos/AggregatePacketMapper.html","",""],["Cosmos::AggregatePacketProcesser","","Cosmos/AggregatePacketProcesser.html","","<p>Encapsulates the transformation of an aggregate packet into many simple packets\n"],["Cosmos::BaseNameMap","","Cosmos/BaseNameMap.html","",""],["Cosmos::UnpackingInterface","","Cosmos/UnpackingInterface.html","","<p>A custom interface that unpacks aggregate packets (packets with many granules) into many  simple packets …\n"],["UnpackingInterface","","UnpackingInterface.html","","<p>A custom extendable interface that unpacks aggregate packets (packets with many granules) into many  …\n"],["_extract_map","Cosmos::AggregatePacketProcesser","Cosmos/AggregatePacketProcesser.html#method-i-_extract_map","(map, target, item)","<p>Extract our internal BaseNameMap into an array of packets of type target/item, applying transformations …\n"],["_field_arity","Cosmos::BaseNameMap","Cosmos/BaseNameMap.html#method-i-_field_arity","(k)",""],["_max_arity","Cosmos::BaseNameMap","Cosmos/BaseNameMap.html#method-i-_max_arity","()",""],["agg_pkt_map","Cosmos::UnpackingInterface","Cosmos/UnpackingInterface.html#method-i-agg_pkt_map","()","<p>Maps aggregate packets (packets with many granules) to simple packets (packets with a single granule) …\n"],["build_map","Cosmos::AggregatePacketMapper","Cosmos/AggregatePacketMapper.html#method-i-build_map","(packet)","<p>Builds a BaseNameMap from a cosmos aggregate packet\n"],["connect","Cosmos::UnpackingInterface","Cosmos/UnpackingInterface.html#method-i-connect","()",""],["extract_all","Cosmos::BaseNameMap","Cosmos/BaseNameMap.html#method-i-extract_all","()","<p>Expands map of keys to arrays of values into a single array containing hashes where each key maps to …\n"],["new","Cosmos::AggregatePacketProcesser","Cosmos/AggregatePacketProcesser.html#method-c-new","(mapper, transforms = {})",""],["new","Cosmos::BaseNameMap","Cosmos/BaseNameMap.html#method-c-new","(map, name)","<p>map is a hash where keys are normalized item names (i.e. VALUE_A instead of VALUE_A_0) and  values are …\n"],["packet_mapper","Cosmos::UnpackingInterface","Cosmos/UnpackingInterface.html#method-i-packet_mapper","()","<p>Create and return a new instance of your own custom PacketMapper\n"],["process","Cosmos::UnpackingInterface","Cosmos/UnpackingInterface.html#method-i-process","(packet:, target:, agg_packet:, simple_packet:)","<p>Unpack an aggregate packet if necessary and add resulting packets to the internal FIFO queue\n"],["read","Cosmos::UnpackingInterface","Cosmos/UnpackingInterface.html#method-i-read","()","<p>This method is called by COSMOS internally, essentially if we have packets on the queue read those otherwise …\n"],["size","Cosmos::BaseNameMap","Cosmos/BaseNameMap.html#method-i-size","()","<p>Number of simple packets contained within the aggregate packet\n"],["target","Cosmos::UnpackingInterface","Cosmos/UnpackingInterface.html#method-i-target","()","<p>Cosmos target interface is being used with\n"],["transforms","Cosmos::UnpackingInterface","Cosmos/UnpackingInterface.html#method-i-transforms","()","<p>Transformations defined on an item in a simple packet. Entries should be of the form: “&lt;TARGET&gt;-&lt;PACKET_NAME&gt;-&lt;ITEM_NAME&gt;” …\n"],["unpack","Cosmos::AggregatePacketProcesser","Cosmos/AggregatePacketProcesser.html#method-i-unpack","(packet, target, item)","<p>Converts the aggregate packet into an array of simple packets.\n"]]}}

data/doc/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 jQuery.grep(query.split(/(\s+|::?|\(\)?)/), function(string) {
+      return string.match(/\S/);
+    });
+  }
+
+  function buildRegexps(queries) {
+    return jQuery.map(queries, function(query) {
+      return new RegExp(query.replace(/(.)/g, '([$1])([^$1]*?)'), 'i');
+    });
+  }
+
+  function buildHilighters(queries) {
+    return jQuery.map(queries, function(query) {
+      return jQuery.map(query.split(''), 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) {
+    jQuery.each(this.handlers, function(i, fn) {
+      fn.call(this, results, isLast)
+    })
+  }
+}
+

data/doc/lib/README_rdoc.html

@@ -0,0 +1,118 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>README - RDoc Documentation</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../";
+  var index_rel_prefix = "../";
+</script>
+
+<script src="../js/jquery.js"></script>
+<script src="../js/darkfish.js"></script>
+
+<link href="../css/fonts.css" rel="stylesheet">
+<link href="../css/rdoc.css" rel="stylesheet">
+
+
+
+<body id="top" role="document" class="file">
+<nav 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" 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>
+
+  
+
+  <div id="project-metadata">
+    <div id="fileindex-section" class="nav-section">
+  <h3>Pages</h3>
+
+  <ul class="link-list">
+  
+    <li><a href="../lib/README_rdoc.html">README</a>
+  
+  </ul>
+</div>
+
+  </div>
+</nav>
+
+<main role="main" aria-label="Page lib/README.rdoc">
+
+<p># <a href="../UnpackingInterface.html"><code>UnpackingInterface</code></a></p>
+
+<p>Welcome to your new gem! In this directory, you&#39;ll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/UnpackingInterface`. To experiment with that code, run `bin/console` for an interactive prompt.</p>
+
+<p>TODO: Delete this and the text above, and describe your gem</p>
+
+<p>## Installation</p>
+
+<p>Add this line to your application&#39;s Gemfile:</p>
+
+<p>“`ruby gem &#39;UnpackingInterface&#39; “`</p>
+
+<p>And then execute:</p>
+
+<pre>$ bundle</pre>
+
+<p>Or install it yourself as:</p>
+
+<pre>$ gem install UnpackingInterface</pre>
+
+<p>## Usage</p>
+
+<p>TODO: Write usage instructions here</p>
+
+<p>## Development</p>
+
+<p>After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.</p>
+
+<p>To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](<a href="https://rubygems.org">rubygems.org</a>).</p>
+
+<p>## Contributing</p>
+
+<p>Bug reports and pull requests are welcome on GitHub at <a href="https://github.com/[USERNAME]/UnpackingInterface">github.com/[USERNAME]/UnpackingInterface</a>.</p>
+
+<p>## License</p>
+
+<p>The gem is available as open source under the terms of the [MIT License](<a href="https://opensource.org/licenses/MIT">opensource.org/licenses/MIT</a>).</p>
+</main>
+
+
+
+<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.1.1.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+