form_objects 1.0.0

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new('spec')
+
+task default: :spec

data/form_objects.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'form_objects/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "form_objects"
+  spec.version       = FormObjects::VERSION
+  spec.authors       = ["Piotr Nielacny", "Przemek Lusar"]
+  spec.email         = ["piotr.nielacny@gmail.com", "przemyslaw.lusar@gmail.com"]
+  spec.description   = %q{Micro library for creating and managing complex forms}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/lluzak/form_objects"
+  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"
+
+  spec.add_dependency "virtus", "~> 1.0"
+  spec.add_dependency "activemodel", ">= 3.2"
+  spec.add_dependency "activesupport", ">= 3.2"
+end

data/lib/form_objects/associated_validator.rb

@@ -0,0 +1,9 @@
+module FormObjects
+  class AssociatedValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, value)
+      if Array[value].flatten.reject { |r| r.valid? }.any?
+        record.errors.add(attribute, :invalid, options.merge(:value => value))
+      end
+    end
+  end
+end

data/lib/form_objects/base.rb

@@ -0,0 +1,33 @@
+module FormObjects
+  class Base
+    include Virtus.model
+    include Serializer
+    extend Nesting
+
+    if ActiveModel::VERSION::MAJOR > 3
+      include ActiveModel::Model
+    else
+      include ActiveModel::Validations
+      include ActiveModel::Conversion
+      extend ActiveModel::Naming
+    end
+
+    def as_json
+      to_hash.as_json
+    end
+
+    alias :update :attributes=
+
+    class << self
+      alias_method :field, :attribute
+    end
+
+    def persisted?
+      false
+    end
+
+    def self.validates_associated(*attr_names)
+      validates_with AssociatedValidator, _merge_attributes(attr_names)
+    end
+  end
+end

data/lib/form_objects/naming.rb

@@ -0,0 +1,13 @@
+require 'active_support/concern'
+
+module FormObjects
+  module Naming
+    extend ActiveSupport::Concern
+
+    included do
+      def self.model_name
+        @model_name ||= ActiveModel::Name.new(self, nil, self.name.gsub(/Form\Z/, ''))
+      end
+    end
+  end
+end

data/lib/form_objects/nesting.rb

@@ -0,0 +1,13 @@
+module FormObjects
+  module Nesting
+    def nested_form(attribute, form, options = {})
+      attribute(attribute, form, options)
+      validates_associated(attribute)
+      define_nested_writer_method(attribute)
+    end
+
+    def define_nested_writer_method(method_name)
+      alias_method :"#{method_name}_attributes=", :"#{method_name}="
+    end
+  end
+end

data/lib/form_objects/params_converter/collection_converter.rb

@@ -0,0 +1,51 @@
+module FormObjects
+  class ParamsConverter
+    class CollectionConverter
+      def initialize(params)
+        @params = params
+      end
+
+      def params
+        convert_attributes_to_array(@params)
+      end
+
+      def convert_attributes_to_array(object)
+        return object unless object.respond_to?(:each_pair)
+
+        object.inject({}) { |hash, attributes|
+          key, value = attributes.first, attributes.last
+          value      = value.to_a.sort.map { |attributes| attributes.last } if candidate_for_conversion?(key, value)
+          hash[key]  = convert_attributes_to_array(value)
+
+          hash
+        }
+      end
+
+      private
+
+      def candidate_for_conversion?(key, value)
+        attribute_key?(key) and value.is_a?(Hash) and incrementing_sequence?(value.keys)
+      rescue ArgumentError
+        false
+      end
+
+      def generate_sequence_from(keys)
+        keys.map { |key| Integer(key) }.sort
+      end
+
+      def sequence_to(max)
+        (0..max).to_a
+      end
+
+      def incrementing_sequence?(keys)
+        sequence = generate_sequence_from(keys)
+        sequence == sequence_to(sequence.max)
+      end
+
+      def attribute_key?(key)
+        key =~ /_attributes$/
+      end
+    end
+  end
+end
+

data/lib/form_objects/params_converter/date_converter.rb

