RubyGems - redsnow - Versions diffs - 0.3.1 → 0.3.2 - Mend

redsnow 0.3.1 → 0.3.2

Files changed (583) hide show

@@ -0,0 +1,136 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+<title>
+  File: README
+    &mdash; Documentation by YARD 0.8.7.4
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!file.README.html";
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">File: README</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><div id='filecontents'>
+<h1 id="label-RedSnow">RedSnow</h1>
+<p>Ruby binding for the Snow Crash library, also a thermonuclear weapon.</p>
+<h2 id="label-Install">Install</h2>
+<p>The best way to install RedSnow is by using its <a
+href="https://rubygems.org/gems/redsnow">GEM package</a>.</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_redsnow'>redsnow</span></code></pre>
+<h2 id="label-Documentation">Documentation</h2>
+<ul><li>
+<p><a href="http://rubydoc.info/gems/redsnow/">Documentation at rubydoc</a></p>
+</li></ul>
+<h2 id="label-Getting+started">Getting started</h2>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>redsnow</span><span class='tstring_end'>&#39;</span></span>
+<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'># My API</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
+</code></pre>
+<h2 id="label-Hacking+Redsnow">Hacking Redsnow</h2>
+<p>You are welcome to contribute. Use following steps to build &amp; test
+Redsnow.</p>
+<h3 id="label-Build">Build</h3>
+<ol><li>
+<p>If needed, install bundler:</p>
+<pre class="code ruby"><code class="ruby">$ gem install bundler</code></pre>
+</li><li>
+<p>Clone the repo + fetch the submodules:</p>
+<pre class="code ruby"><code class="ruby">$ git clone git://github.com/apiaryio/redsnow.git
+$ cd redsnow
+$ git submodule update --init --recursive</code></pre>
+</li><li>
+<p>Build:</p>
+<pre class="code ruby"><code class="ruby">$ rake</code></pre>
+</li></ol>
+<h3 id="label-Test">Test</h3>
+<p>Inside the redsnow repository run:</p>
+<pre class="code ruby"><code class="ruby">$ bundle install
+$ rake test</code></pre>
+<h3 id="label-Contribute">Contribute</h3>
+<p>Fork &amp; Pull Request.</p>
+<h2 id="label-License">License</h2>
+<p>MIT License. See the <a
+href="https://github.com/apiaryio/protagonist/blob/master/LICENSE">LICENSE</a>
+file.</p>
+</div></div>
+    <div id="footer">
+  Generated on Wed Jul 23 10:49:32 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.4 (ruby-2.1.1).
+</div>
+  </body>
+</html>

data/doc/file_list.html ADDED

@@ -0,0 +1,56 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+      <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
+      <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+      <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+      <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
+    <title>File List</title>
+    <base id="base_target" target="_parent" />
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) {
+        document.getElementById('base_target').target = 'main';
+        document.body.className = 'frames';
+      }
+    </script>
+    <div id="content">
+      <h1 id="full_list_header">File List</h1>
+      <div id="nav">
+          <span><a target="_self" href="class_list.html">
+            Classes
+          </a></span>
+          <span><a target="_self" href="method_list.html">
+            Methods
+          </a></span>
+          <span><a target="_self" href="file_list.html">
+            Files
+          </a></span>
+      </div>
+      <div id="search">Search: <input type="text" /></div>
+      <ul id="full_list" class="file">
+  <li class="r1"><span class="object_link"><a href="index.html" title="README">README</a></a></li>
+      </ul>
+    </div>
+  </body>
+</html>

data/doc/frames.html ADDED

@@ -0,0 +1,26 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
+	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+	<title>Documentation by YARD 0.8.7.4</title>
+</head>
+<script type="text/javascript" charset="utf-8">
+window.onload = function() {
+  var match = unescape(window.location.hash).match(/^#!(.+)/);
+  var name = match ? match[1] : 'index.html';
+  name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
+  document.writeln('<frameset cols="20%,*">' +
+    '<frame name="list" src="class_list.html" />' +
+    '<frame name="main" src="' + escape(name) + '" />' +
+    '</frameset>');
+}
+</script>
+<noscript>
+  <frameset cols="20%,*">
+    <frame name="list" src="class_list.html" />
+    <frame name="main" src="index.html" />
+  </frameset>
+</noscript>
+</html>

data/doc/index.html ADDED

@@ -0,0 +1,136 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+<title>
+  File: README
+    &mdash; Documentation by YARD 0.8.7.4
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!file.README.html";
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">File: README</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><div id='filecontents'>
+<h1 id="label-RedSnow">RedSnow</h1>
+<p>Ruby binding for the Snow Crash library, also a thermonuclear weapon.</p>
+<h2 id="label-Install">Install</h2>
+<p>The best way to install RedSnow is by using its <a
+href="https://rubygems.org/gems/redsnow">GEM package</a>.</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_redsnow'>redsnow</span></code></pre>
+<h2 id="label-Documentation">Documentation</h2>
+<ul><li>
+<p><a href="http://rubydoc.info/gems/redsnow/">Documentation at rubydoc</a></p>
+</li></ul>
+<h2 id="label-Getting+started">Getting started</h2>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>redsnow</span><span class='tstring_end'>&#39;</span></span>
+<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'># My API</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
+</code></pre>
+<h2 id="label-Hacking+Redsnow">Hacking Redsnow</h2>
+<p>You are welcome to contribute. Use following steps to build &amp; test
+Redsnow.</p>
+<h3 id="label-Build">Build</h3>
+<ol><li>
+<p>If needed, install bundler:</p>
+<pre class="code ruby"><code class="ruby">$ gem install bundler</code></pre>
+</li><li>
+<p>Clone the repo + fetch the submodules:</p>
+<pre class="code ruby"><code class="ruby">$ git clone git://github.com/apiaryio/redsnow.git
+$ cd redsnow
+$ git submodule update --init --recursive</code></pre>
+</li><li>
+<p>Build:</p>
+<pre class="code ruby"><code class="ruby">$ rake</code></pre>
+</li></ol>
+<h3 id="label-Test">Test</h3>
+<p>Inside the redsnow repository run:</p>
+<pre class="code ruby"><code class="ruby">$ bundle install
+$ rake test</code></pre>
+<h3 id="label-Contribute">Contribute</h3>
+<p>Fork &amp; Pull Request.</p>
+<h2 id="label-License">License</h2>
+<p>MIT License. See the <a
+href="https://github.com/apiaryio/protagonist/blob/master/LICENSE">LICENSE</a>
+file.</p>
+</div></div>
+    <div id="footer">
+  Generated on Wed Jul 23 10:49:32 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.4 (ruby-2.1.1).
+</div>
+  </body>
+</html>

data/doc/js/app.js ADDED

@@ -0,0 +1,219 @@
+function createSourceLinks() {
+    $('.method_details_list .source_code').
+        before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
+    $('.toggleSource').toggle(function() {
+       $(this).parent().nextAll('.source_code').slideDown(100);
+       $(this).text("Hide source");
+    },
+    function() {
+        $(this).parent().nextAll('.source_code').slideUp(100);
+        $(this).text("View source");
+    });
+}
+function createDefineLinks() {
+    var tHeight = 0;
+    $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
+    $('.toggleDefines').toggle(function() {
+        tHeight = $(this).parent().prev().height();
+        $(this).prev().show();
+        $(this).parent().prev().height($(this).parent().height());
+        $(this).text("(less)");
+    },
+    function() {
+        $(this).prev().hide();
+        $(this).parent().prev().height(tHeight);
+        $(this).text("more...");
+    });
+}
+function createFullTreeLinks() {
+    var tHeight = 0;
+    $('.inheritanceTree').toggle(function() {
+        tHeight = $(this).parent().prev().height();
+        $(this).parent().toggleClass('showAll');
+        $(this).text("(hide)");
+        $(this).parent().prev().height($(this).parent().height());
+    },
+    function() {
+        $(this).parent().toggleClass('showAll');
+        $(this).parent().prev().height(tHeight);
+        $(this).text("show all");
+    });
+}
+function fixBoxInfoHeights() {
+    $('dl.box dd.r1, dl.box dd.r2').each(function() {
+       $(this).prev().height($(this).height());
+    });
+}
+function searchFrameLinks() {
+  $('.full_list_link').click(function() {
+    toggleSearchFrame(this, $(this).attr('href'));
+    return false;
+  });
+}
+function toggleSearchFrame(id, link) {
+  var frame = $('#search_frame');
+  $('#search a').removeClass('active').addClass('inactive');
+  if (frame.attr('src') == link && frame.css('display') != "none") {
+    frame.slideUp(100);
+    $('#search a').removeClass('active inactive');
+  }
+  else {
+    $(id).addClass('active').removeClass('inactive');
+    frame.attr('src', link).slideDown(100);
+  }
+}
+function linkSummaries() {
+  $('.summary_signature').click(function() {
+    document.location = $(this).find('a').attr('href');
+  });
+}
+function framesInit() {
+  if (hasFrames) {
+    document.body.className = 'frames';
+    $('#menu .noframes a').attr('href', document.location);
+    try {
+      window.top.document.title = $('html head title').text();
+    } catch(error) {
+      // some browsers will not allow this when serving from file://
+      // but we don't want to stop the world.
+    }
+  }
+  else {
+    $('#menu .noframes a').text('frames').attr('href', framesUrl);
+  }
+}
+function keyboardShortcuts() {
+  if (window.top.frames.main) return;
+  $(document).keypress(function(evt) {
+    if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
+    if (typeof evt.target !== "undefined" &&
+        (evt.target.nodeName == "INPUT" ||
+        evt.target.nodeName == "TEXTAREA")) return;
+    switch (evt.charCode) {
+      case 67: case 99:  $('#class_list_link').click(); break;  // 'c'
+      case 77: case 109: $('#method_list_link').click(); break; // 'm'
+      case 70: case 102: $('#file_list_link').click(); break;   // 'f'
+      default: break;
+    }
+  });
+}
+function summaryToggle() {
+  $('.summary_toggle').click(function() {
+    if (localStorage) {
+      localStorage.summaryCollapsed = $(this).text();
+    }
+    $('.summary_toggle').each(function() {
+      $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
+      var next = $(this).parent().parent().nextAll('ul.summary').first();
+      if (next.hasClass('compact')) {
+        next.toggle();
+        next.nextAll('ul.summary').first().toggle();
+      }
+      else if (next.hasClass('summary')) {
+        var list = $('<ul class="summary compact" />');
+        list.html(next.html());
+        list.find('.summary_desc, .note').remove();
+        list.find('a').each(function() {
+          $(this).html($(this).find('strong').html());
+          $(this).parent().html($(this)[0].outerHTML);
+        });
+        next.before(list);
+        next.toggle();
+      }
+    });
+    return false;
+  });
+  if (localStorage) {
+    if (localStorage.summaryCollapsed == "collapse") {
+      $('.summary_toggle').first().click();
+    }
+    else localStorage.summaryCollapsed = "expand";
+  }
+}
+function fixOutsideWorldLinks() {
+  $('a').each(function() {
+    if (window.location.host != this.host) this.target = '_parent';
+  });
+}
+function generateTOC() {
+  if ($('#filecontents').length === 0) return;
+  var _toc = $('<ol class="top"></ol>');
+  var show = false;
+  var toc = _toc;
+  var counter = 0;
+  var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
+  var i;
+  if ($('#filecontents h1').length > 1) tags.unshift('h1');
+  for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
+  var lastTag = parseInt(tags[0][1], 10);
+  $(tags.join(', ')).each(function() {
+    if ($(this).parents('.method_details .docstring').length != 0) return;
+    if (this.id == "filecontents") return;
+    show = true;
+    var thisTag = parseInt(this.tagName[1], 10);
+    if (this.id.length === 0) {
+      var proposedId = $(this).attr('toc-id');
+      if (typeof(proposedId) != "undefined") this.id = proposedId;
+      else {
+        var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
+        if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
+        this.id = proposedId;
+      }
+    }
+    if (thisTag > lastTag) {
+      for (i = 0; i < thisTag - lastTag; i++) {
+        var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
+      }
+    }
+    if (thisTag < lastTag) {
+      for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
+    }
+    var title = $(this).attr('toc-title');
+    if (typeof(title) == "undefined") title = $(this).text();
+    toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
+    lastTag = thisTag;
+  });
+  if (!show) return;
+  html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
+  $('#content').prepend(html);
+  $('#toc').append(_toc);
+  $('#toc .hide_toc').toggle(function() {
+    $('#toc .top').slideUp('fast');
+    $('#toc').toggleClass('hidden');
+    $('#toc .title small').toggle();
+  }, function() {
+    $('#toc .top').slideDown('fast');
+    $('#toc').toggleClass('hidden');
+    $('#toc .title small').toggle();
+  });
+  $('#toc .float_toc').toggle(function() {
+    $(this).text('float');
+    $('#toc').toggleClass('nofloat');
+  }, function() {
+    $(this).text('left');
+    $('#toc').toggleClass('nofloat');
+  });
+}
+$(framesInit);
+$(createSourceLinks);
+$(createDefineLinks);
+$(createFullTreeLinks);
+$(fixBoxInfoHeights);
+$(searchFrameLinks);
+$(linkSummaries);
+$(keyboardShortcuts);
+$(summaryToggle);
+$(fixOutsideWorldLinks);
+$(generateTOC);