recollect-array 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 536bb7525bf775a16364fae2698019f27c2af8285d6f6731450c84cbb692447a
+  data.tar.gz: 1aa573511390953506f5c8b2f677b22d7eacaabb76ec799921dbb03a85b8b588
+SHA512:
+  metadata.gz: cffb2f2c9ced4860778c6c3b0bc2854cae9c81e0d6c75a171660586fb9f80780125bfb131c44070ac11b4d8b01b4e391045776196fcd4021c551c324b200c65c
+  data.tar.gz: 774943b98fde492185d2500f6fcc92ffa481294c71bcfe190a7885dc4071bedfac12503fc8cbb86f8147e398c9685c20c9876063ba40db5291d5a080f4f5c95d

data/.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = false
+insert_final_newline = false

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: ci
+
+on: [push]
+
+permissions:
+  contents: read
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v3
+      
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@2b019609e2b0f1ea1a2bc8ca11cb82ab46ada124
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+        
+    - name: Run RSpec
+      run: bundle exec rspec --color

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/.idea/
+.byebug_history
+.DS_store
+*.gem

data/.rubocop.yml

@@ -0,0 +1,65 @@
+Style/Documentation:
+  Enabled: false
+
+Style/DocumentationMethod:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 15
+
+Layout/LineLength:
+  Max: 150
+
+Layout/FirstArrayElementIndentation:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: true
+
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  SafeAutoCorrect: true
+  Exclude:
+    - bin/**/*
+    - config.ru
+    - Gemfile
+    - Rakefile
+
+AllCops:
+  DisabledByDefault: false
+  NewCops: enable
+  TargetRubyVersion: 3.1
+  Exclude:
+    - 'spec/factories/*.rb'
+    - 'db/schema.rb'
+    - *.gemspec
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': '()'
+
+Lint/DeprecatedConstants:
+  Enabled: true

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "vscode-run-rspec-file.custom-command": "bundle exec rspec --color"
+}

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tadeuu@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+ruby '>= 2.5.8'
+
+group :test do
+  gem 'byebug'
+  gem 'rspec'
+  gem 'simplecov', require: false
+end
+
+gem 'rubocop', require: false

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Thadeu Esteves Jr
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,477 @@
+<p align="center">
+  <h1 align="center">🔃 recollect-array</h1>
+  <p align="center"><i>Simple wrapper to filter array using Ruby and simple predicate conditions</i></p>
+</p>
+
+<p align="center">
+  <a href="https://rubygems.org/gems/recollect-array">
+    <img alt="Gem" src="https://img.shields.io/gem/v/recollect-array.svg">    
+  </a>
+
+  <a href="https://github.com/thadeu/recollect-array/actions/workflows/ci.yml">
+    <img alt="Build Status" src="https://github.com/thadeu/recollect-array/actions/workflows/ci.yml/badge.svg">
+  </a>
+</p>
+
+
+## Motivation
+
+Because in sometimes, we need filter array passing conditions. This gem simplify this work.
+
+## Documentation <!-- omit in toc -->
+
+Version    | Documentation
+---------- | -------------
+unreleased | https://github.com/thadeu/recollect-array/blob/main/README.md
+
+## Table of Contents <!-- omit in toc -->
+  - [Installation](#installation)
+  - [Configuration](#configuration)
+  - [Availables Predicates](#availables-predicates)
+  - [Usage](#usage)
+  - [Utilities](#utilities)
+
+## Compatibility
+
+| kind           | branch  | ruby               |
+| -------------- | ------- | ------------------ |
+| unreleased     | main    | >= 2.5.8, <= 3.1.x |
+
+## Installation
+
+Use bundle
+
+```ruby
+bundle add recollect-array
+```
+
+or add this line to your application's Gemfile.
+
+```ruby
+gem 'recollect-array'
+```
+
+## Configuration
+
+Without configuration, because we use only Ruby. ❤️
+
+## Availables Predicates for all values
+
+| Type | Suffix | Value | 
+| ----------- | ----------- | ----------- |
+| Equal | eq      | Anywhere |
+| NotEqual | noteq        | Anywhere |
+| Contains | cont        | Anywhere |
+| NotContains | notcont        | Anywhere |
+| Included | in  | Anywhere |
+| NotIncluded | notin        | Anywhere |
+| Start | start        | Anywhere |
+| NotStart | notstart        | Anywhere |
+| End | end        | Anywhere |
+| NotEnd | notend        | Anywhere |
+| LessThan | lt        | Anywhere |
+| LessThanEqual | lteq        | Anywhere |
+| GreaterThan | gt        | Anywhere |
+| GreaterThanEqual | gteq        | Anywhere |
+
+## Availables Predicates only when value is Hash
+
+> 💡 Below predicates works only when value is Hash
+
+| Type | Suffix | Value | 
+| ----------- | ----------- | ----------- |
+| NotEqual | not_eq        | Hash |
+| NotContains | not_cont        | Hash |
+| NotIncluded | not_in        | Hash |
+| NotStart | not_start        | Hash |
+| NotEnd | not_end        | Hash |
+
+
+## Usage
+
+<details>
+  <summary>Think that your data seems like this.</summary>
+  
+  ```ruby
+  data = [
+    {
+      id: 1,
+      name: 'Test #1',
+      email: 'test1@email1.com',
+      schedule: { all_day: true },
+      numbers: %w[1 2],
+      active: true,
+      count: 9
+    },
+    {
+      id: 2,
+      name: 'Test #2',
+      email: 'test2@email2.com',
+      schedule: { all_day: false },
+      numbers: %w[3 4],
+      active: true,
+      count: 10
+    },
+    {
+      id: 3,
+      name: 'Test #3',
+      email: 'test3@email3.com',
+      schedule: { all_day: false },
+      numbers: %w[5 6],
+      active: false,
+      count: 99
+    }
+  ]
+  ```
+</details>
+
+You can use one or multiples predicates in your filter. We see some use cases.
+
+### Flexible Use Case (Hash)
+
+**Equal**
+
+```ruby
+filters = {
+  active: {
+    eq: true
+  }
+}
+
+collection = Recollect::Array.filter(data, filters)
+```
+
+**NotEqual**
+
+```ruby
+filters = {
+  active: {
+    # noteq or not_eq
+    not_eq: true
+  }
+}
+
+collection = Recollect::Array.filter(data, filters)
+```
+
+**Nested Hash Paths**
+
+```ruby
+filters = {
+  'schedule.all_day': {
+    eq: true
+  }
+}
+
+collection = Recollect::Array.filter(data, filters)
+```
+
+**Nested Array Paths**
+
+> Note the `.0` 🎉
+
+```ruby
+filters = {
+  'numbers.0': {
+    eq: '3'
+  }
+}
+
+collection = Recollect::Array.filter(data, filters)
+```
+
+```ruby
+filters = {
+  numbers: {
+    in: '3' # or in: ['3']
+  }
+}
+
+collection = Recollect::Array.filter(data, filters)
+```
+
+If array, you can navigate into self, using `property.NUMBER.property`
+
+```ruby
+data = [
+  {
+    schedules: [
+      {
+        opened: true,
+        all_day: true
+      },
+      {
+        opened: false,
+        all_day: true
+      }
+    ]
+  },
+  {
+    schedules: [
+      {
+        opened: false,
+        all_day: true
+      },
+      {
+        opened: false,
+        all_day: true
+      }
+    ]
+  }
+]
+
+filters = {
+  'schedules.0.opened': {
+    eq: true
+  }
+}
+
+# OR
+
+filters = {
+  'schedules[0]opened': {
+    eq: true
+  }
+}
+
+# OR
+
+filters = {
+  'schedules.[0].opened': {
+    eq: true
+  }
+}
+
+collection = Recollect::Array.filter(data, filters)
+
+# [{ schedules: [{ opened: true, all_day: true }, { opened: false, all_day: true }] }]
+```
+
+Amazing, you can pass a Callable value as value, like this.
+
+```ruby
+filters = {
+  'schedules.[0].opened': {
+    eq: -> { true }
+  }
+}
+
+# OR a Module
+
+module ActiveTruthy
+  def self.call = true
+end
+
+module NumbersAvailable
+  def self.call = %w[1 2]
+end
+
+filters = {
+  'schedules.[0].opened': {
+    eq: ActiveTruthy
+  },
+  numbers: {
+    in: NumbersAvailable
+  }
+}
+
+# OR a Class
+
+class ActiveFalsey
+  def self.call = false
+end
+
+filters = {
+  'schedules.[0].opened': {
+    eq: ActiveFalsey
+  }
+}
+
+collection = Recollect::Array.filter(data, filters)
+```
+
+**Combine conditions**
+
+Yes, you can combine one or multiple predicates to filter you array.
+
+
+```ruby
+filters = {
+  active: { eq: true },
+  numbers: {
+    in: %w[5],
+    not_in: '10'
+  },
+  email: {
+    cont: 'email1',
+    not_cont: '@gmail'
+  },
+  'schedule.all_day': {
+    in: [true, false]
+  }
+}
+
+collection = Recollect::Array.filter(data, filters)
+```
+
+### Querystring Use Case
+
+**Equal**
+
+```ruby
+filters = { active_eq: true }
+
+collection = Recollect::Array.filter(data, filters)
+```
+
+**NotEqual**
+
+```ruby
+filters = { active_noteq: true }
+
+collection = Recollect::Array.filter(data, filters)
+```
+
+**Nested Hash Paths**
+
+```ruby
+filters = { 'schedule.all_day_eq': false }
+
+collection = Recollect::Array.filter(data, filters)
+```
+
+**Nested Array Paths**
+
+> Note the `.0` 🎉
+
+```ruby
+filters = { 'numbers.0_eq': '3' }
+
+collection = Recollect::Array.filter(data, filters)
+```
+
+```ruby
+filters = { numbers_in: ['1'] }
+
+collection = Recollect::Array.filter(data, filters)
+
+expect(collection.result.size).to eq(1)
+```
+
+**Combine conditions**
+
+Yes, you can combine one or multiple predicates to filter you array.
+
+
+```ruby
+filters = {
+  active_noteq: true,
+  numbers_in: %w[5],
+  email_cont: 'test3',
+  'schedule.all_day_eq': false
+}
+
+collection = Recollect::Array.filter(data, filters)
+```
+
+**Receive querystring in your route**
+
+Like Ransack, imagine that you receive an querystring and you want to filter your Array. So, you can to do something like this.
+
+> ⚠️ But security is your responsability, ok? Let's go!
+
+```ruby
+# receive querystring in your route
+querystring = "active_noteq=true&numbers_in=5&email_cont=test3&schedule.all_day_eq=false"
+
+# parse querystring and transform to Hash
+params = URI.decode_www_form(querystring).to_h
+
+# filter your collection using params directly.
+collection = Recollect::Array.filter(data, filters)
+
+# Beautiful, right? 🎉
+```
+
+## Utilities
+
+### Recollect::Hashie.get(hash, path)
+
+```ruby
+user = {
+  id: 1,
+  name: 'Test #1',
+  email: 'test1@email1.com',
+  schedule: { all_day: true },
+  numbers: %w[1 2],
+  active: true,
+  count: 9
+}
+
+result = Recollect::Hashie.get(user, 'id')
+-> 1
+
+result = Recollect::Hashie.get(user, 'schedule.all_day')
+-> true
+
+result = Recollect::Hashie.get(user, 'numbers')
+-> ['1', '2']
+
+result = Recollect::Hashie.get(user, 'numbers.0')
+-> 1
+
+result = Recollect::Hashie.get(user, 'numbers[0]')
+-> 1
+
+result = Recollect::Hashie.get(user, 'numbers[0][1]')
+
+result = Recollect::Hashie.get(user, 'numbers.[0].[1]')
+```
+
+### Recollect::Array.pluck(array, path)
+
+```ruby
+users = [
+  {
+    id: 1,
+    name: 'Test #1',
+    email: 'test1@email1.com',
+    schedule: { all_day: true },
+    numbers: %w[1 2],
+    active: true,
+    count: 9
+  },
+  {
+    id: 2,
+    name: 'Test #1',
+    email: 'test1@email1.com',
+    schedule: { all_day: true },
+    numbers: %w[1 2],
+    active: true,
+    count: 9
+  }
+]
+
+result = Recollect::Array.pluck(users, 'id')
+$ -> [1, 2]
+
+result = Recollect::Array.pluck(users, 'schedule.all_day')
+$ -> [true, true]
+```
+
+[⬆️ &nbsp;Back to Top](#table-of-contents-)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/thadeu/recollect-array. 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/thadeu/recollect-array/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--display-cop-names']
+end
+
+task default: %i(spec rubocop)

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'recollect'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/recollect/array/filterable.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Recollect
+  module Array
+    class Filterable
+      def self.call(data, filters)
+        instance = new(data, filters)
+        instance.call!
+        instance
+      end
+
+      # Available filter
+      attr_accessor :filters
+
+      attr_reader :result
+
+      def initialize(data, filters)
+        @result = Array(data)
+        @filters = filters
+      end
+      private_class_method :new
+
+      def call!
+        @filters.each(&__apply_filter_callback)
+      end
+
+      def __apply_filter_callback
+        lambda do |target|
+          key, value = target
+
+          case value
+          when ::Hash
+            value.each do |predicate, item_value|
+              klass = Predicate.call(predicate)
+
+              @result.filter! do |item|
+                case item_value
+                when Proc, Module
+                  klass.check!(item, key, item_value.call)
+                else
+                  klass.check!(item, key, item_value)
+                end
+              end
+            end
+          else
+            parts = key.to_s.split('_')
+            predicate = parts.pop
+            iteratee = parts.join('_')
+            klass = Predicate.call(predicate)
+
+            next unless !!klass
+
+            @result.filter! do |item|
+              klass.check!(item, iteratee, value)
+            end
+          end
+        end
+      end
+      private :__apply_filter_callback
+    end
+
+    Predicate = lambda do |named|
+      {
+        eq: Equal, noteq: NotEqual, not_eq: NotEqual,
+        cont: Contains, notcont: NotContains, not_cont: NotContains,
+        lt: LessThan, lteq: LessThanEqual,
+        gt: GreaterThan, gteq: GreaterThanEqual,
+        start: Startify, notstart: NotStartify, not_start: NotStartify,
+        end: Endify, notend: NotEndify, not_end: NotEndify,
+        in: Included, notin: NotIncluded, not_in: NotIncluded
+      }[named.to_sym]
+    end
+    private_constant :Predicate
+  end
+end

data/lib/recollect/array/hashie.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Recollect::Array
+  module Hashie
+    # ### Hash.get
+    # `fetch value into hash, like Lodash.get`
+    #
+    # ````
+    # hash = { a: 1, b: { c: 2 }, d: ['1'] }
+    # Recollect::Hash.get(hash, :b, :c)
+    # ````
+    #
+    # ````
+    # hash = { a: 1, b: { c: 2 }, d: ['1'] }
+    # Recollect::Hash.get(hash, 'd.0')
+    # ````
+    #
+    # ````
+    # hash = { a: 1, b: { c: 2 }, d: [{ e: 3 }] }
+    # Recollect::Hash.get(hash, 'd.0.e')
+    # ````
+    def self.get(data, *keys)
+      Utility::TryFetchOrBlank.call(data, *keys)
+    end
+  end
+end

data/lib/recollect/array/predicate/contains.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Recollect::Array
+  module Contains
+    def self.check!(item, iteratee, value)
+      fetched_value = Utility::TryFetchOrBlank[item, iteratee]
+      return false unless fetched_value
+
+      Array(value).any? { |v| fetched_value.to_s.match(/#{v}/) }
+    end
+  end
+
+  module NotContains
+    def self.check!(item, iteratee, value)
+      !Contains.check!(item, iteratee, value)
+    end
+  end
+end

data/lib/recollect/array/predicate/endify.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Recollect::Array
+  module Endify
+    def self.check!(item, iteratee, value)
+      fetched_value = Utility::TryFetchOrBlank[item, iteratee]
+      return false unless fetched_value
+
+      regex = /#{value}$/
+      fetched_value.to_s.match?(regex)
+    end
+  end
+
+  module NotEndify
+    def self.check!(item, iteratee, value)
+      !Endify.check!(item, iteratee, value)
+    end
+  end
+end

data/lib/recollect/array/predicate/equal.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Recollect::Array
+  module Equal
+    def self.check!(item, iteratee, expected_value)
+      expected_value == Utility::TryFetchOrBlank[item, iteratee]
+    end
+  end
+
+  module NotEqual
+    def self.check!(item, iteratee, value)
+      !Equal.check!(item, iteratee, value)
+    end
+  end
+end

data/lib/recollect/array/predicate/greater_than.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Recollect::Array
+  module GreaterThan
+    def self.check!(item, iteratee, value)
+      fetched_value = Utility::TryFetchOrBlank[item, iteratee]
+      return false unless fetched_value
+
+      fetched_value > value
+    end
+  end
+
+  module GreaterThanEqual
+    def self.check!(item, iteratee, value)
+      fetched_value = Utility::TryFetchOrBlank[item, iteratee]
+      return false unless fetched_value
+
+      fetched_value >= value
+    end
+  end
+end

data/lib/recollect/array/predicate/in.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Recollect::Array
+  module Included
+    def self.check!(item, iteratee, value)
+      fetched_value = Array(Utility::TryFetchOrBlank[item, iteratee]).compact
+      return false unless Array(fetched_value).count > 0
+
+      fetched_value.any? do |expected_value|
+        Array(value).include?(expected_value)
+      end
+    end
+  end
+
+  module NotIncluded
+    def self.check!(item, iteratee, value)
+      !Included.check!(item, iteratee, value)
+    end
+  end
+end

data/lib/recollect/array/predicate/less_than.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Recollect::Array
+  module LessThan
+    def self.check!(item, iteratee, value)
+      fetched_value = Utility::TryFetchOrBlank[item, iteratee]
+      return false unless fetched_value
+
+      fetched_value < value
+    end
+  end
+
+  module LessThanEqual
+    def self.check!(item, iteratee, value)
+      fetched_value = Utility::TryFetchOrBlank[item, iteratee]
+      return false unless fetched_value
+
+      fetched_value <= value
+    end
+  end
+end

data/lib/recollect/array/predicate/startify.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Recollect::Array
+  module Startify
+    def self.check!(item, iteratee, value)
+      fetched_value = Utility::TryFetchOrBlank[item, iteratee]
+      return false unless fetched_value
+
+      regex = /^#{value}/
+      fetched_value.to_s.match?(regex)
+    end
+  end
+
+  module NotStartify
+    def self.check!(item, iteratee, value)
+      !Startify.check!(item, iteratee, value)
+    end
+  end
+end

data/lib/recollect/array/utility.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Recollect::Array
+  module Utility
+    module Keys
+      extend self
+
+      DELIMITER_REGEX = /\[|\]|\./
+
+      def to_ary(key)
+        return [] if key.empty?
+
+        key.to_s.split(DELIMITER_REGEX).reject(&:empty?)
+      end
+      alias [] to_ary
+
+      def to_dig(key)
+        enforce_level = ->(level) do
+          if level.is_a?(Integer) || level.match?(/^\d$/)
+            level.to_i
+          else
+            level.to_sym
+          end
+        end
+
+        Keys[key].map(&enforce_level)
+      end
+    end
+
+    # ### Utility::TryFetchOrBlank
+    # `fetch value into hash, like Lodash.get`
+    #
+    # ````
+    # hash = { a: 1, b: { c: 2 }, d: ['1'] }
+    # Utility::TryFetchOrBlank.call(hash, :b, :c)
+    # ````
+    #
+    # ````
+    # hash = { a: 1, b: { c: 2 }, d: ['1'] }
+    # Utility::TryFetchOrBlank[hash, 'd.0']
+    # ````
+    #
+    # ````
+    # hash = { a: 1, b: { c: 2 }, d: [{ e: 3 }] }
+    # Utility::TryFetchOrBlank.(hash, 'd.0.e')
+
+    # hash = { a: 1, b: { c: 2 }, d: [{ e: 3 }] }
+    # Utility::TryFetchOrBlank.(hash, 'd[0]e')
+
+    # hash = { a: 1, b: { c: 2 }, d: [{ e: 3 }] }
+    # Utility::TryFetchOrBlank.(hash, 'd.[0].e')
+    # ````
+    TryFetchOrBlank = ->(data, *keys) do
+      reducer = ->(memo, key) do
+        memo.to_h.dig(*Keys.to_dig(key))
+      rescue StandardError
+        nil
+      end
+
+      keys.reduce(data, &reducer)
+    end
+  end
+end

data/lib/recollect/array/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Recollect
+  module Array
+    VERSION = '0.1.0'
+  end
+end

data/lib/recollect/array.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+
+module Recollect
+  module Array
+    require_relative 'array/utility'
+    require_relative 'array/hashie'
+    require_relative 'array/predicate/startify'
+    require_relative 'array/predicate/endify'
+    require_relative 'array/predicate/equal'
+    require_relative 'array/predicate/contains'
+    require_relative 'array/predicate/in'
+    require_relative 'array/predicate/less_than'
+    require_relative 'array/predicate/greater_than'
+    require_relative 'array/filterable'
+
+
+    # ### Array.filter
+    # `filter value into Array using conditions
+    #
+    # ````
+    # data = [{ a: 1, b: { c: 2 }, d: ['1'] }]
+    # filters = { a_eq: 1, 'b.c_eq': 2, d_in: ['1'] }
+    # Recollect::Array.filter(data, filters)
+    # ````
+    def self.filter(data, filters = {})
+      Filterable.call(data, filters)
+    end
+
+    # ### Array.pluck
+    # `fetch value into Array, like Lodash#pluck`
+    #
+    # ````
+    # data = [{ a: 1, b: { c: 2 }, d: ['1'] }]
+    # Recollect::Array.pluck(data, 'b.c')
+    # ````
+    def self.pluck(data, iteratee)
+      return [] unless data.any?
+
+      data.map { |item| Hashie.get(item, iteratee) }
+    end
+  end
+end

data/recollect-array.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'recollect/array/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'recollect-array'
+  spec.version       = Recollect::Array::VERSION
+  spec.authors       = ['Thadeu Esteves']
+  spec.email         = ['tadeuu@gmail.com']
+  spec.summary       = 'Simple wrapper to filter array using Ruby and simple predicate conditions'
+  spec.description   = 'Filter collections using predicates like Ransack gem.'
+  spec.homepage      = 'https://github.com/thadeu/recollect-array'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.required_ruby_version = '>= 2.5.8'
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'base_x', '~> 0.8.1'
+  spec.add_dependency 'rbnacl', '~> 7.0'
+  spec.add_development_dependency 'bundler', '>= 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.70'
+
+  # spec.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: recollect-array
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thadeu Esteves
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base_x
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: rbnacl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.70'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.70'
+description: Filter collections using predicates like Ransack gem.
+email:
+- tadeuu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".vscode/settings.json"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/recollect/array.rb
+- lib/recollect/array/filterable.rb
+- lib/recollect/array/hashie.rb
+- lib/recollect/array/predicate/contains.rb
+- lib/recollect/array/predicate/endify.rb
+- lib/recollect/array/predicate/equal.rb
+- lib/recollect/array/predicate/greater_than.rb
+- lib/recollect/array/predicate/in.rb
+- lib/recollect/array/predicate/less_than.rb
+- lib/recollect/array/predicate/startify.rb
+- lib/recollect/array/utility.rb
+- lib/recollect/array/version.rb
+- recollect-array.gemspec
+homepage: https://github.com/thadeu/recollect-array
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Simple wrapper to filter array using Ruby and simple predicate conditions
+test_files: []