qo 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c98fa2c3b82ac4167eba17b183fe1cea46a0e36f
-  data.tar.gz: ab2527c365781b54fac1290ac64e8a17acdcd07c
+  metadata.gz: 594012163edefd5fedd3266382aca2efddd10432
+  data.tar.gz: aa376733835f2fa1ce1abbe16018e2b2344f96ad
 SHA512:
-  metadata.gz: f1e9b886e694b8c08f212209db40bc8ca1276b738d1d30c81040e0b651f264bcfc9c83a21d82d96f2ff418d05def3e5abae82a29394f184266fab424f5dad4a6
-  data.tar.gz: ab226ea4d673ea462b2e41084d25c8a61b2c04e37e8aac9354745b1b17c4ae54b5efa6184ae28e0201fa453b525938f4d8f260912300a0f145cc0992607424e1
+  metadata.gz: 6db60b6de5c5ab900e6b144ddc3c9ed4eee275781017cc3f36580f1f904b2287ce734378d9d3dc6e0412ac4f62f37166c001c07235ae519373efbb99282c75f6
+  data.tar.gz: 93404e15e4db2dee338f64769e035d2c33f5945e6f1a2c2d53240d5019c2f11b9eceb08af13dcfdb9a540fbe39aa935fb201f08ef8638c7c5f447ea722456923

data/README.md

@@ -2,6 +2,8 @@
 
 Short for Query Object, my play at Ruby pattern matching and fluent querying
 
+![Qo Lemur logo](img/qo_logo.png)
+
 ## How does it work?
 
 Triple equals black magic, mostly.
