# ActiveEnumerable

[![Build Status](https://travis-ci.org/zeisler/active_enumerable.svg?branch=master)](https://travis-ci.org/zeisler/active_enumerable)
[![Gem Version](https://badge.fury.io/rb/active_enumerable.svg)](https://badge.fury.io/rb/active_enumerable)

Provides ActiveRecord like query methods for use in Ruby Enumerable collections.
Use Hashes or custom Ruby Objects to represent records. 

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'active_enumerable'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install active_enumerable

## Usage

### ActiveRecord Like Querying

```ruby
require "active_enumerable"

class Customers
  include ActiveEnumerable

  scope :unpaid, -> { where(paid: false).or(credit: 0) }
end

customers = Customers.new([{paid: true, credit: 1000}, {paid: false, credit: 2000}, {paid: false, credit: 0}])

customers.unpaid
# => <#Customers [{:paid=>false, :credit=>2000}, {:paid=>false, :credit=>0}]]>

customers.scope { select { |y| y[:credit] >= 1000 } }
#=> <#Customers [{paid: true, credit: 1000}, {paid: false, credit: 2000}]>

customers.sum(:credit)
#=> 3000

customers << { paid: true, credit: 1500 } # accepts Hashes

class Customer
  attr_reader :paid, :credit
  def initialize(paid:, credit:)
    @paid  = paid
    @credit = credit
  end
end

customers << Customer.new(paid: true, credit: 1500) # Or Objects
```

### English Like DSL

```ruby
require "active_enumerable"

class People
  include ActiveEnumerable
  
  scope :unpaid, -> { where(paid: false).or(credit: 0) }
end

people = People.new([{ name: "Reuben" }, { name: "Naomi" }])
people.where { has(:name).of("Reuben") }
    #=> <#People [{ name: "Reuben" }]]
    
    
people = People.new( [
        { name: "Reuben", parents: [{ name: "Mom", age: 29 }, { name: "Dad", age: 33 }] },
        { name: "Naomi", parents: [{ name: "Mom", age: 29 }, { name: "Dad", age: 41 }] }
      ] )
      
people.where { has(:parents).of(age: 29, name: "Mom").or(age: 33, name: "Dad") } 
    #=>  <#People [{ name: "Reuben", parents: [...] }, { name: "Naomi", parents: [...] }]
```

## Development

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.

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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

This is a community project and commit access will be granted to those who show interest by having a history of acceptable pull-requests.

Bug reports and pull requests are welcome on GitHub at https://github.com/zeisler/active_enumerable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).