Skip to content
Lazy way to implement common actions in controllers in Rails
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
spec
.codeclimate.yml
.gitignore
.travis.yml
Gemfile
Gemfile.lock
LICENSE
README.md
Rakefile
lazy_crud.gemspec

README.md

lazy_crud Join the chat at https://gitter.im/NullVoxPopuli/lazy_crud

Lazy way to implement common actions in controllers in Rails

docs Gem Version Build Status Code Climate Test Coverage Dependency Status

Features

  • Minimal Controller Coding
  • Resource Can be Scoped to Parent Resource
  • Uses the 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

To include all of the basic actions, create, edit, destroy, etc, just add include LazyCrud to any controller.

class SomeObjectsController < ApplicationController
  include LazyCrud

Just make sure the model SomeObject exists.

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

However, if you follow standard naming conventions, you can omit the above line and have a controller that looks like this:

Parent::ExamplesController < ApplicationController
    include LazyCrud

and the Parent class would be set as the resource parent.

Just make sure that a Parent has_many :examples

Note that if you use a namespace that isn't named after a model, the resource_parent will not be set. It will output to the debug log though, saying that the namespace doesn't match up with a model.

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)

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
You can’t perform that action at this time.