yaaf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 897bfdef28cdce5ee405763d213d28c7b2e011a661c4a7106f52100786110f6d
+  data.tar.gz: 3bd98b7cc8a9fcd78e982844a311ea56b7dd1dacbebc0d8c3c0d5f879a1c13fd
+SHA512:
+  metadata.gz: f073c7fa7d30bd7bfdafd4169dedc1af11cb4ad186c22f25237011cd23a7f19e628c1d5a6ac33d4b2318456800398a65e039a0cc8d74b517194c3852716b545c
+  data.tar.gz: 94851b76f07a37e0c8f339e9e76e3a0576fadd0797ce0b5c53ddf307b9650016728e6ac99efb8adfcb1cf9857c0c14b851e66627159b7c1c36c3720887c1a0c1

data/.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: CI
+
+on: [push]
+
+jobs:
+  build:
+    if: "! contains(toJSON(github.event.commits.*.message), '[skip-ci]')"
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        gemfile: [rails_4.0.0.gemfile, rails_5.0.0.gemfile, rails_5.2.3.gemfile, rails_6.0.0.gemfile, rails_master.gemfile]
+        ruby_version: [2.4.x, 2.5.x, 2.6.x, 2.7.x]
+        exclude:
+          - gemfile: rails_master.gemfile
+            ruby_version: 2.4.x
+          - gemfile: rails_6.0.0.gemfile
+            ruby_version: 2.4.x
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup Ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+    - name: Update rubygems when testing with Ruby 2.4.x
+      if: startsWith(matrix.ruby_version, '2.4')
+      run: |
+        gem update --system --no-document
+    - name: Before build
+      run: |
+        sudo apt-get install libsqlite3-dev
+        curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+        chmod +x ./cc-test-reporter
+        ./cc-test-reporter before-build
+      env:
+        CC_TEST_REPORTER_ID: aff2c7b9e07e54d5fc9e5588d2e2a8bab4f69950d35000edc2b6250bbaba477d
+    - name: Build and test with Rake
+      run: |
+        gem install bundler:1.17.3
+        bundle _1.17.3_ update
+        bundle _1.17.3_ install --gemfile spec/gemfiles/${{ matrix.gemfile }} --jobs 4 --retry 3
+        bundle _1.17.3_ exec rake code_analysis
+        bundle _1.17.3_ exec rspec

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+.irb_history

data/.reek.yml

