rfo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 78405d779a711a4e000a04139452abf7c925e5dc
+  data.tar.gz: 9c068a61f479eb683c19d1252c645592a0ebbef6
+SHA512:
+  metadata.gz: d4a2951101ce4ae762accdb469a02a59aa27637a5777b0641fa13b6fc880e2bccba68ed049c13e685bcfd6a78035d200438733c444b696fe5e806e1b3b3e7df8
+  data.tar.gz: cda9e033aa33849d4d12dc5f26c7817b66e8edac28e4b7d66ea7a5dc98535e96ce595263503a1258c2f142012c5a64d4c9a0cededc868744cd42b7837b9a7f46

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rfo.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Piotr Gębala
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Piotr Gębala
+
+MIT License
+
+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,254 @@
+[![Code Climate](https://codeclimate.com/github/petergebala/rfo.png)](https://codeclimate.com/github/petergebala/rfo)
+# RFO - Rails Form Object
+
+Inspired by [7 Patterns to Refactor Fat ActiveRecord Models] (http://blog.codeclimate.com/blog/2012/10/17/7-ways-to-decompose-fat-activerecord-models/) and [SRP](http://en.wikipedia.org/wiki/Single_responsibility_principle)
+
+What it does?
++ simplify forms with multiple models - we do not have to use nested attributes
++ remove validations from models - they do too much already. What is more each form can have different validations.
++ can substitude strong parameters - we define exacly what and how we want to assign values in models
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rfo', github: 'petergebala/rfo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rfo # Not yet!
+
+## Usage
+It works great with [Draper](http://github.com/drapergem/draper) and [Simple  Form](https://github.com/plataformatec/simple_form)
+
+Define simple model with relations eventually callbacks:
+```ruby
+class Organisation < ActiveRecord::Base
+  WEBSITE_REGEXP = /[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?/ix
+  APPLY_FOR = [:under_2000, :over_2000]
+
+  belongs_to :grant, touch: true
+  has_one :address, as: :entity, dependent: :destroy
+  has_one :contact, as: :entity, dependent: :destroy
+  has_one :user, through: :grant
+
+  after_create :create_address
+  after_create :create_contact
+
+  delegate :postcode, to: :address
+end
+```
+
+Define form:
++ fields which you will use in form
++ validations for this form
++ default values
++ how and where it should assign values
+
+```ruby
+# app/forms/organisation_form.rb
+class OrganisationForm < RFO::Base
+  # About your organisation
+  attribute :amount_apply_for,  String
+  attribute :organisation_name, String
+  attribute :charity_number,    String
+
+  # Your address details
+  attribute :first_name,        String
+  attribute :last_name,         String
+  attribute :position,          String
+  attribute :address_line_1,    String
+  attribute :address_line_2,    String
+  attribute :address_line_3,    String
+  attribute :town,              String
+  attribute :county,            String
+  attribute :postcode,          String
+
+  # Your contact details
+  attribute :phone_number,      String
+  attribute :mobile_number,     String
+
+  # Your organisation
+  attribute :website,           String
+  attribute :description,       String
+
+  # Validations
+  validates :description,       presence: true, length: { maximum: 2000 }
+  validates :amount_apply_for,  presence: true, inclusion: { in: Organisation::APPLY_FOR.map(&:to_s) }
+  validates :organisation_name, presence: true, length: { maximum: 255 }
+  validates :first_name,        presence: true, length: { maximum: 255 }
+  validates :last_name,         presence: true, length: { maximum: 255 }
+  validates :address_line_1,    presence: true, length: { maximum: 255 }
+  validates :town,              presence: true, length: { maximum: 255 }
+  validates :postcode,          presence: true, length: { maximum: 10 },  format: { with: Address::POSTCODE_REGEXP }
+  validates :phone_number,      presence: true, length: { maximum: 20 },  format: { with: Contact::PHONE_NUMBER_REGEXP }
+  validates :mobile_number,                     length: { maximum: 20 },  format: { with: Contact::PHONE_NUMBER_REGEXP }, allow_blank: true
+  validates :website,                           length: { maximum: 255 }, format: { with: Organisation::WEBSITE_REGEXP }, allow_blank: true
+
+  private
+  def assign_defaults
+    @grant.current_step = :organisation_details
+
+    organisation_contact = @organisation.contact
+    organisation_address = @organisation.address
+    user_contact         = @organisation.user.contact
+    user_address         = @organisation.user.address
+
+    # Initialize with values from diffrent models
+    self.organisation_name ||= @organisation.name
+    self.first_name        ||= organisation_contact.first_name     || user_contact.first_name
+    self.last_name         ||= organisation_contact.last_name      || user_contact.last_name
+    self.position          ||= organisation_contact.position       || user_contact.position
+    self.phone_number      ||= organisation_contact.phone_number   || user_contact.phone_number
+    self.mobile_number     ||= organisation_contact.mobile_number  || user_contact.mobile_number
+    self.address_line_1    ||= organisation_address.address_line_1 || user_address.address_line_1
+    self.address_line_2    ||= organisation_address.address_line_2 || user_address.address_line_2
+    self.address_line_3    ||= organisation_address.address_line_3 || user_address.address_line_3
+    self.town              ||= organisation_address.town           || user_address.town
+    self.county            ||= organisation_address.county         || user_address.county
+    self.postcode          ||= organisation_address.postcode       || user_address.postcode
+  end
+
+  def persist!
+    ActiveRecord::Base.transaction do |t|
+      @organisation.name             = self.organisation_name
+      @organisation.amount_apply_for = self.amount_apply_for
+      @organisation.charity_number   = self.charity_number
+      @organisation.website          = self.website
+      @organisation.description      = self.description
+
+      @contact               = @organisation.contact
+      @contact.first_name    = self.first_name
+      @contact.last_name     = self.last_name
+      @contact.position      = self.position
+      @contact.phone_number  = self.phone_number
+      @contact.mobile_number = self.mobile_number
+
+      @address                = @organisation.address
+      @address.address_line_1 = self.address_line_1
+      @address.address_line_2 = self.address_line_2
+      @address.address_line_3 = self.address_line_3
+      @address.town           = self.town
+      @address.county         = self.county
+      @address.postcode       = self.postcode
+
+      @grant.current_step = @grant.next_step
+
+      @organisation.save!
+      @contact.save!
+      @address.save!
+      @grant.save!
+    end
+  end
+end
+```
+
+Define skinny controller:
+```ruby
+class OrganisationDetailsController < ApplicationController
+  before_filter :set_grant
+  respond_to :html
+
+  before_filter :set_organisation, only: [:edit, :update]
+
+  def edit ; end
+
+  def update
+    flash[:notice] = 'Organisation details saved!' if @organisation_form.update_attributes(organisations_params)
+    respond_with @organisation_form, location: @grant.current_path
+  end
+
+  private
+  def set_grant
+    @grant = current_user.grants.find(params[:grant_id]).decorate
+  end
+
+  def set_organisation
+    @organisation = @grant.organisation.decorate
+    @organisation_form = OrganisationForm.new(organisation: @organisation,
+                                              grant: @grant)
+  end
+
+  def organisations_params
+    params.require(:organisation_form).permit(:amount_apply_for,
+                                              :organisation_name,
+                                              :charity_number,
+                                              :first_name,
+                                              :last_name,
+                                              :position,
+                                              :address_line_1,
+                                              :address_line_2,
+                                              :address_line_3,
+                                              :town,
+                                              :county,
+                                              :postcode,
+                                              :phone_number,
+                                              :mobile_number,
+                                              :website,
+                                              :description)
+  end
+end
+```
+
+And clean view!
+```haml
+= simple_form_for @organisation_form, url: grant_organisation_details_path(@grant), method: :patch do |f|
+  = f.error_notification
+  h2 About Your Organisation
+  fieldset
+    = f.input :amount_apply_for,
+      collection: @organisation.amount_apply_for_buttons_for_views,
+      as: :radio_buttons,
+      wrapper: :bootstrap_group_horizontal
+    = f.input :organisation_name
+    = f.input :charity_number
+  h2 Your Address Details
+  fieldset
+    = f.input :first_name
+    = f.input :last_name
+    = f.input :position
+    = f.input :address_line_1
+    = f.input :address_line_2
+    = f.input :address_line_3
+    = f.input :town
+    = f.input :county
+    = f.input :postcode
+  h2 Your Contact Details
+  fieldset
+    = f.input :phone_number
+    = f.input :mobile_number
+  h2 Your Organisation
+  fieldset
+    = f.input :website, as: :addon, input_html: { addon_text: 'http://' }
+    = f.input :description, as: :text
+  h2 Proceed
+  fieldset
+    = f.button :submit
+```
+
+## Additional information
+
+Becasue Form Object is just plain ruby class you can: 
++ test it in simple way, 
++ share common code (like validations) between form objects, 
++ inherit between forms. 
+
+
+## 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
+
+## TODO:
+
+- turn off strong_parameters
+- write tests
+- correct documentation
+- update documentation with has_many relation and show how to remove nested_attributes

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rfo.rb

@@ -0,0 +1,8 @@
+require 'virtus'
+
+module RFO
+  # Your code goes here...
+end
+
+require 'rfo/base'
+require 'rfo/version'

data/lib/rfo/base.rb

@@ -0,0 +1,97 @@
+##
+# This is a main Form Object class
+class RFO::Base
+  include Virtus.model
+
+  if Rails.version > '4.1'
+    include ActiveModel::Model
+  else
+    extend ActiveModel::Naming
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+  end
+
+  ##
+  # Constructor:
+  # ==== Arguments
+  # * hash - where key is a name and value is an object. If key is an AR object or Draper object then key name will become instance variable with value defined in hash value.
+  #
+  # Run also +assign_defaults+ method to set default values
+  def initialize(*args)
+    options = args.extract_options!
+    options.each_pair do |name, obj|
+      next unless active_record_object?(obj)
+      instance_variable_set("@#{name}", obj)
+      super obj.attributes.symbolize_keys.slice(*self.attributes.keys)
+    end
+    assign_defaults
+  end
+
+  ##
+  # We can specify Form Object to act as some class
+  #
+  # ==== Example
+  #
+  # # Form Object
+  # class SomeForm < RFO::Base
+  #   model_class Foo
+  #
+  #   attribute :name, String
+  # end
+  #
+  # # In view we can use it to generate default paths in form.
+  # = simple_form_for @some_form do |f|
+  #  = f.input :name
+  #  = f.submit
+  #
+  def self.model_class(name)
+    @model_name = name || self
+  end
+
+  ##
+  # Required for defining paths in rails
+  #
+  def self.model_name
+    @model_name ||= self
+    ActiveModel::Name.new(@model_name, nil)
+  end
+
+  def persisted?
+    false
+  end
+
+  def save
+    if valid?
+      persist!
+    else
+      false
+    end
+  end
+
+  def update_attributes(attributes_hash)
+    self.attributes = attributes_hash
+    self.save
+  end
+
+  protected
+  ##
+  # Method which will be overwritten in subclasses
+  #
+  def assign_defaults
+  end
+
+  private
+  def active_record_object?(record)
+    # Pure AR Object
+    return true if pure_active_record?(record)
+
+    # Decorated Object
+    return true if record.respond_to?(:source) && pure_active_record?(record.source)
+
+    false
+  end
+
+  def pure_active_record?(record)
+    record.class.ancestors.include?(ActiveRecord::Base)
+  end
+end

data/lib/rfo/version.rb

@@ -0,0 +1,3 @@
+module RFO
+  VERSION = '0.0.1'
+end

data/rfo.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rfo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rfo"
+  spec.version       = RFO::VERSION
+  spec.authors       = ["Piotr Gębala", "Bartłomiej Oleszczyk"]
+  spec.email         = ["piotrek.gebala@gmail.com", "bart@primate.co.uk"]
+  spec.description   = %q{Rails Form Object}
+  spec.summary       = %q{Rails Form Object - additional layer between form and model}
+  spec.homepage      = "http://github.com/petergebala/rfo"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 0'
+  spec.add_runtime_dependency 'virtus', '~> 1.0'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: rfo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Piotr Gębala
+- Bartłomiej Oleszczyk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Rails Form Object
+email:
+- piotrek.gebala@gmail.com
+- bart@primate.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rfo.rb
+- lib/rfo/base.rb
+- lib/rfo/version.rb
+- rfo.gemspec
+homepage: http://github.com/petergebala/rfo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Rails Form Object - additional layer between form and model
+test_files: []
+has_rdoc: