delight 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2cd266511e6dbdfb174a5605837cf75cbebfb108b42ee5eca092c220e1ed112
-  data.tar.gz: 41edbb872467c0fe4c83c9a376e446f24bbf9687f0df7ea99958e8d38689e237
+  metadata.gz: eb589267629b62a9906d523d22ecf83c034f1df0ce9bf301079891a537d9a688
+  data.tar.gz: 1af7bc10bb90205a4127f9aecb936b677e23d561b5a0d96e0785a181aa554ca8
 SHA512:
-  metadata.gz: '0124922833bb99d4471f3fa968963cc70076b8529eeac5165a81f299df474b5ed13bc6a37d8e2d251ded434e2e25fb75d5f1db49b84a6882329d94faa1775fc3'
-  data.tar.gz: 3fefc8b830592df6eafdf4b0a06af78f7bde1e40a90d60be19bac9bf52338101a651c771871ec6d1cf08ac2accc45d6c9d0fc94b3993942883fe85951e1eca7c
+  metadata.gz: fc015857edf6623769c2af429ae7a4308b243b24bd4ad8f6516f7ed885007280615c56119fb12bf43d3323c3d3b56c801341e492d6fbc3c092f75ecba97fb25b
+  data.tar.gz: bceac43c952c822ba667faa8f16157108699487f50e006add390bf4e4e059869cf1807b70bad44900db64559cf9312d90069a2704adced962484b10196170351

data/README.md

@@ -10,7 +10,58 @@ bundle add delight
 
 ## Usage
 
-[...]
+In order to import all available methods use the global `Delight::Enumerable` refinement.
+
+```ruby
+class MyClass
+  using Delight::Enumerable
+
+  def initialize(some_list)
+    @some_list = some_list
+  end
+
+  def my_method
+    some_list.select_by(country: "PL")
+  end
+end
+```
+
+### `.select_by`
+
+The `.select_by` method allows you to filter an array of objects based on a
+value(s) of single or multiple methods. Object in the collection must respond to
+the methods you are filtering by. Calling non-existing method will raise an
+`NoMethodError`.
+
+Following two examples are equivalent:
+
+```ruby
+addresses.select_by(country: "PL", city: "Warsaw")
+
+addresses.select do |address|
+  address.country == "PL" && address.city == "Warsaw"
+end
+```
+
+Object attributes are compared using `===` operator, so you can use any object
+that implements it. For example, you can use a range:
+
+```ruby
+addresses.select_by(age: 18..)
+
+addresses.select do |address|
+  address.age >= 18
+end
+```
+
+Warning, be aware of of the `===` operator behavior. For example, if you would
+like to filter out the object by class, you need to use the object itself as the
+argument, thus pass the `itself` method:
+
+```ruby
+[18, 2.5, "foo"].select_by(itself: Numeric)
+# => [18, 2.5]
+```
 
 ## Development
 

data/lib/delight/enumerator/collection_matcher.rb

@@ -3,7 +3,7 @@ module Delight
     module CollectionMatcher
       def collection_matcher(element, **kwargs)
         kwargs.all? do |key, value|
-          element.public_send(key) == value
+          value === element.public_send(key)
         end
       end
     end

data/lib/delight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Delight
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: delight
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Mariusz Droździel