@@ -0,0 +1,41 @@
+module FormObjects
+  class ParamsConverter
+    class DateConverter
+      DATE_ATTRIBUTES = /^(\w+)\(.i\)$/
+      DATE_FORMAT     = "%s.%s.%s %s:%s:%s".freeze
+
+      def initialize(params)
+        @params = params
+      end
+
+      def params
+        convert_attributes_to_date(@params)
+      end
+
+      def convert_attributes_to_date(object)
+        return object unless object.respond_to?(:each_pair)
+
+        object.inject({}) { |hash, attributes|
+          key, value      = attributes.first, attributes.last
+          attribute       = date_attribute_name_for(key)
+          hash[attribute] = DATE_FORMAT % date_values_for(key, object) if candidate_for_date_conversion?(key)
+          hash[key]       = convert_attributes_to_date(value)
+
+          hash
+        }
+      end
+
+      def date_attribute_name_for(key)
+        key[DATE_ATTRIBUTES, 1]
+      end
+
+      def date_values_for(key, object)
+        (1..6).map { |value| "#{object.delete("#{date_attribute_name_for(key)}(#{value}i)") { "00" }}" }
+      end
+
+      def candidate_for_date_conversion?(key)
+        date_attribute_name_for(key)
+      end
+    end
+  end
+end

data/lib/form_objects/params_converter.rb

@@ -0,0 +1,18 @@
+require 'active_support/core_ext/hash/indifferent_access'
+require 'form_objects/params_converter/date_converter'
+require 'form_objects/params_converter/collection_converter'
+
+module FormObjects
+  class ParamsConverter
+    def initialize(params)
+      @params = params
+    end
+
+    def params
+      params = CollectionConverter.new(@params).params
+      params = DateConverter.new(params).params
+
+      HashWithIndifferentAccess.new(params)
+    end
+  end
+end

data/lib/form_objects/serializer.rb

@@ -0,0 +1,18 @@
+module FormObjects
+  module Serializer
+
+    def serialized_attributes
+      (attributes || {}).inject({}) do |hash, (name, value)|
+        hash[name] = value.is_a?(Array) ? value.map { |item| serialize(item) } : serialize(value)
+        hash
+      end
+    end
+
+    private
+
+    def serialize(value)
+      value.respond_to?(:serialized_attributes) ? value.serialized_attributes : value
+    end
+
+  end
+end

data/lib/form_objects/version.rb

@@ -0,0 +1,3 @@
+module FormObjects
+  VERSION = "1.0.0"
+end

data/lib/form_objects.rb

@@ -0,0 +1,11 @@
+require "virtus"
+require "active_model"
+require "active_support/json"
+
+require "form_objects/version"
+require "form_objects/serializer"
+require "form_objects/associated_validator"
+require "form_objects/nesting"
+require "form_objects/naming"
+require "form_objects/base"
+require "form_objects/params_converter"

data/spec/base_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe FormObjects::Base do
+
+  describe "#validates_associated" do
+    let(:klass) do
+      Class.new(described_class) do
+        nested_form :addresses, AddressForm
+      end
+    end
+
+    it "creates validator instance inside #validators array" do
+      klass.validators.should_not be_empty
+    end
+
+    it "creates instance of AssociatedValidator" do
+      klass.validators.any? { |validator| validator.should be_kind_of(FormObjects::AssociatedValidator) }.should be_truthy
+    end
+  end
+
+  it 'includes Virtus Core module' do
+    described_class.included_modules.should include Virtus::Model::Core
+  end
+
+  it 'includes Serializer module ' do
+    described_class.included_modules.should include FormObjects::Serializer
+  end
+
+  describe 'when ActiveModel major version is above 3' do
+    it 'includes ActiveModel::Model module' do
+      described_class.included_modules.should include ActiveModel::Model
+    end
+  end
+
+  describe 'when ActiveModel major version is lower than or equal to 3' do
+
+    it 'includes ActiveModel Validations module'  do
+      described_class.included_modules.should include ActiveModel::Validations
+    end
+
+    it 'includes ActiveModel Conversion module'  do
+      described_class.included_modules.should include ActiveModel::Conversion
+    end
+
+    it 'extends itself by ActiveModel Naming module' do
+      described_class.singleton_class.included_modules.should include ActiveModel::Naming
+    end
+
+  end
+
+  describe '#persisted?' do
+    it 'always returns false' do
+      subject.persisted?.should == false
+    end
+  end
+
+  describe "#as_json" do
+    let(:form) do
+      Class.new(described_class) do
+        nested_form :addresses, Array[AddressForm]
+      end
+    end
+
+    subject { form.new(:addresses => [{ :street => "Kazimierza" } ]) }
+
+    it 'returns hash of nested forms' do
+      subject.as_json.should == { "addresses" => [ { "street" => "Kazimierza", "city" => nil }] }
+    end
+  end
+
+  describe "#update" do
+    let(:form) do
+      Class.new(described_class) do
+        attribute :addresses, Array[AddressForm]
+      end
+    end
+
+    subject { form.new }
+
+    it "updates attributes for addresses" do
+      subject.update(:addresses => [{ :street => "Kazimierza" }])
+      subject.addresses.first.street.should == "Kazimierza"
+    end
+  end
+
+  describe "#field" do
+    let(:form) do
+      Class.new(described_class) do
+        field :addresses, AddressForm
+      end
+    end
+
+    it 'setup attribute for form' do
+      form.new.should respond_to(:addresses)
+    end
+  end
+end

data/spec/naming_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe  FormObjects::Naming do
+  before do
+    Object.send(:remove_const, 'MessageForm')
+    load 'support/examples.rb'
+  end
+
+  describe '#model_name' do
+    it 'returns Message' do
+      MessageForm.model_name.to_s.should == 'Message'
+    end
+  end
+end

data/spec/nesting_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe FormObjects::Nesting do
+  before(:each) do
+    Object.send(:remove_const, 'UserForm')
+    load 'support/examples.rb'
+  end
+
+  it 'define #nested_form method' do
+    FormObjects::Base.methods.include?(:nested_form).should be_truthy
+  end
+
+  describe "#nested_form"
+    before do
+      UserForm.nested_form(:personal_info, PersonalInfoForm)
+    end
+
+    subject { UserForm.new }
+
+    it 'defined array attribute' do
+      subject.personal_info = PersonalInfoForm.new
+      subject.personal_info.should be_kind_of(PersonalInfoForm)
+    end
+
+    it 'defines writer method for attributes' do
+      subject.methods.include?(:personal_info_attributes=).should be_truthy
+    end
+  end
+
+  describe 'nested writer method' do
+    before do
+      UserForm.nested_form(:personal_info, PersonalInfoForm)
+      UserForm.nested_form(:addresses, Array[AddressForm])
+    end
+
+    let(:addresses_data) { [{street: 'Diagon Alley', city: 'London'}] }
+
+    subject { UserForm.new }
+
+    it 'can mass-assign attributes to PersonalInfoForm' do
+      subject.personal_info_attributes = { :first_name => "Piotr" }
+      subject.personal_info.first_name.should == "Piotr"
+    end
+
+    it '#*_attributes method should set data to corresponding object' do
+      subject.addresses_attributes = addresses_data
+      subject.addresses.map(&:attributes).should == addresses_data
+    end
+  end
+
+  describe 'validates nested forms' do
+    let(:address)           { AddressForm.new(city: 'London') }
+    let(:secondary_address) { AddressForm.new(street: 'Privet Drive', city: 'Little Whinging Alley') }
+    let(:personal_info)     { PersonalInfoForm.new(first_name: '', last_name: 'Granger') }
+
+    subject { UserForm.new }
+
+    before do
+      UserForm.clear_validators!
+      UserForm.nested_form(:addresses, Array[AddressForm])
+      UserForm.nested_form(:personal_info, PersonalInfoForm)
+
+      subject.addresses     = [address, secondary_address]
+      subject.personal_info = personal_info
+    end
+
+    it 'validate nested form' do
+      subject.personal_info = PersonalInfoForm.new
+      subject.valid?.should be_falsey
+
+      subject.personal_info.errors.messages.should include :first_name
+    end
+
+    it 'calls #valid? on each nested forms objects' do
+      address.should_receive(:valid?)
+      secondary_address.should_receive(:valid?)
+      personal_info.should_receive(:valid?)
+
+      subject.valid?
+    end
+
+    it 'add errors into parent object' do
+      subject.valid?
+
+      subject.errors.messages.should include :addresses
+      subject.errors.messages.should include :personal_info
+    end
+  end