Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/girishso/pluck_to_hash
Extend ActiveRecord pluck to return array of hashes
https://github.com/girishso/pluck_to_hash
activerecord hash pluck rails rails5 ruby ruby-gem rubygems sinatra
Last synced: about 22 hours ago
JSON representation
Extend ActiveRecord pluck to return array of hashes
- Host: GitHub
- URL: https://github.com/girishso/pluck_to_hash
- Owner: girishso
- License: mit
- Created: 2015-05-01T13:24:38.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-10-03T23:33:45.000Z (over 6 years ago)
- Last Synced: 2025-01-12T17:05:30.639Z (9 days ago)
- Topics: activerecord, hash, pluck, rails, rails5, ruby, ruby-gem, rubygems, sinatra
- Language: Ruby
- Homepage:
- Size: 41 KB
- Stars: 307
- Watchers: 7
- Forks: 26
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# What is that for?
Extends ActiveRecord by adding `pluck_to_hash` method that returns array of hashes instead of array of arrays. Useful when plucking multiple columns for rendering json or you need to access individual fields in your view for example.
Supports `pluck_to_struct` since version 0.3.0. `pluck_to_struct` returns an array of `struct`s.
[](http://badge.fury.io/rb/pluck_to_hash) [](https://travis-ci.org/girishso/pluck_to_hash)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'pluck_to_hash'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install pluck_to_hash
## Usage
Usage is similar to `ActiveRecord.pluck`, for example
```ruby
Post.limit(2).pluck_to_hash(:id, :title)
#
# [{:id=>213, :title=>"foo"}, {:id=>214, :title=>"bar"}]
#
Post.limit(2).pluck_to_hash(:id)
#
# [{:id=>213}, {:id=>214}]
#
```
Or use the shorter alias `pluck_h`
```ruby
Post.limit(2).pluck_h(:id)
#
# [{:id=>213}, {:id=>214}]
#
```
Supports `select` alias
```ruby
User.pluck_to_hash(:id, 'created_at::date as my_date', 'created_at::time as my_time')
#
# [{:id=>23, :my_date=>Fri, 11 Jul 2014, :my_time=>2000-01-01 07:54:36 UTC},
# {:id=>2, :my_date=>Tue, 01 Jul 2014, :my_time=>2000-01-01 14:36:15 UTC}]
#
```
Accepts `block` parameter
```ruby
User.pluck_to_hash(:id, :title) do |user_hash|
...
end
```
Allows specifying the type of hash. Defaults to HashWithIndifferentAccess
```ruby
User.pluck_to_hash(:id, :title, hash_type: CustomHash) do |custom_hash|
...
end
```
### Using `pluck_to_struct`
```ruby
posts = Post.limit(2).pluck_to_struct(:id, :title)
#
# [#, #]
#
posts.first.id
# 1
posts.first.title
# "foo"
```
or use the shorter alias `pluck_s`
```ruby
posts = Post.limit(2).pluck_s(:id, :title)
#
# [#, #]
#
```
Supports `block` parameter as well
```ruby
Post.limit(2).pluck_to_struct(:id, :title) do |post_struct|
puts post_struct.title
end
```
Allows specifying the type of struct. Defaults to standard Struct.
```ruby
Post.limit(2).pluck_to_struct(:id, :title, struct_type: OtherStructType) do |post_struct|
puts post_struct.title
end
```
## Using with Sinatra or other non-rails frameworks without ActiveSupport
Use version `0.1.4` that removes ActiveSupport dependency. `HashWithIndifferentAccess` is not used in that case.
## Why not `ActiveRecord.select` or `ActiveRecord.as_json`?
Here are results of "benchmark" tests performed on MacBook Air. Each method did 10 runs, rejected the 2 highest and 2 lowest times and average the remaining 6. Ran these tests on about 40,000 records. We notice that `pluck_to_hash` is almost 4x faster than `select` and about 8x faster than `as_json`. As with all the "benchmarks", you should take these results with a pinch of salt!
```ruby
# Node.pluck_h(:id, :title)
# Node.select(:id, :title).to_a
# Node.select(:id, :title).as_json
user system total real
pluck_to_hash 0.145000 0.005000 0.150000 ( 0.164836)
select 0.566667 0.010000 0.576667 ( 0.590911)
as_json 1.196667 0.010000 1.206667 ( 1.222286)
```
## Contributing
1. Fork it ( https://github.com/girishso/pluck_to_hash/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Licence
MIT License
Brought to you by: [Cube Root Software](http://www.cuberoot.in) © 2016