https://github.com/pinzolo/formup

Formup is rubygem for creating data model based form class.
https://github.com/pinzolo/formup

Last synced: 18 days ago
JSON representation

Formup is rubygem for creating data model based form class.

• Host: GitHub
• URL: https://github.com/pinzolo/formup
• Owner: pinzolo
• License: mit
• Created: 2013-07-22T02:17:47.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2014-09-24T06:48:07.000Z (about 10 years ago)
• Last Synced: 2024-03-14T23:06:53.508Z (8 months ago)
• Language: Ruby
• Homepage:
• Size: 363 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Formup

[![Build Status](https://secure.travis-ci.org/pinzolo/formup.png)](http://travis-ci.org/pinzolo/formup)

[![Coverage Status](https://coveralls.io/repos/pinzolo/formup/badge.png)](https://coveralls.io/r/pinzolo/formup)

[![Code Climate](https://codeclimate.com/github/pinzolo/formup.png)](https://codeclimate.com/github/pinzolo/formup)

Formup is rubygem for creating data model based form class.

Formup use activemodel gem.(>= 3.2.0)

You can get the benefits of ActiveModel.  ex) validations, application to `form_for` etc.

## Installation

Add this line to your application's Gemfile:

    gem 'formup'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install formup

## Usage

### Include Formup to your class.

```ruby

class SalesForm

  include Formup

  # define attributes (sales_id, sales_price, sales_tax)

  source :sales, :attributes => [:id, :price, :tax]

  # define attributes (customer_id, customer_name, contact)

  source :customer, :attributes => [:id, :name], :aliases => { :email => :contact }

  attr_accessor :items

  # Handle hash parameters that were not processed in initialize method.

  def handle_extra_params(params)

    self.items = {}

    params.each do |k, v|

      self.items[v] = params[k.to_s.gsub(/^code/, "count")] if k.to_s.match(/^code/)

    end

  end

end

```

### Initialize with hash parameters.(like ActiveRecord)

```ruby

# params => { :sales_id => 1, :sales_price => 1000, ... }

form = SalesForm.new(params)

```

### Load from hash and data model that have some accessor methods.

```ruby

form = SalesForm.new

sales = Sales.find(1)

form.load(:sales => sales, :customer => { :id => 1, :name => "John Doe", :email => "[email protected]"})

```

### Get parameters for data model by `params_for` method.

```ruby

form = SalesForm.new(params)

sales = Sales.new(form.params_for(:sales))

sales.save

```

## Contributing

1. Fork it

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 new Pull Request