qo 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af6c00578bf0fca7464a3823282f8de93e3f5befde82c991e1f4cee97c244c1a
-  data.tar.gz: 9532c9394d8874306487846fe166c11315a5e322af62d58a40ee8f5a59257cf1
+  metadata.gz: 2dcdd32a9c1743ae07fee6699551ca57393c751ce8172950edea505013e5a628
+  data.tar.gz: 4b39a86b816b039c3282a5b0d307afb796f5dabed249cf3b658462a5bd791ece
 SHA512:
-  metadata.gz: 71953edde27da9876463b453c8b8909986ea8f18461fa5c9ae123a15c71fea739276dd768a85487fc51152e6e3d3e0f0c9eecbc09db95eb97fc7433584caa2b0
-  data.tar.gz: 754e7dce63ca7a0e9b641fe45eb2b06feeb3045804f9a3236088c0187781b50de5422eaf506f777cd92f24a674ad1ca8d5dbc2faa6eac4fdfe53cdde9b007314
+  metadata.gz: bb43a7e3a7e2134d477149548c1de8de6961fa62a8da1c606ffa743287d95cb05bd5d400174e343297cf9c21a205f32aa60500abbb32c094c1cac4699558f18f
+  data.tar.gz: 481c3331b0e1328b8e6eae0fd8c34ca54df0f58204cf8a0dc0cfff568343af618450a5978c1132e3a250da474c7dfd90fc4df3132ecc99f80095a1fc485b7faa

data/README.md

@@ -30,6 +30,9 @@ Fast forward a few months and I kind of wanted to make it real, so here it is. I
 
 ## Usage
 
