README.md in active_enumerable-0.2.0 vs README.md in active_enumerable-1.0.0
- old
+ new
@@ -1,11 +1,12 @@
# ActiveEnumerable
[](https://travis-ci.org/zeisler/active_enumerable)
[](https://badge.fury.io/rb/active_enumerable)
-Include ActiveRecord like query methods to Ruby enumerable collections.
+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:
@@ -28,66 +29,71 @@
```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 > 1000 } }
- #=> <#Customers [{paid: true, credit: 1000}, {paid: false, credit: 2000}]>
-
+# => <#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.create({paid: true, credit: 1500}) # defaults to Hash creations
+#=> 3000
-Customers.item_class = Customer
+customers << { paid: true, credit: 1500 } # accepts Hashes
-customers.create({paid: true, credit: 1500}).to_a.last
- #=> <#Customer paid: true, credit: 1500>
-
+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.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: [...] }]
-
-people.where { has(:parents).of(age: 29, name: "Mom").and(age: 33, name: "Dad")
- #=> <#People [{ name: "Reuben", 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