README.md

Katagami

A toolkit for building Form object.

Installation

Add this line to your application's Gemfile:

gem 'katagami'

And then execute:

$ bundle

Or install it yourself as:

$ gem install katagami

Form field definitions

Katagami provides 3 way of form field definitions.

• Inherits attributes from an ActiveRecord model. (fields_for)
• Inherits spcific attributes from an ActiveRecord model. (field with a for: option)
• Define a field. (field with a Class as a field type)

Inherits attributes from an ActiveRecord model. (fields_for)

fields_for inherits model attributes as form fields and these validators (excludes id, created_at and updated_at.)

class User < ActiveRecord::Base
  # User has attributes 'id', 'name', 'email', 'created_at', 'updated_at'
  validates :name, presence: true
end

class UserForm
  include Katagami
  fields_for User
end

UserForm.field_names # => [:name, :email]
UserForm.validators[:name] # => [#<ActiveRecord::Validations::PresenceValidator:0x... @attributes=[:name], @options={}>]

fields_for provides only and excludes options.

class UserForm
  include Katagami
  fields_for User, only: :name
end

UserForm.field_names # => [:name]

class UserForm
  include Katagami
  fields_for User, excludes: :name
end

UserForm.field_names # => [:email]

Inherits spcific attributes from an ActiveRecord model. (field with a for: option)

syntax sugar of fields_for with only option.

class UserForm
  include Katagami
  field :name, :email, for: User
end
UserForm.field_names # => [:name, :email]

Define a field. (field with a Class as a field type)

class AuthForm
  include Katagami
  field :password, for: Auth
  field :password_confirm, String
end

Nested Form association

class ChildForm
  include Katagami
  field :name, String
  validates :name, presence: true
end

class ParentForm
  include Katagami
  field :name, String
  field :child, ChildForm, default: {}
  validates :name, presence: true
end

# associate fields
ParentForm.field_names # => [:name, { child: [:name] }]

# associate validation errors
form = ParentForm.new
form.valid? # => false
form.errors.messages
# => {name: ["can't be blank"], child: [{name: ["can't be blank"]}]}

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/hshimoyama/katagami.

License

The gem is available as open source under the terms of the MIT License.