+Note that Qo uses the [Any](https://www.github.com/baweaver/any) gem for wildcard matching. Any will respond true to any `==` or `===` query against it,
+and is included in the gem.
+
 ### Quick Start
 
 Qo is used for pattern matching in Ruby. All Qo matchers respond to `===` and `to_proc` meaning they can be used with `case` and Enumerable functions alike:
@@ -37,7 +40,7 @@ Qo is used for pattern matching in Ruby. All Qo matchers respond to `===` and `t
 
 ```ruby
 case ['Foo', 42]
-when Qo[:*, 42] then 'Truly the one answer'
+when Qo[Any, 42] then 'Truly the one answer'
 else nil
 end
 
@@ -51,18 +54,18 @@ How about some pattern matching? There are two styles:
 
 The original style
 
-```
+```ruby
 # How about some "right-hand assignment" pattern matching
 name_longer_than_three      = -> person { person.name.size > 3 }
 people_with_truncated_names = people.map(&Qo.match(
   Qo.m(name_longer_than_three) { |person| Person.new(person.name[0..2], person.age) },
-  Qo.m(:*) # Identity function, catch-all
+  Qo.m(Any) # Identity function, catch-all
 ))
 
 # And standalone like a case:
 Qo.match(people.first,
   Qo.m(age: 10..19) { |person| "#{person.name} is a teen that's #{person.age} years old" },
-  Qo.m(:*) { |person| "#{person.name} is #{person.age} years old" }
+  Qo.m(Any) { |person| "#{person.name} is #{person.age} years old" }
 )
 ```
 
@@ -130,16 +133,16 @@ people_objects = [
 
 ### 1 - Wildcard Matching
 
-Qo has a concept of a Wildcard, `:*`, which will match against any value
+Qo has a concept of a Wildcard, `Any`, which will match against any value
 
 ```ruby
-Qo[:*, :*] === ['Robert', 22] # true
+Qo[Any, Any] === ['Robert', 22] # true
 ```
 
 A single wildcard will match anything, and can frequently be used as an always true:
 
 ```ruby
-Qo[:*] === :literally_anything_here
+Qo[Any] === :literally_anything_here
 ```
 
 ### 2 - Array Matching
@@ -156,63 +159,40 @@ This gives us the `and` matcher shorthand for array matchers.
 
 When an Array matcher is run against an Array, it will compare elements by index in the following priority:
 
-1. Was a wildcard provided?
-2. Does it case match (`===`)?
-3. Does it have a predicate method by that name that matches?
+1. Does it case match (`===`)?
+2. Does it have a predicate method by that name that matches?
 
 This functionality is left biased and permissive, meaning that if the right side of the argument is longer it will ignore those items in the match. If it's shorter? Not so much.
 
-##### 2.1.1 - Wildcard provided
-
-```ruby
-# Standalone
-
-Qo[:*, :*] === ['Robert', 22]
-# => true
-
-# Case statement
-
-case ['Roberta', 22]
-when Qo[:*, :*] then 'it matched'
-else 'will not ever be reached'
-end
-# => 'it matched'
-
-# Select
-
-people_arrays.select(&Qo[:*, :*])
-# => [['Robert', 22], ['Roberta', 22], ['Foo', 42], ['Bar', 18]]
-```
-
-##### 2.1.2 - Case Match present
+##### 2.1.1 - Case Match present
 
 We've seen some case matching so far with `Range` and `Regex`:
 
 ```ruby
 # Standalone
 
-Qo[/Rob/, :*] === ['Robert', 22]
+Qo[/Rob/, Any] === ['Robert', 22]
 # => true
 
 # Case statement
 
 case ['Roberta', 22]
-when Qo[:*, 0..9] then 'child'
-when Qo[:*, 10..19] then 'teen'
-when Qo[:*, 20..99] then 'adult'
+when Qo[Any, 0..9] then 'child'
+when Qo[Any, 10..19] then 'teen'
+when Qo[Any, 20..99] then 'adult'
 else 'not sure'
 end
 # => 'adult'
 
 # Select
 
-people_arrays.select(&Qo[:*, 10..19])
+people_arrays.select(&Qo[Any, 10..19])
 # => [['Bar', 18]]
 ```
 
-##### 2.1.3 - Predicate Method matched
+##### 2.1.2 - Predicate Method matched
 
-If no wildcard or case match is found, it will attempt to see if a predicate method by the same name exists, call it, and check the result:
+If no case match is found, it will attempt to see if a predicate method by the same name exists, call it, and check the result:
 
 ```ruby
 dirty_values = [nil, '', true]
@@ -225,14 +205,14 @@ Qo[:nil?] === [nil]
 # Case statement
 
 case ['Roberta', nil]
-when Qo[:*, :nil?] then 'no age'
+when Qo[Any, :nil?] then 'no age'
 else 'not sure'
 end
 # => 'no age'
 
 # Select
 
-people_arrays.select(&Qo[:*, :even?])
+people_arrays.select(&Qo[Any, :even?])
 # => [["Robert", 22], ["Roberta", 22], ["Foo", 42], ["Bar", 18]]
 ```
 
@@ -240,21 +220,12 @@ people_arrays.select(&Qo[:*, :even?])
 
 When an Array matcher is matched against anything other than an Array it will follow the priority:
 
-1. Was a wildcard provided?
 2. Does it case match (`===`)?
 3. Does it have a predicate method by that name that matches?
 
 Every argument provided will be run against the target object.
 
-##### 2.2.1 - Wildcard provided
-
-A wildcard in an Array to Object match is functionally an always true, but can be used as such:
-
-```ruby
-Qo[:*] === :literally_anything_here
-```
-
-##### 2.2.2 - Case Match present
+##### 2.2.1 - Case Match present
 
 ```ruby
 # Standalone
@@ -270,7 +241,7 @@ Qo[Integer, 15..25] === 20
 # => [10, "string"]
 ```
 
-##### 2.2.3 - Predicate Method matched
+##### 2.2.2 - Predicate Method matched
 
 Now this is where some of the fun starts in
 
@@ -302,10 +273,9 @@ end
 
 1. Does the key exist on the other hash?
 2. Are the match value and match target hashes?
-3. Was a wildcard value provided?
-4. Does the target object's value case match against the match value?
-5. Does the target object's value predicate match against the match value?
-6. What about the String version of the match key? Abort if it can't coerce.
+3. Does the target object's value case match against the match value?
+4. Does the target object's value predicate match against the match value?
+5. What about the String version of the match key? Abort if it can't coerce.
 
 ##### 3.1.1 - Key present
 
@@ -352,16 +322,7 @@ Qo.or(a: {
 })
 ```
 
-##### 3.1.3 - Wildcard provided
-
-As with other wildcards, if the value matched against is a wildcard it'll always get through:
-
-```ruby
-Qo[name: :*] === {name: 'Foo'}
-# => true
-```
-
-##### 3.1.4 - Case match present
+##### 3.1.3 - Case match present
 
 If a case match is present for the key, it'll try and compare:
 
@@ -386,7 +347,7 @@ people_hashes.select(&Qo[age: 15..25])
 # => [{:name=>"Robert", :age=>22}, {:name=>"Roberta", :age=>22}, {:name=>"Bar", :age=>18}]
 ```
 
-##### 3.1.5 - Predicate match present
+##### 3.1.4 - Predicate match present
 
 Much like our array friend above, if a predicate style method is present see if it'll work
 
@@ -413,26 +374,21 @@ people_hashes.reject(&Qo[age: :nil?])
 
 Careful though, if the key doesn't exist that won't match. I'll have to consider this one later.
 
-##### 3.1.6 - String variant present
+##### 3.1.5 - String variant present
 
 Coerces the key into a string if possible, and sees if that can provide a valid case match
 
 #### 3.2 - Hash matched against an Object
 
 1. Does the object respond to the match key?
-2. Was a wildcard value provided?
-3. Does the result of sending the match key as a method case match the provided value?
-4. Does a predicate method exist for it?
+2. Does the result of sending the match key as a method case match the provided value?
+3. Does a predicate method exist for it?
 
 ##### 3.2.1 - Responds to match key
 
 If it doesn't know how to deal with it, false out.
 
-##### 3.2.2 - Wildcard provided
-
-Same as other wildcards, but if the object doesn't respond to the method you specify it'll have false'd out before it reaches here.
-
-##### 3.2.3 - Case match present
+##### 3.2.2 - Case match present
 
 This is where we can get into some interesting code, much like the hash selections above
 
@@ -456,7 +412,7 @@ people_objects.select(&Qo[name: /Rob/])
 # => [Person(Robert, 22), Person(Roberta, 22)]
 ```
 
-##### 3.2.4 - Predicate match present
+##### 3.2.3 - Predicate match present
 
 ```ruby
 # Standalone
@@ -484,16 +440,16 @@ This is where I start going a bit off into the weeds. We're going to try and get
 
 ```ruby
 Qo.match(['Robert', 22],
-  Qo.m(:*, 20..99) { |n, a| "#{n} is an adult that is #{a} years old" },
-  Qo.m(:*)
+  Qo.m(Any, 20..99) { |n, a| "#{n} is an adult that is #{a} years old" },
+  Qo.m(Any)
 )
 # => "Robert is an adult that is 22 years old"
 ```
 
 ```ruby
 Qo.match(people_objects.first,
-  Qo.m(name: :*, age: 20..99) { |person| "#{person.name} is an adult that is #{person.age} years old" },
-  Qo.m(:*)
+  Qo.m(name: Any, age: 20..99) { |person| "#{person.name} is an adult that is #{person.age} years old" },
+  Qo.m(Any)
 )
 ```
 
@@ -514,7 +470,7 @@ people_objects.map(&Qo.match(
     person.name = person.name[0..2]
     person
   },
-  Qo.m(:*)
+  Qo.m(Any)
 ))
 
 # => [Person(age: 22, name: "Rob"), Person(age: 22, name: "Rob"), Person(age: 42, name: "Foo"), Person(age: 17, name: "Bar")]
@@ -619,7 +575,7 @@ HTTP responses.
 def get_url(url)
   Net::HTTP.get_response(URI(url)).yield_self(&Qo.match(
     Qo.m(Net::HTTPSuccess) { |response| response.body.size },
-    Qo.m(:*)               { |response| raise response.message }
+    Qo.m(Any)              { |response| raise response.message }
   ))
 end
 

data/docs/Qo.html

@@ -84,7 +84,7 @@
   <dl>
     <dt>Defined in:</dt>
     <dd>lib/qo.rb<span class="defines">,<br />
-  lib/qo/helpers.rb,<br /> lib/qo/version.rb,<br /> lib/qo/exceptions.rb,<br /> lib/qo/public_api.rb,<br /> lib/qo/matchers/base_matcher.rb,<br /> lib/qo/matchers/hash_matcher.rb,<br /> lib/qo/matchers/array_matcher.rb,<br /> lib/qo/matchers/pattern_match.rb,<br /> lib/qo/matchers/guard_block_matcher.rb</span>
+  lib/qo/helpers.rb,<br /> lib/qo/version.rb,<br /> lib/qo/exceptions.rb,<br /> lib/qo/public_api.rb,<br /> lib/qo/matchers/base_matcher.rb,<br /> lib/qo/matchers/hash_matcher.rb,<br /> lib/qo/matchers/array_matcher.rb,<br /> lib/qo/matchers/pattern_match.rb,<br /> lib/qo/matchers/guard_block_matcher.rb,<br /> lib/qo/matchers/pattern_match_block.rb</span>
 </dd>
   </dl>
   
@@ -104,15 +104,10 @@
   <h2>Constant Summary</h2>
   <dl class="constants">
     
-      <dt id="WILDCARD_MATCH-constant" class="">WILDCARD_MATCH =
-        
-      </dt>
-      <dd><pre class="code"><span class='symbol'>:*</span></pre></dd>
-    
       <dt id="VERSION-constant" class="">VERSION =
         
       </dt>
-      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.2.0</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.4.0</span><span class='tstring_end'>&#39;</span></span></pre></dd>
     
   </dl>
 
@@ -155,9 +150,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Apr 15 20:29:44 2018 by
+  Generated on Sun Aug  5 20:52:09 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.12 (ruby-2.4.4).
+  0.9.12 (ruby-2.5.1).
 </div>
 
     </div>

data/docs/Qo/Exceptions.html

@@ -134,7 +134,7 @@
     
   
     
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Exceptions/MultipleMatchersProvided.html" title="Qo::Exceptions::MultipleMatchersProvided (class)">MultipleMatchersProvided</a></span>, <span class='object_link'><a href="Exceptions/NoMatchersProvided.html" title="Qo::Exceptions::NoMatchersProvided (class)">NoMatchersProvided</a></span>, <span class='object_link'><a href="Exceptions/NotAllGuardMatchersProvided.html" title="Qo::Exceptions::NotAllGuardMatchersProvided (class)">NotAllGuardMatchersProvided</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Exceptions/MultipleElseClauses.html" title="Qo::Exceptions::MultipleElseClauses (class)">MultipleElseClauses</a></span>, <span class='object_link'><a href="Exceptions/MultipleMatchersProvided.html" title="Qo::Exceptions::MultipleMatchersProvided (class)">MultipleMatchersProvided</a></span>, <span class='object_link'><a href="Exceptions/NoMatchersProvided.html" title="Qo::Exceptions::NoMatchersProvided (class)">NoMatchersProvided</a></span>, <span class='object_link'><a href="Exceptions/NotAllGuardMatchersProvided.html" title="Qo::Exceptions::NotAllGuardMatchersProvided (class)">NotAllGuardMatchersProvided</a></span>
     
   
 </p>
@@ -150,9 +150,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Apr 15 20:29:44 2018 by
+  Generated on Sun Aug  5 20:52:09 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.12 (ruby-2.4.4).
+  0.9.12 (ruby-2.5.1).
 </div>
 
     </div>

data/docs/Qo/Exceptions/MultipleElseClauses.html

@@ -0,0 +1,257 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Exception: Qo::Exceptions::MultipleElseClauses
+  
+    &mdash; Documentation by YARD 0.9.12
+  
+</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">
+  pathId = "Qo::Exceptions::MultipleElseClauses";
+  relpath = '../../';
+</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 class="nav_wrap">
+      <iframe id="nav" src="../../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="../../_index.html">Index (M)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../Qo.html" title="Qo (module)">Qo</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Exceptions.html" title="Qo::Exceptions (module)">Exceptions</a></span></span>
+     &raquo; 
+    <span class="title">MultipleElseClauses</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../../class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Exception: Qo::Exceptions::MultipleElseClauses
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">ArgumentError</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">ArgumentError</li>
+          
+            <li class="next">Qo::Exceptions::MultipleElseClauses</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+    </dd>
+  </dl>
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/qo/exceptions.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>In the case of a Pattern Match, we should only have one &quot;else&quot; clause</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Author:</p>
+<ul class="author">
+  
+    <li>
+      
+      
+      
+      
+        
+        <div class='inline'><p>baweaver</p>
+</div>
+      
+    </li>
+  
+</ul>
+<p class="tag_title">Since:</p>
+<ul class="since">
+  
+    <li>
+      
+      
+      
+      
+        
+        <div class='inline'><p>0.3.0</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+
+
+
+
+
+
+  
+    <h2>
+      Instance Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+  
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="to_s-instance_method">
+  
+    #<strong>to_s</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Since:</p>
+<ul class="since">
+  
+    <li>
+      
+      
+      
+      
+        
+        <div class='inline'><p>0.3.0</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+49
+50
+51</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/qo/exceptions.rb', line 49</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
+  <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Cannot have more than one `else` clause in a Pattern Match.</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+      <div id="footer">
+  Generated on Sun Aug  5 20:52:10 2018 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.12 (ruby-2.5.1).
+</div>
+
+    </div>
+  </body>
+</html>