@@ -505,7 +507,7 @@ To be fair that means anything that can respond to `===`, including classes and
 This ends up coming up a lot, especially around querying, so let's get a way to count by!
 
 ```ruby
-Qo.count_by([1,2,3,2,2,2,1]
+Qo.count_by([1,2,3,2,2,2,1])
 
 # => {
 #   1 => 2,

data/Rakefile

@@ -1,6 +1,107 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'benchmark/ips'
+require 'qo'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+# Run a benchmark given a title and a set of benchmarks. Admittedly this
+# is done because the Benchmark.ips code can get a tinge repetitive and this
+# is easier to write out.
+#
+# @param title [String] Title of the benchmark
+# @param **benchmarks [Hash[Symbol, Proc]] Name to Proc to run to benchmark it
+#
+# @note Notice I'm using `'String': -> {}` instead of hashrockets? Kwargs doesn't
+#       take string / hashrocket arguments, probably to prevent abuse of the
+#       "anything can be a key" bit of Ruby.
+#
+# @return [Unit] StdOut
+def run_benchmark(title, **benchmarks)
+  puts '', title, '=' * title.size, ''
+
+  Benchmark.ips do |bm|
+    benchmarks.each do |benchmark_name, benchmark_fn|
+      bm.report(benchmark_name, &benchmark_fn)
+    end
+
+    bm.compare!
+  end
+end
+
+# Note that the current development of Qo is NOT to be performance first, it's to
+# be readability first with performance coming later. That means that early iterations
+# may well be slower, but the net expressiveness we get is worth it in the short run.
+task :perf do
+  # Compare simple array equality. I almost think this isn't fair to Qo considering
+  # no sane dev should use it for literal 1 to 1 matches like this.
+
+  simple_array = [1, 1]
+  run_benchmark('Array * Array - Literal',
+    'Vanilla': -> {
+      simple_array == simple_array
+    },
+
+    'Qo.and':  -> {
+      Qo.and(*simple_array).call(simple_array)
+    }
+  )
+
+  # Compare testing indexed array matches. This gets a bit more into what Qo does,
+  # though I feel like there are optimizations that could be had here as well.
+
+  range_match_set    = [1..10, 1..10, 1..10, 1..10]
+  range_match_target = [1, 2, 3, 4]
+
+  run_benchmark('Array * Array - Index pattern match',
+    'Vanilla': -> {
+      range_match_target.each_with_index.all? { |x, i| range_match_set[i] === x }
+    },
+
+    'Qo.and':  -> {
+      Qo.and(*range_match_set).call(range_match_target)
+    }
+  )
+
+  # Now we're getting into things Qo makes sense for. Comparing an entire list
+  # against a stream of predicates to check
+
+  numbers_array = [1, 2.0, 3, 4]
+
+  run_benchmark('Array * Object - Predicate match',
+    'Vanilla': -> {
+      numbers_array.all? { |i| i.is_a?(Integer) && i.even? && (20..30).include?(i) }
+    },
+
+    'Qo.and':  -> {
+      numbers_array.all?(&Qo.and(Integer, :even?, 20..30))
+    }
+  )
+
+  # This one is a bit interesting. The vanilla version is written to reflect that
+  # it has NO idea what the length of either set is, which is exactly what Qo
+  # has to deal with as well.
+
+  people_array_target = [
+    ['Robert', 22],
+    ['Roberta', 22],
+    ['Foo', 42],
+    ['Bar', 18]
+  ]
+
+  people_array_query = [/Rob/, 15..25]
+
+  run_benchmark('Array * Array - Select index pattern match',
+    'Vanilla': -> {
+      people_array_target.select { |person|
+        person.each_with_index.all? { |a, i| people_array_query[i] === a }
+      }
+    },
+
+    'Qo.and':  -> {
+      Qo.and(*people_array_query).call(people_array_target)
+    }
+  )
+end

data/lib/qo/matcher.rb

@@ -43,6 +43,8 @@ module Qo
     #     Object -> Bool # Boolean public send
     private def match_against_array(matchers)
       -> match_target {
+        return true if matchers == match_target
+
         match_target.is_a?(::Array) ?
           match_with(matchers.each_with_index, array_against_array_matcher(match_target)) :
           match_with(matchers, array_against_object_matcher(match_target))
@@ -60,6 +62,8 @@ module Qo
     #     Object -> Bool # Uses keys as methods with public send to `===` match against the value
     private def match_against_hash(matchers)
       -> match_target {
+        return true if matchers == match_target
+
         match_target.is_a?(::Hash) ?
           match_with(matchers, hash_against_hash_matcher(match_target)) :
           match_with(matchers, hash_against_object_matcher(match_target))

data/lib/qo/version.rb

@@ -1,3 +1,3 @@
 module Qo
-  VERSION = '0.1.7'
+  VERSION = '0.1.8'
 end

data/performance_report.txt

@@ -0,0 +1,60 @@
+
+Array * Array - Literal
+=======================
+
+Warming up --------------------------------------
+             Vanilla   289.298k i/100ms
+              Qo.and    39.896k i/100ms
+Calculating -------------------------------------
+             Vanilla      9.620M (± 2.4%) i/s -     48.313M in   5.025188s
+              Qo.and    456.077k (± 2.3%) i/s -      2.314M in   5.076462s
+
+Comparison:
+             Vanilla:  9620049.8 i/s
+              Qo.and:   456077.4 i/s - 21.09x  slower
+
+
+Array * Array - Index pattern match
+===================================
+
+Warming up --------------------------------------
+             Vanilla    46.056k i/100ms
+              Qo.and    14.514k i/100ms
+Calculating -------------------------------------
+             Vanilla    528.961k (± 3.0%) i/s -      2.671M in   5.054671s
+              Qo.and    154.299k (± 1.9%) i/s -    783.756k in   5.081304s
+
+Comparison:
+             Vanilla:   528961.3 i/s
+              Qo.and:   154299.4 i/s - 3.43x  slower
+
+
+Array * Object - Predicate match
+================================
+
+Warming up --------------------------------------
+             Vanilla   148.876k i/100ms
+              Qo.and    19.598k i/100ms
+Calculating -------------------------------------
+             Vanilla      2.385M (± 1.7%) i/s -     12.059M in   5.058028s
+              Qo.and    211.780k (± 1.4%) i/s -      1.078M in   5.090600s
+
+Comparison:
+             Vanilla:  2384846.4 i/s
+              Qo.and:   211780.0 i/s - 11.26x  slower
+
+
+Array * Array - Select index pattern match
+==========================================
+
+Warming up --------------------------------------
+             Vanilla    12.366k i/100ms
+              Qo.and    20.112k i/100ms
+Calculating -------------------------------------
+             Vanilla    128.645k (± 2.1%) i/s -    643.032k in   5.000638s
+              Qo.and    207.792k (± 7.2%) i/s -      1.046M in   5.061963s
+
+Comparison:
+              Qo.and:   207792.4 i/s
+             Vanilla:   128645.0 i/s - 1.62x  slower
+

data/qo.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "benchmark-ips"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qo
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Brandon Weaver
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-13 00:00:00.000000000 Z
+date: 2018-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - keystonelemur@gmail.com
@@ -101,10 +115,12 @@ files:
 - bin/setup
 - docs/.gitkeep
 - docs/_config.yml
+- img/qo_logo.png
 - lib/qo.rb
 - lib/qo/guard_block_matcher.rb
 - lib/qo/matcher.rb
 - lib/qo/version.rb
+- performance_report.txt
 - qo.gemspec
 homepage: https://www.github.com/baweaver/q
 licenses: