mongo_inspired_compare 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59bdc9bce2a74975ebba9c8d23d8e430e5d24cf7
-  data.tar.gz: a1d1f4d4914016fdbaca22d9f49f821864719355
+  metadata.gz: 54d2f148fd4c0538810677f73edfab5ccd1bc6f3
+  data.tar.gz: cd769dfdcdf43dbccfe807458b225d55ea597094
 SHA512:
-  metadata.gz: 20cb87fa8e2787634f189bbcb88eb217c248311e881fe4296a6137512be14afb910e144ca0d73a22346efac59058c69dc62fcaf35807d1f53830a74a7fb2c9cb
-  data.tar.gz: 555dadd69e083dbf6bbc49e140800d4a4fb1b5c2d6cced50377c535df5f1cdbf10e4e5e5dc09046e243772445c0a3a31c55eab476e1ec36d7f9eb9dd0682aad7
+  metadata.gz: 79af9b7ef0fe5a31147605b166bfdc595a55b1ce95ac4c41dde1dd87ab1a198e6882f341eb1fdaa3bf8a1226b4e28f91232fb5d7bc1dcddb3435b227a69bf93f
+  data.tar.gz: 296efcf3ffd4f2c85adea51beb6dd3f3bc9f843775c5bb1e0130509d20bda8c553aa3295628d02296738ca2ee7552ed0cfaae62f4f2affef9021b07ce31bc1f1

data/lib/mongo_inspired_compare.rb

@@ -1,8 +1,50 @@
 class MongoInspiredCompare
-  # mongo-inspired syntax for criteria
-  # if criterion is not hashes then simply tests for equality
-  # if criteron is a hash, then it considers it to be {operator: comparitor}
-  # it handles some smart conversion of "1.2" to 1.2 if the comparitor is a number
+
+  ## 
+  # Takes a value and a comparitor and returns true or false
+  #
+  # === Basic Comparisons
+  # > MongoInspiredCompare.compare( 5, 5 )
+  # => true
+  #
+  # > MongoInspiredCompare.compare( 5, 6 )
+  # => false
+  #
+  #
+  # === Basic Operators
+  # > MongoInspiredCompare.compare( 5, {"$gte"=>5} )
+  # => true
+  #
+  # > MongoInspiredCompare.compare( 5, {"$lt"=>5} )
+  # => false
+  #
+  # > MongoInspiredCompare.compare( 5, {"$in"=>[1, 2, 3, 4, 5]} )
+  # /Users/daviddo/Documents/mongo_inspired_compare/lib/mongo_inspired_compare.rb:13: warning: constant ::Fixnum is deprecated
+  # => true
+  #
+  # > MongoInspiredCompare.compare( 5, {"$nin"=>[1, 2, 3, 4, 5]} )
+  # => false
+  #
+  #
+  # === Nesting
+  # > MongoInspiredCompare.compare( 5, {"$in"=>[{"$lt"=>5}, {"$gte"=>5}]} )
+  # => true
+  #
+  #
+  # === And/or Operators
+  # > MongoInspiredCompare.compare( 5, {"$or"=>[{"$lt"=>5}, {"$gte"=>5}]} )
+  # => true
+  #
+  # > MongoInspiredCompare.compare( 5, {"$and"=>[{"$lt"=>5}, {"$gte"=>5}]} )
+  # => false
+  #
+  #
+  # === Invariance
+  # > MongoInspiredCompare.compare( "5", {"$gte"=>5} )
+  # => true
+  #
+  # > MongoInspiredCompare.compare( "5x", {"$gte"=>5} )
+  # => false
 
   def self.compare( val, criterion ) 
     if criterion.class != Hash

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongo_inspired_compare
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - David Do