docs/index.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>RDoc Documentation</title>
<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" 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="./README_md.html">README</a>
</ul>
</div>
<div id="classindex-section" class="nav-section">
<h3>Class and Module Index</h3>
<ul class="link-list">
<li><a href="./UmtsCustomMatchers.html">UmtsCustomMatchers</a>
<li><a href="./UmtsCustomMatchers/RedirectBack.html">UmtsCustomMatchers::RedirectBack</a>
</ul>
</div>
</div>
</nav>
<main role="main">
<h1 id="label-UmtsCustomMatchers"><a href="UmtsCustomMatchers.html"><code>UmtsCustomMatchers</code></a><span><a href="#label-UmtsCustomMatchers">¶</a> <a href="#top">↑</a></span></h1>
<p>Custom RSpec Rails-related matchers, used for UMass Transit's internal Rails development process.</p>
<p>Much of the inspiration for these solutions came from inspection of the rspec-rails source code, so thanks to the rspec-rails team for making their source code public.</p>
<p><a href="https://travis-ci.org/umts/custom-matchers"><img src="https://travis-ci.org/umts/custom-matchers.svg?branch=master"></a> <a href="https://codeclimate.com/github/umts/custom-matchers/coverage"><img src="https://codeclimate.com/github/umts/custom-matchers/badges/coverage.svg"></a> <a href="https://codeclimate.com/github/umts/custom-matchers"><img src="https://codeclimate.com/github/umts/custom-matchers/badges/gpa.svg"></a> <a href="https://codeclimate.com/github/umts/custom-matchers"><img src="https://codeclimate.com/github/umts/custom-matchers/badges/issue_count.svg"></a></p>
<h2 id="label-Installation">Installation<span><a href="#label-Installation">¶</a> <a href="#top">↑</a></span></h2>
<p>Add this line to your application's Gemfile:</p>
<pre class="ruby"><span class="ruby-identifier">gem</span> <span class="ruby-string">'umts-custom-matchers'</span>
</pre>
<p>And then execute:</p>
<pre>$ bundle</pre>
<p>Or install it yourself as:</p>
<pre>$ gem install umts-custom-matchers</pre>
<h2 id="label-Usage">Usage<span><a href="#label-Usage">¶</a> <a href="#top">↑</a></span></h2>
<p>Require the matchers in your RSpec configuration file:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'umts_custom_matchers'</span>
</pre>
<p>And include them:</p>
<pre class="ruby"><span class="ruby-constant">RSpec</span>.<span class="ruby-identifier">configure</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">config</span><span class="ruby-operator">|</span>
<span class="ruby-comment"># ...</span>
<span class="ruby-identifier">config</span>.<span class="ruby-identifier">include</span> <span class="ruby-constant">UmtsCustomMatchers</span>
<span class="ruby-keyword">end</span>
</pre>
<h2 id="label-Development">Development<span><a href="#label-Development">¶</a> <a href="#top">↑</a></span></h2>
<p>After checking out the repo, run <code>bin/setup</code> to install dependencies. Then, run <code>rake spec</code> to run the tests. You can also run <code>bin/console</code> for an interactive prompt that will allow you to experiment.</p>
<p>To install this gem onto your local machine, run <code>bundle exec rake install</code>. To release a new version, update the version number in <code>version.rb</code>, and then run <code>bundle exec rake release</code>, which will create a git tag for the version, push git commits and tags, and push the <code>.gem</code> file to <a href="https://rubygems.org">rubygems.org</a>.</p>
<h2 id="label-Contributing">Contributing<span><a href="#label-Contributing">¶</a> <a href="#top">↑</a></span></h2>
<p>Bug reports and pull requests are welcome on GitHub at <a href="https://github.com/umts/custom-matchers">github.com/umts/custom-matchers</a>.</p>
<h2 id="label-License">License<span><a href="#label-License">¶</a> <a href="#top">↑</a></span></h2>
<p>The gem is available as open source under the terms of the <a href="http://opensource.org/licenses/MIT">MIT License</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.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>