basics.md

Creating the plucker and fetching basic data

Creating the plucker

You may use the Pluckers::Base class to pluck all the information you need:

Pluckers::Base.new(Model.scope, options)

You can use any ActiveRecord Relation. It means you can pluck any scope or collection just as you would use them in your Rails applications:

plucker = Pluckers::Base.new(BlogPost.published)
plucker = Pluckers::Base.new(Author.all)
plucker = Pluckers::Base.new(post.categories.published)

Once you have the plucker object you just... pluck.

plucker.pluck

If you don't select any columns the plucker will use the attributes method of the class to pluck all the attributes from the database.

Selecting columns

When you create the plucker you can configure some options to customize it.

First, you can choose which columns to pluck from the table, so you don't pluck 50 columns when you only need three of them. To do so you will use the attributes option.

Pluckers::Base.new(BlogPost.published, { attributes: [:title, :slug, :published_at] }).pluck

[
  { id: 33, title: "Lorem Ipsum", slug: 'lorem-ipsum', published_at: "2016-04-07"},
  { id: 34, title: "Lorem Ipsum 3", slug: 'lorem-ipsum-3', published_at: "2016-04-09"},
  { id: 35, title: "Lorem Ipsum 4", slug: 'lorem-ipsum-4', published_at: "2016-04-12"}
]

Of course, this will be done in just one query.

NEXT: How to use your plucker with your globalized methods