Skip to content

Latest commit

 

History

History
96 lines (68 loc) · 2.33 KB

README.md

File metadata and controls

96 lines (68 loc) · 2.33 KB

Build Status Code Climate Test Coverage Inline docs

ParamsFor

Use service objects and the power of ActiveModel::Validations to easy validate params in controller.

Installation

Add this line to your application's Gemfile:

gem 'params_for'

And then execute:

$ bundle

Or install it yourself as:

$ gem install params_for

Usage

In your controller:

# app/controllers/fancy_controller.rb

class FancyController < ApplicationController
  include ParamsFor::Connectors::Glue

  params_for :fancy, only: [:create]

  # Creates a Fancy object by checking and validating params
  # before that
  #
  def create
    ...
    @fancy = Fancy.new(fancy_params)
    ...
  end
end

Or you can play with it yourself

# app/controllers/fancy_controller.rb

class FancyController < ApplicationController
  include ParamsFor::Connectors::Glue

  # Creates a Fancy object by checking and validating params
  # before that
  #
  def create
    ...
    @fancy = Fancy.new(fancy_params)
    ...
  end

  protected

  # Strong params delegated to ParamsFor::Fancy
  # and memoized in @fancy_params var returned by this method
  #
  # @return [HashwithIndifferentAccess]
  def fancy_params
    params_for :fancy
  end
end

Some place in your application ( suggested app/validators/params_for/ )

  # app/validators/params_for/fancy.rb

  class ParamsFor::Fancy < ParamsFor::Base
    attr_accessor :user_id, :fancy_name, :fancy_description

    validates :user_id, :fancy_name, presence: true
    validates :user_id, integer: true
  end

Contributing

  1. Fork it ( https://github.com/[my-github-username]/params_for/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