@@ -0,0 +1,128 @@
+detectors:
+  Attribute:
+    enabled: false
+    exclude: []
+  BooleanParameter:
+    enabled: true
+    exclude: []
+  ClassVariable:
+    enabled: false
+    exclude: []
+  ControlParameter:
+    enabled: true
+    exclude: []
+  DataClump:
+    enabled: true
+    exclude: []
+    max_copies: 2
+    min_clump_size: 2
+  DuplicateMethodCall:
+    enabled: true
+    exclude: []
+    max_calls: 1
+    allow_calls: []
+  FeatureEnvy:
+    enabled: true
+    exclude: []
+  InstanceVariableAssumption:
+    enabled: false
+  IrresponsibleModule:
+    enabled: false
+    exclude: []
+  LongParameterList:
+    enabled: true
+    exclude: []
+    max_params: 4
+    overrides:
+      initialize:
+        max_params: 5
+  LongYieldList:
+    enabled: true
+    exclude: []
+    max_params: 3
+  ManualDispatch:
+    enabled: true
+    exclude: []
+  MissingSafeMethod:
+    enabled: false
+    exclude: []
+  ModuleInitialize:
+    enabled: true
+    exclude: []
+  NestedIterators:
+    enabled: true
+    exclude: []
+    max_allowed_nesting: 2
+    ignore_iterators: []
+  NilCheck:
+    enabled: false
+    exclude: []
+  RepeatedConditional:
+    enabled: true
+    exclude: []
+    max_ifs: 3
+  SubclassedFromCoreClass:
+    enabled: true
+    exclude: []
+  TooManyConstants:
+    enabled: true
+    exclude: []
+    max_constants: 5
+  TooManyInstanceVariables:
+    enabled: true
+    exclude: []
+    max_instance_variables: 9
+  TooManyMethods:
+    enabled: true
+    exclude: []
+    max_methods: 25
+  TooManyStatements:
+    enabled: true
+    exclude:
+      - initialize
+    max_statements: 12
+  UncommunicativeMethodName:
+    enabled: true
+    exclude: []
+    reject:
+      - "/^[a-z]$/"
+      - "/[0-9]$/"
+      - "/[A-Z]/"
+    accept: []
+  UncommunicativeModuleName:
+    enabled: true
+    exclude: []
+    reject:
+      - "/^.$/"
+      - "/[0-9]$/"
+    accept:
+      - Inline::C
+      - "/V[0-9]/"
+  UncommunicativeParameterName:
+    enabled: true
+    exclude: []
+    reject:
+      - "/^.$/"
+      - "/[0-9]$/"
+      - "/[A-Z]/"
+    accept: []
+  UncommunicativeVariableName:
+    enabled: true
+    exclude:
+      - YAAF::Form#save_in_transaction
+    reject:
+      - "/^.$/"
+      - "/[0-9]$/"
+      - "/[A-Z]/"
+    accept:
+      - _
+  UnusedParameters:
+    enabled: true
+    exclude: []
+  UnusedPrivateMethod:
+    enabled: false
+  UtilityFunction:
+    enabled: false
+
+exclude_paths:
+  - config

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--order rand
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,85 @@
+Layout/LineLength:
+  Max: 100
+  # To make it possible to copy or click on URIs in the code, we allow lines
+  # containing a URI to be longer than Max.
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+
+Layout/SpaceBeforeFirstArg:
+  Exclude:
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - spec/**/*
+
+Lint/RescueException:
+  Exclude:
+    - lib/yaaf/form.rb
+
+Metrics/AbcSize:
+  # The ABC size is a calculated magnitude, so this number can be an Integer or
+  # a Float.
+  Max: 15
+
+Metrics/BlockLength:
+  CountComments: false  # count full line comments?
+  Max: 25
+  Exclude:
+    - 'yaaf.gemspec'
+    - config/**/*
+    - spec/**/*
+  ExcludedMethods:
+    - class_methods
+
+Metrics/BlockNesting:
+  Max: 4
+
+Metrics/ClassLength:
+  CountComments: false  # count full line comments?
+  Max: 200
+
+# Avoid complex methods.
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 24
+
+Metrics/ModuleLength:
+  CountComments: false  # count full line comments?
+  Max: 200
+
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: true
+
+Metrics/PerceivedComplexity:
+  Max: 12
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/RescueModifier:
+  Exclude:
+    - spec/**/*
+
+Naming/PredicateName:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.7.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at juan.ramallo[at]rootstrap.com or santiago.bartesaghi[at]rootstrap.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,42 @@
+## Contributing ##
+
+You can contribute to this repo if you have an issue, found a bug or think there's some functionality required that would add value to the gem. To do so, please check if there's not already an [issue](https://github.com/rootstrap/yaaf/issues) for that, if you find there's not, create a new one with as much detail as possible.
+
+If you want to contribute with code as well, please follow the next steps:
+
+1. Read, understand and agree to our [code of conduct](https://github.com/rootstrap/yaaf/blob/master/CODE_OF_CONDUCT.md)
+2. [Fork the repo](https://help.github.com/articles/about-forks/)
+3. Clone the project into your machine:
+`$ git clone git@github.com:rootstrap/yaaf.git`
+4. Access the repo:
+`$ cd yaaf`
+5. Create your feature/bugfix branch:
+`$ git checkout -b your_new_feature`
+or
+`$ git checkout -b fix/your_fix` in case of a bug fix
+(if your PR is to address an existing issue, it would be good to name the branch after the issue, for example: if you are trying to solve issue 182, then a good idea for the branch name would be `182_your_new_feature`)
+6. Write tests for your changes (feature/bug)
+7. Code your (feature/bugfix)
+8. Run the code analysis tool by doing:
+`$ rake code_analysis`
+9. Run the tests:
+`$ bundle exec rspec`
+All tests must pass. If all tests (both code analysis and rspec) do pass, then you are ready to go to the next step:
+10. Commit your changes:
+`$ git commit -m 'Your feature or bugfix title'`
+11. Push to the branch `$ git push origin your_new_feature`
+12. Create a new [pull request](https://help.github.com/articles/creating-a-pull-request/)
+
+Some helpful guides that will help you know how we work:
+1. [Code review](https://github.com/rootstrap/tech-guides/tree/master/code-review)
+2. [GIT workflow](https://github.com/rootstrap/tech-guides/tree/master/git)
+3. [Ruby style guide](https://github.com/rootstrap/tech-guides/tree/master/ruby)
+4. [Rails style guide](https://github.com/rootstrap/tech-guides/blob/master/ruby/rails.md)
+5. [RSpec style guide](https://github.com/rootstrap/tech-guides/blob/master/ruby/rspec/README.md)
+
+For more information or guides like the ones mentioned above, please check our [tech guides](https://github.com/rootstrap/tech-guides). Keep in mind that the more you know about these guides, the easier it will be for your code to get approved and merged.
+
+Note: We work with one commit per pull request, so if you make your commit and realize you were missing something or want to add something more to it, don't create a new commit with the changes, but use `$ git commit --amend` instead. This same principle also applies for when changes are requested on an open pull request.
+
+
+Thank you very much for your time and for considering helping in this project.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Rootstrap
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,272 @@
+# YAAF
+
+![CI](https://github.com/rootstrap/yaaf/workflows/CI/badge.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/c3dea064e1003b700260/maintainability)](https://codeclimate.com/github/rootstrap/yaaf/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/c3dea064e1003b700260/test_coverage)](https://codeclimate.com/github/rootstrap/yaaf/test_coverage)
+
+YAAF (Yet Another Active Form) is a gem that let you create form objects in an easy and Rails friendly way. It makes use of `ActiveRecord` and `ActiveModel` features in order to provide you with a form object that behaves pretty much like a Rails model, and still be completely configurable.
+
+We were going to name this gem `ActiveForm` to follow Rails naming conventions but given there are a lot of form object gems named like that we preferred to go with `YAAF`.
+
+## Table of Contents
+
+- [Motivation](#motivation)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Setting up a form object](#setting-up-a-form-object)
+  - [#initialize](#initialize)
+  - [#valid?](#valid?)
+  - [#invalid?](#invalid?)
+  - [#errors](#errors)
+  - [#save](#save)
+  - [#save!](#save!)
+  - [Validations](#validations)
+  - [Callbacks](#callbacks)
+- [Sample app](#sample-app)
+- [Links](#links)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+- [Code of Conduct](#code-of-conduct)
+- [Credits](#credits)
+
+## Motivation
+
+Form Objects is a design pattern that allows us to:
+1. Keep views, models and controllers clean
+2. Create/update multiple models at the same time
+3. Keep business logic validations out of models
+
+There are some other form objects gems but we felt none of them provided us all the features that we expected:
+1. Form objects that behaves like Rails models
+2. Simple to use and to understand the implementation (no magic)
+3. Easy to customize
+4. Gem is well tested and maintained
+
+For this reason we decided to build our own Form Object implementation. After several months in production without issues we decided to extract it into a gem to share it with the community.
+
+If you want to learn more about Form Objects you can check out [these great articles](#links).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yaaf'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install yaaf
+
+## Usage
+
+In the following sections we explain some basic usage and the API provided by the gem. You can also find some recipes [here](https://rootstrap.github.io/yaaf).
+
+### Setting up a form object
+
+In order to use a `YAAF` form object, you need to inherit from `YAAF::Form` and define the `@models` of the form, for example:
+```ruby
+# app/forms/registration_form.rb
+
+class RegistrationForm < YAAF::Form
+  attr_accessor :user_attributes
+
+  def initialize(attributes)
+    super(attributes)
+    @models = [user]
+  end
+
+  def user
+    @user ||= User.new(user_attributes)
+  end
+end
+```
+
+By doing that you can work with your form object in your controller such as you'd do with a model.
+```ruby
+# app/controllers/registrations_controller.rb
+
+class RegistrationsController < ApplicationController
+  def create
+    registration_form = RegistrationForm.new(user_attributes: user_params)
+
+    if registration_form.save
+      redirect_to registration.user
+    else
+      render :new
+    end
+  end
+
+  private
+
+  def user_params
+    params.require(:user).permit(:email, :password, :password_confirmation)
+  end
+end
+```
+
+Form objects supports calls to [valid?](#valid?), [invalid?](#invalid?), [errors](#errors), [save](#save), [save!](#save!), such as any `ActiveModel` model. The return values match the corresponding `ActiveModel` methods.
+
+When saving or validating a form object, it will automatically validate all its models and promote the error to the form object itself, so they are accessible to you directly from the form object.
+
+Form objects can also define validations like:
+```ruby
+# app/forms/registration_form.rb
+
+class RegistrationForm < YAAF::Form
+  validates :phone, presence: true
+  validate :a_custom_validation
+
+  # ...
+
+  def a_custom_validation
+    # ...
+  end
+end
+```
+
+Validations can be skipped the same way as for `ActiveModel` models:
+```ruby
+# app/controllers/registrations_controller.rb
+
+class RegistrationsController < ApplicationController
+  def create
+    registration_form = RegistrationForm.new(user_attributes: user_params)
+
+    registration_form.save!(validate: false)
+  end
+
+  private
+
+  def user_params
+    params.require(:user).permit(:email, :password, :password_confirmation)
+  end
+end
+```
+
+Form objects support the saving of multiple models at the same time, to prevent leaving the system in a bad state all the models are saved within a DB transaction.
+
+A good practice would be to create an empty `ApplicationForm` and make your form objects inherit from it. This way you have a centralized place to customize any `YAAF` default behavior you would like.
+
+```ruby
+class ApplicationForm < YAAF::Form
+  # Customized behavior
+end
+```
+
+### #initialize
+
+The `.new` method should be called with the arguments that the form object needs.
+
+When initializing a `YAAF` form object, there are two things to keep in mind
+1. You need to define the `@models` instance variables to be an array of all the models that you want to be validated/saved within the form object.
+2. To leverage `ActiveModel`'s features, you can call `super` to automatically make the attributes be stored in instance variables. If you use it, make sure to also add `attr_accessor`s, otherwise `ActiveModel` will fail.
+
+### #valid?
+
+The `#valid?` method will perform both the form object validations and the models validations. It will return `true` or `false` and store the errors in the form object.
+
+By default `YAAF` form objects will store model errors in the form object under the same key. For example if a model has an `email` attribute that had an error, the form object will provide an error under the `email` key (e.g. `form_object.errors[:email]`).
+
+### #invalid?
+
+The `#invalid?` method is exactly the same as the `.valid?` method but will return the opposite boolean value.
+
+### #errors
+
+The `#errors` method will return an `ActiveModel::Errors` object such as any other `ActiveModel` model.
+
+### #save
+
+The `#save` method will run validations. If it's invalid it will return `false`, otherwise it will save all the models within a DB transaction and return `true`.
+
+Defined callbacks will be called in the following order:
+- `before_validation`
+- `after_validation`
+- `before_save`
+- `after_save`
+- `after_commit/after_rollback`
+
+Options:
+- If `validate: false` is send as options to the `save` call, it will skip validations.
+
+### #save!
+
+The `#save!` method is exactly the same as the `.save` method, just that if it is invalid it will raise an exception.
+
+### Validations
+
+`YAAF` form objects support validations the same way as `ActiveModel` models. For example:
+
+```ruby
+class RegistrationForm < YAAF::Form
+  validates :email, presence: true
+  validate :some_custom_validation
+
+  # ...
+end
+```
+
+### Callbacks
+
+`YAAF` form objects support validations the same way as `ActiveModel` models. For example:
+
+```ruby
+class RegistrationForm < YAAF::Form
+  before_validation :normalize_attributes
+  after_commit :send_confirmation_email
+
+  # ...
+end
+```
+
+Available callbacks are (listed in execution order):
+- `before_validation`
+- `after_validation`
+- `before_save`
+- `after_save`
+- `after_commit/after_rollback`
+
+## Sample app
+
+You can find a sample app making use of the gem [here](https://yaaf-examples.herokuapp.com). Its code is also open source, and you can find it [here](https://github.com/rootstrap/yaaf-examples).
+
+## Links
+
+- [How to improve maintainability in Rails applications using patterns. Part I](https://www.rootstrap.com/blog/2020/02/14/how-to-improve-maintainability-in-rails-applications-using-patterns-part-i/)
+- [7 Patterns to Refactor Fat ActiveRecord Models](https://codeclimate.com/blog/7-ways-to-decompose-fat-activerecord-models/)
+- [ActiveModel Form Objects](https://thoughtbot.com/blog/activemodel-form-objects)
+- [Form Objects Design Pattern](https://gorails.com/episodes/form-objects-design-pattern)
+- [Form Object from Railscasts](https://makandracards.com/alexander-m/42271-form-object-from-railscasts)
+- [Validating Form Objects](https://revs.runtime-revolution.com/validating-form-objects-8058fefc7b89)
+- [Disciplined Rails: Form Object Techniques & Patterns — Part 1](https://medium.com/@jaryl/disciplined-rails-form-object-techniques-patterns-part-1-23cfffcaf429)
+- [Complex form objects with Rails](https://www.codementor.io/@victor_hazbun/complex-form-objects-in-rails-qval6b8kt)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` 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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rootstrap/yaaf. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/rootstrap/yaaf/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the YAAF project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rootstrap/yaaf/blob/master/CODE_OF_CONDUCT.md).
+
+## Credits
+
+YAAF is maintained by [Rootstrap](http://www.rootstrap.com) with the help of our [contributors](https://github.com/rootstrap/yaaf/contributors).
+
+[<img src="https://s3-us-west-1.amazonaws.com/rootstrap.com/img/rs.png" width="100"/>](http://www.rootstrap.com)

data/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+task :code_analysis do
+  sh 'bundle exec rubocop lib spec'
+  sh 'bundle exec reek lib'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'yaaf'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docs/README.md

@@ -0,0 +1,15 @@
+# 📖 Documentation
+
+## Usage
+
+[Check usage section in the main README](https://github.com/rootstrap/yaaf/blob/master/README.md#usage)
+
+## Recipes
+
+- [YAAF with Simple Form](recipes/simple_form.md)
+
+## Credits
+
+YAAF is maintained by [Rootstrap](http://www.rootstrap.com) with the help of our [contributors](https://github.com/rootstrap/yaaf/contributors).
+
+[<img src="https://s3-us-west-1.amazonaws.com/rootstrap.com/img/rs.png" width="100"/>](http://www.rootstrap.com)

data/docs/recipes/simple_form.md

@@ -0,0 +1,117 @@
+# Using YAAF with Simple Form
+
+[Simple Form](https://github.com/heartcombo/simple_form) is a gem to create visual forms in an easy and flexible manner.
+
+## Usage
+
+Pass a `YAAF::Form` object instance to the `simple_form_for` helper method.
+
+For example, in a library management system (a pretty miminal one), the form to create books will look like this:
+
+```ruby
+# app/forms/book_form.rb
+
+class BookForm < YAAF::Form
+  attr_accessor :name, :isbn
+
+  def initialize(attributes)
+    super(attributes)
+
+    @models = [book]
+  end
+
+  def book
+    @book ||= Book.new(name: name, isbn: isbn)
+  end
+end
+```
+
+
+```ruby
+# app/controllers/books_controller.rb
+
+class BooksController < ApplicationController
+  def new
+    @book = BookForm.new
+  end
+end
+```
+
+```erb
+<%# app/views/books/new.html.erb %>
+
+<%= simple_form_for(@book, method: :post, url: books_path) do |f| %>
+  <%= f.input :name %>
+  <%= f.input :isbn %>
+
+  <%= f.submit 'Create Book' %>
+<% end %>
+```
+
+## I18n
+
+In order to make use of translations correctly, we should pass an `as` value to the `simple_form_for` helper method.
+
+```erb
+<%# app/views/books/new.html.erb %>
+
+<%= simple_form_for(@book, as: :book, ...) do |f| %>
+  ...
+```
+
+So you now can write your translations as:
+
+```yaml
+# app/config/locales/simple_form.en.yml
+
+en:
+  simple_form:
+    ...
+
+    labels:
+      book:
+        name: Book Name
+        isbn: International Standard Book Number
+```
+
+When using the `f.submit` helper method from Simple Form, the method `model_name` will be used to display the
+button's text. If this is not defined it will display: "Create Book Form".
+You can use a translation directly in the view to avoid overriding this method.
+
+```ruby
+# app/forms/book_form.rb
+
+  ...
+
+  def model_name
+    Book.model_name
+  end
+
+  ...
+```
+
+More info about how Simple Form translates forms [here](https://github.com/heartcombo/simple_form#i18n).
+
+## Persisted?
+
+Define the `persisted?` method in your form object to let Simple Form know if the object is being created or upated.
+
+```ruby
+# app/forms/book_form.rb
+
+  ...
+
+  def persisted?
+    book.persisted? # Or you can directly make it return false
+  end
+
+  ...
+```
+
+## Got questions?
+
+Feel free to [create an issue](https://github.com/rootstrap/yaaf/issues) and we'll discuss about it.
+
+YAAF is maintained by [Rootstrap](http://www.rootstrap.com) with the help of our [contributors](https://github.com/rootstrap/yaaf/contributors).
+
+[<img src="https://s3-us-west-1.amazonaws.com/rootstrap.com/img/rs.png" width="100"/>](http://www.rootstrap.com)

data/lib/yaaf.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'active_model'
+require 'active_record'
+require 'yaaf/form'
+require 'yaaf/version'
+
+# Namespace for all objects in YAAF
+module YAAF
+end

data/lib/yaaf/form.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module YAAF
+  # Parent class for form objects
+  class Form
+    include ::ActiveModel::Model
+    include ::ActiveModel::Validations::Callbacks
+    include ::ActiveRecord::Transactions
+    define_model_callbacks :save
+
+    validate :validate_models
+
+    def save(options = {})
+      unless options[:validate] == false
+        return false if invalid?
+      end
+
+      run_callbacks :commit do
+        save_in_transaction(options)
+      end
+
+      true
+    end
+
+    def save!(options = {})
+      save(options) || raise(ActiveRecord::RecordNotSaved.new('Failed to save the form', self))
+    end
+
+    private
+
+    attr_accessor :models
+
+    def promote_errors(model)
+      model.errors.each do |attribute, message|
+        errors.add(attribute, message)
+      end
+    end
+
+    def save_in_transaction(options)
+      ::ActiveRecord::Base.transaction do
+        run_callbacks :save do
+          save_models(options)
+        end
+      end
+    rescue Exception => e
+      handle_transaction_rollback(e)
+    end
+
+    def save_models(options)
+      models.map { |model| model.save!(options) }
+    end
+
+    def validate_models
+      models.each do |model|
+        promote_errors(model) if model.invalid?
+      end
+    end
+
+    def handle_transaction_rollback(exception)
+      run_callbacks :rollback
+      raise exception
+    end
+  end
+end

data/lib/yaaf/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module YAAF
+  VERSION = '0.1.0'
+end

data/yaaf.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/yaaf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'yaaf'
+  spec.version       = YAAF::VERSION
+  spec.authors       = ['Juan Manuel Ramallo', 'Santiago Bartesaghi']
+  spec.email         = ['juan.ramallo@rootstrap.com']
+
+  spec.summary       = 'Easing the form object pattern in Rails applications.'
+  spec.homepage      = 'https://github.com/rootstrap/yaaf'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/rootstrap/yaaf'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # # Production dependencies
+  spec.add_dependency 'activemodel', ['>= 4', '< 7']
+  spec.add_dependency 'activerecord', ['>= 4', '< 7']
+
+  spec.add_development_dependency 'database_cleaner-active_record', '~> 1.8.0'
+  spec.add_development_dependency 'rake', '~> 13.0.1'
+  spec.add_development_dependency 'reek', '~> 5.6.0'
+  spec.add_development_dependency 'rspec', '~> 3.9.0'
+  spec.add_development_dependency 'rubocop', '~> 0.80.0'
+  spec.add_development_dependency 'simplecov', '~> 0.17.1'
+  spec.add_development_dependency 'sqlite3', '~> 1.4.2'
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: yaaf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Juan Manuel Ramallo
+- Santiago Bartesaghi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.6.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+description: 
+email:
+- juan.ramallo@rootstrap.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".reek.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docs/README.md
+- docs/recipes/simple_form.md
+- lib/yaaf.rb
+- lib/yaaf/form.rb
+- lib/yaaf/version.rb
+- yaaf.gemspec
+homepage: https://github.com/rootstrap/yaaf
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rootstrap/yaaf
+  source_code_uri: https://github.com/rootstrap/yaaf
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Easing the form object pattern in Rails applications.
+test_files: []