delight 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33be3483fc364798e5ab551821b8f4404709c195eaddad0dc6373b9be7b92296
-  data.tar.gz: 38e642bd941c1e1292dff9160aa23fabdf5cdfa499d9e81f1769acbed84469f4
+  metadata.gz: eb589267629b62a9906d523d22ecf83c034f1df0ce9bf301079891a537d9a688
+  data.tar.gz: 1af7bc10bb90205a4127f9aecb936b677e23d561b5a0d96e0785a181aa554ca8
 SHA512:
-  metadata.gz: 205d6c36bfe8c7cfd8aafb1be617cbad488f4aff7b257a5f5a5dcb5ec05bd8a9f8e61e5613a212191531c65b7f71d28a26d8adc585dd4c1cdd35f8e20894f168
-  data.tar.gz: 240ffb9fc46657aa2e9f8a695d06d0ca5976de1c82486c16b5238dd4a77b045e70b46c0391bae02772ca1ba1ba2779117f264c937be88f1b7ecbafc75b44529f
+  metadata.gz: fc015857edf6623769c2af429ae7a4308b243b24bd4ad8f6516f7ed885007280615c56119fb12bf43d3323c3d3b56c801341e492d6fbc3c092f75ecba97fb25b
+  data.tar.gz: bceac43c952c822ba667faa8f16157108699487f50e006add390bf4e4e059869cf1807b70bad44900db64559cf9312d90069a2704adced962484b10196170351

data/README.md

@@ -1,43 +1,72 @@
 # Delight
 
-TODO: Delete this and the text below, and describe your gem
+Delight is a Ruby gem offering small yet useful extensions to the core Ruby classes. Those extensions are implemented as Refinements, which means they are only available in the scope where they are explicitly activated. This allows you to use them without worrying about polluting the global namespace or causing conflicts with other gems.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/delight`. To experiment with that code, run `bin/console` for an interactive prompt.
+## [Installation](Installation)
 
-## Installation
+```bash
+bundle add delight
+```
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## Usage
 
-Install the gem and add to the application's Gemfile by executing:
+In order to import all available methods use the global `Delight::Enumerable` refinement.
 
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```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
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+### `.select_by`
 
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+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
 ```
 
-## Usage
+Object attributes are compared using `===` operator, so you can use any object
+that implements it. For example, you can use a range:
 
-TODO: Write usage instructions here
+```ruby
+addresses.select_by(age: 18..)
 
-## Development
+addresses.select do |address|
+  address.age >= 18
+end
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+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:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+[18, 2.5, "foo"].select_by(itself: Numeric)
+# => [18, 2.5]
+```
 
-## Contributing
+## Development
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/delight. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/delight/blob/main/CODE_OF_CONDUCT.md).
+[...]
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Delight project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/delight/blob/main/CODE_OF_CONDUCT.md).

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/enumerator/select_by.rb

@@ -1,33 +1,9 @@
 module Delight
   module Enumerator
     module SelectBy
-      # Filter colleciton elements using method calls and values passed as
-      # keyword arguments.
-      #
-      # @return [Array] containingg elements that match the passed arguments.
-      #
-      # @example
-      #   ["String", 1, 3, :symbol, 'string'].select_by(class: String)
-      #     # => ["String", 'string']
-      #
-      #   Person = Struct.new(:name, :age)
-      #
-      #   people = [
-      #     Person.new("John", 30),
-      #     Person.new("Jane", 25),
-      #     Person.new("Alice", 30),
-      #   ]
-      #
-      #   people.select_by(age: 30)
-      #   # => [
-      #   #  Person.new("John", 30),
-      #   #  Person.new("Alice", 30),
-      #   # ]
-      #
-      def select_by(**)
-        select do |element|
-          collection_matcher(element, **)
-        end
+      refine Enumerable do
+        import_methods CollectionMatcher
+        import_methods SelectByMethods
       end
     end
   end

data/lib/delight/enumerator/select_by_methods.rb

@@ -0,0 +1,34 @@
+module Delight
+  module Enumerator
+    module SelectByMethods
+      # Filter collection elements using method calls and values passed as
+      # keyword arguments.
+      #
+      # @return [Array] containingg elements that match the passed arguments.
+      #
+      # @example
+      #   ["String", 1, 3, :symbol, 'string'].select_by(class: String)
+      #     # => ["String", 'string']
+      #
+      #   Person = Struct.new(:name, :age)
+      #
+      #   people = [
+      #     Person.new("John", 30),
+      #     Person.new("Jane", 25),
+      #     Person.new("Alice", 30),
+      #   ]
+      #
+      #   people.select_by(age: 30)
+      #   # => [
+      #   #  Person.new("John", 30),
+      #   #  Person.new("Alice", 30),
+      #   # ]
+      #
+      def select_by(**)
+        select do |element|
+          collection_matcher(element, **)
+        end
+      end
+    end
+  end
+end

data/lib/delight/enumerator.rb

@@ -4,7 +4,7 @@ module Delight
       import_methods CollectionMatcher
       import_methods HashCollectionMatcher
 
-      import_methods SelectBy
+      import_methods SelectByMethods
       import_methods SelectByKey
 
       import_methods DetectBang

data/lib/delight/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: delight
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Mariusz Droździel
@@ -45,6 +45,7 @@ files:
 - lib/delight/enumerator/hash_collection_matcher.rb
 - lib/delight/enumerator/select_by.rb
 - lib/delight/enumerator/select_by_key.rb
+- lib/delight/enumerator/select_by_methods.rb
 - lib/delight/enumerator/sole_by.rb
 - lib/delight/enumerator/sole_by_key.rb
 - lib/delight/enumerator/try_sole_by.rb