Form objects for rails build on top Active model
Heavily inspired by the rails-patterns
gem.
Add this line to your application's Gemfile:
gem 'formation'
And then execute:
$ bundle
Or install it yourself as:
$ gem install formation
class ProfileForm < Formation::Form
# define param_key. Default is the form name in our example it would be 'profile'
param_key "some_profile"
attribute :first_name
attribute :last_name
attribute :address1
attribute :address2
# you can set default values like so:
attribute :phone_number, default: '000-000-0000'
# using a proc
attribute :last_4, default: '4321'
private
def persist
model.update(attributes.except(:address1, :address2))
model.address.update(attributes.except(:first_name, :last_name))
end
end
# new
def new
@form = ProfileForm.new(model: User.new)
end
# create
def create
@form = ProfileForm.new(model: User.new, params: params[:profile])
end
# update
def update
@form = ProfileForm.new(model: User.find(params[:id]), params: params[:profile])
end
Simply run:
rails g formation:form optional_namespace/modelname attribute:type
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/jwald1/formation. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the Formation project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.