# lazy_crud [![Join the chat at https://gitter.im/NullVoxPopuli/lazy_crud](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/NullVoxPopuli/lazy_crud?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Lazy way to implement common actions in controllers in Rails

[![docs](https://img.shields.io/badge/docs-yardoc-blue.svg?style=flat-square)](http://www.rubydoc.info/github/NullVoxPopuli/lazy_crud)
[![Gem Version](http://img.shields.io/gem/v/lazy_crud.svg?style=flat-square)](http://badge.fury.io/rb/lazy_crud)
[![Build Status](http://img.shields.io/travis/NullVoxPopuli/lazy_crud.svg?style=flat-square)](https://travis-ci.org/NullVoxPopuli/lazy_crud)
[![Code Climate](http://img.shields.io/codeclimate/github/NullVoxPopuli/lazy_crud.svg?style=flat-square)](https://codeclimate.com/github/NullVoxPopuli/lazy_crud)
[![Test Coverage](http://img.shields.io/codeclimate/coverage/github/NullVoxPopuli/lazy_crud.svg?style=flat-square)](https://codeclimate.com/github/NullVoxPopuli/lazy_crud)
[![Dependency Status](http://img.shields.io/gemnasium/NullVoxPopuli/lazy_crud.svg?style=flat-square)](https://gemnasium.com/NullVoxPopuli/lazy_crud)


## Features

 - Minimal Controller Coding
 - Resource Can be Scoped to Parent Resource
 - Uses the [responders](https://github.com/plataformatec/responders) gem
   - Enables i18n on flash messages
   - Defaultily enables html and json response types
     - Good for rails apps with an api and / or transitioning to a js framework
   - Responders is a great gem with lots of flexibility. Be sure to check it out.

## Installation

Gemfile

    gem 'lazy_crud'

Terminal

    gem install lazy_crud

## Configuration


### Basic setup

Include all of the basic actions, `create`, `edit`, `destroy`, etc

    class SomeObjectController < ApplicationController
      include LazyCrud

At a bare minimum, you'll need to specify the class the controller is acting upon.

      set_resource SomeObject


**Optional**

This is for in the case of you having nested routes, and want to scope
`SomeObject` to its parent object.

For example: `/event/:event_id/discounts/:id`
Event is the parent object and Discount is the resource

Note that there must be an `@event` instance variable set.
See specs for details.

      set_resource_parent Event

**Sort of Optional**

If you want to be able to update / create objects, you'll want to
specify what parameters are allowed to be set.
This uses strong parameters.

      set_param_whitelist(:name, :amount)

      # ... other controller stuff
    end


### CRUD-hooks

Sometimes you may want to manually assign attributes to an object before saving, such as current_user.

There are two ways to do this:

    def before_create
      @resource.user = current_user
    end

or if you are wanting to have ruby throw an error if you spelled something wrong

    before_create ->(resource){ resource.user = current_user }

the error thrown will be NoMethodError

Available CRUD-hooks are: `before_create`, `before_update`, `before_destroy`

Each hook can be called multiple times, and they will be invoked in the order they were defined. If the `def` method is used, it will be invoked last.

### Overridng

If you really don't want any default functionality, you can always override

    def index
      @raffles = @event.raffles.with_deleted
    end

## Contributing

1. Fork the project
2. Create a new, descriptively named branch
3. Add Test(s)!
4. Commit your proposed changes
5. Submit a pull request