reform 0.1.2 → 0.2.0

data/test/active_model_test.rb

@@ -1,12 +1,84 @@
 require 'test_helper'
 
-class ActiveModelTest < MiniTest::Spec
+class NewActiveModelTest < MiniTest::Spec # TODO: move to test/rails/
+  class SongForm < Reform::Form
+    include Reform::Form::ActiveModel
+
+    property :name
+  end
+
+  let (:artist) { Artist.create(:name => "Frank Zappa") }
+  let (:form) { SongForm.new(artist) }
+
+  it { form.persisted?.must_equal true }
+  it { form.to_key.must_equal [artist.id] }
+  it { form.to_param.must_equal "#{artist.id}" }
+  it { form.to_model.must_equal form }
+  it { form.id.must_equal artist.id }
+
+  describe "::model_name" do
+    it { form.class.model_name.must_be_kind_of ActiveModel::Name }
+    it { form.class.model_name.to_s.must_equal "NewActiveModelTest::Song" }
+
+    let (:class_with_model) {
+      Class.new(Reform::Form) do
+        include Reform::Form::ActiveModel
+
+        model :album
+      end
+    }
+
+    it { class_with_model.model_name.must_be_kind_of ActiveModel::Name }
+    it { class_with_model.model_name.to_s.must_equal "Album" }
+  end
+end
+
+class FormBuilderCompatTest < MiniTest::Spec
+  let (:form_class) {
+    Class.new(Reform::Form) do
+      include Reform::Form::ActiveModel::FormBuilderMethods
+
+      property :artist do
+        property :name
+        validates :name, :presence => true
+      end
+
+      collection :songs do
+        property :title
+        validates :title, :presence => true
+      end
+    end
+  }
+  let (:form) { form_class.new(OpenStruct.new(:artist => Artist.new, :songs => [OpenStruct.new])) }
+# TODO: test when keys are missing!
+
+  it "respects _attributes params hash" do
+    form.validate("artist_attributes" => {"name" => "Blink 182"},
+      "songs_attributes" => {"0" => {"title" => "Damnit"}})
+
+    form.artist.name.must_equal "Blink 182"
+    form.songs.first.title.must_equal "Damnit"
+  end
+
+  it "defines _attributes= setter so Rails' FB works properly" do
+    form.must_respond_to("artist_attributes=")
+    form.must_respond_to("songs_attributes=")
+  end
+
+  it "returns flat errors hash" do
+    form.validate("artist_attributes" => {"name" => ""},
+      "songs_attributes" => {"0" => {"title" => ""}})
+    form.errors.messages.must_equal(:"artist.name" => ["can't be blank"], :"songs.title" => ["can't be blank"])
+  end
+end
+
+class ActiveModelWithCompositionTest < MiniTest::Spec
    class HitForm < Reform::Form
-    include DSL
+    include Composition
     include Reform::Form::ActiveModel
 
-    property  :title,  :on => :song
-    properties [:name, :genre],   :on => :artist
+    property  :title,           :on => :song
+    properties [:name, :genre], :on => :artist # we need to check both ::property and ::properties here!
 
     model :hit, :on => :song
   end
@@ -21,11 +93,11 @@ class ActiveModelTest < MiniTest::Spec
     end
 
     it "doesn't delegate when :on missing" do
-      class HitForm < Reform::Form
-        include DSL
+      class SongOnlyForm < Reform::Form
+        include Composition
         include Reform::Form::ActiveModel
 
-        property  :title,  :on => :song
+        property :title,  :on => :song
 
         model :song
       end.new(:song => rio, :artist => duran).song.must_equal rio
@@ -34,6 +106,7 @@ class ActiveModelTest < MiniTest::Spec
 
 
   it "creates composition readers" do
+    skip "we don't want those anymore since they don't represent the form internal state!"
     form.song.must_equal rio
     form.artist.must_equal duran
   end
@@ -55,12 +128,13 @@ class ActiveModelTest < MiniTest::Spec
   end
 
   it "provides #to_model" do
-    HitForm.new(:song => OpenStruct.new.instance_eval { def to_model; "yo!"; end; self }, :artist => OpenStruct.new).to_model.must_equal "yo!"
+    form = HitForm.new(:song => OpenStruct.new, :artist => OpenStruct.new)
+    form.to_model.must_equal form
   end
 
   it "works with any order of ::model and ::property" do
     class AnotherForm < Reform::Form
-      include DSL
+      include Composition
       include Reform::Form::ActiveModel
 
       model :song, :on => :song

data/test/coercion_test.rb

@@ -0,0 +1,26 @@
+require "test_helper"
+require "reform/form/coercion"
+
+class CoercionTest < MiniTest::Spec
+  it "allows coercion" do
+    form = Class.new(Reform::Form) do
+      include Reform::Form::Coercion
+
+      property :written_at, :type => DateTime
+    end.new(OpenStruct.new(:written_at => "31/03/1981"))
+
+    form.written_at.must_be_kind_of DateTime
+    form.written_at.must_equal DateTime.parse("Tue, 31 Mar 1981 00:00:00 +0000")
+  end
+
+  it "allows coercion in validate" do
+    form = Class.new(Reform::Form) do
+      include Reform::Form::Coercion
+
+      property :id, :type => Integer
+    end.new(OpenStruct.new())
+
+    form.validate("id" => "1")
+    form.to_hash.must_equal("id" => 1)
+  end
+end

data/test/composition_test.rb

@@ -0,0 +1,57 @@
+class CompositionTest < ReformSpec
+  class SongAndArtist < Reform::Composition
+    map({:artist => [:name], :song => [:title]}) #SongAndArtistMap.representable_attrs
+  end
+
+  let (:comp) { SongAndArtist.new(:artist => @artist=OpenStruct.new, :song => rio) }
+
+  it "delegates to models as defined" do
+    comp.name.must_equal nil
+    comp.title.must_equal "Rio"
+  end
+
+  it "raises when non-mapped property" do
+    assert_raises NoMethodError do
+      comp.raise_an_exception
+    end
+  end
+
+  it "creates readers to models" do
+    comp.song.object_id.must_equal rio.object_id
+    comp.artist.object_id.must_equal @artist.object_id
+  end
+
+  describe "::map_from" do
+    it "creates the same mapping" do
+      comp =
+      Class.new(Reform::Composition) do
+        map_from(
+          Class.new(Reform::Representer) do
+            property :name,  :on => :artist
+            property :title, :on => :song
+          end
+        )
+      end.
+      new(:artist => duran, :song => rio)
+
+      comp.name.must_equal "Duran Duran"
+      comp.title.must_equal "Rio"
+    end
+  end
+
+  describe "#nested_hash_for" do
+    it "returns nested hash" do
+      comp.nested_hash_for(:name => "Jimi Hendrix", :title => "Fire").must_equal({:artist=>{:name=>"Jimi Hendrix"}, :song=>{:title=>"Fire"}})
+    end
+
+    it "works with strings" do
+      comp.nested_hash_for("name" => "Jimi Hendrix", "title" => "Fire").must_equal({:artist=>{:name=>"Jimi Hendrix"}, :song=>{:title=>"Fire"}})
+    end
+
+    it "works with strings in map" do
+      Class.new(Reform::Composition) do
+        map(:artist => ["name"])
+      end.new([nil]).nested_hash_for(:name => "Jimi Hendrix").must_equal({:artist=>{:name=>"Jimi Hendrix"}})
+    end
+  end
+end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Rails::Application.load_tasks

data/test/dummy/app/controllers/albums_controller.rb

@@ -0,0 +1,18 @@
+class AlbumsController < ActionController::Base
+  def new
+    album = Album.new(:songs => [Song.new, Song.new])
+    @form = AlbumForm.new(album)
+  end
+
+  def create
+    album = Album.new(songs: [Song.new, Song.new])
+    @form = AlbumForm.new(album)
+
+    if @form.validate(params["album"])
+      @form.save
+      redirect_to album_path(album)
+    else
+      render :new
+    end
+  end
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,4 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+  layout 'application'
+end

data/test/dummy/app/controllers/musician_controller.rb

@@ -0,0 +1,5 @@
+class MusicianController < ActionController::Base
+  def index
+    render :text => Artist.find(:all)
+  end
+end

data/test/dummy/app/forms/album_form.rb

@@ -0,0 +1,18 @@
+class AlbumForm < Reform::Form # FIXME: sub forms don't inherit FBM.
+
+  model :album
+
+  property :title
+
+  collection :songs do
+    property :title
+    validates :title, presence: true
+  end
+
+  validates :title, presence: true
+
+  def save
+    super
+    model.save
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/album.rb

@@ -0,0 +1,4 @@
+class Album < ActiveRecord::Base
+  has_many :songs
+  has_and_belongs_to_many :artists
+end

data/test/dummy/app/models/song.rb

@@ -0,0 +1,3 @@
+class Song < ActiveRecord::Base
+  belongs_to :album
+end

data/test/dummy/app/views/albums/new.html.erb

@@ -0,0 +1,28 @@
+New Album
+
+<%= form_for @form do |f| %>
+  <% if @form.errors.any? %>
+    <div>
+      <h3><%= pluralize(@form.errors.count, "error") %> prohibited this form from being saved:</h3>
+
+      <ul>
+        <% @form.errors.full_messages.each do |msg| %>
+          <li><%= msg %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <%= f.label :title, "Album Title" %>
+  <%= f.text_field :title %>
+
+  <%= f.fields_for :songs do |song| %>
+    <div>
+      <%= song.label :title %>
+      <%= song.text_field :title %>
+    </div>
+  <% end %>
+
+  <%= f.submit %>
+<% end %>
+

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config/application.rb

@@ -0,0 +1,20 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+
+Bundler.require
+
+module Dummy
+  class Application < Rails::Application
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    config.cache_store = :memory_store
+  end
+end
+
+require "reform/rails"

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,16 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+  config.secret_key_base = 123
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,46 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Specifies the header that your server uses for sending files
+  config.action_dispatch.x_sendfile_header = "X-Sendfile"
+
+  # For nginx:
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+
+  # If you have no front-end server that supports something like X-Sendfile,
+  # just comment this out and Rails will serve the files
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+end

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,33 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+  config.secret_key_base = "yo"
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  #config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+end

data/test/dummy/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/test/dummy/config/routes.rb

@@ -0,0 +1,4 @@
+Dummy::Application.routes.draw do
+  get ':controller(/:action(/:id(.:format)))'
+  resources :albums
+end

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/errors_test.rb

@@ -0,0 +1,95 @@
+require 'test_helper'
+
+class ErrorsTest < MiniTest::Spec
+  class AlbumForm < Reform::Form
+    property :title
+
+    property :hit do
+      property :title
+      validates :title, :presence => true
+    end
+
+    collection :songs do
+      property :title
+      validates :title, :presence => true
+    end
+
+    validates :title, :presence => true
+  end
+
+  let (:album) do
+    OpenStruct.new(
+      :title  => "Blackhawks Over Los Angeles",
+      :hit    => song,
+      :songs  => songs # TODO: document this requirement
+    )
+  end
+  let (:song)  { OpenStruct.new(:title => "Downtown") }
+  let (:songs) { [song=OpenStruct.new(:title => "Calling"), song] }
+  let (:form)  { AlbumForm.new(album) }
+
+
+  describe "incorrect #validate" do
+    before { form.validate(
+      "hit"   =>{"title" => ""},
+      "title" => "",
+      "songs" => [{"title" => ""}, {"title" => ""}]) } # FIXME: what happens if item is missing?
+
+    it do
+      form.errors.messages.must_equal({
+        :title  => ["can't be blank"],
+        :"hit.title"=>["can't be blank"],
+        :"songs.title"=>["can't be blank"]})
+    end
+
+    it do
+      #form.errors.must_equal({:title  => ["can't be blank"]})
+      # TODO: this should only contain local errors?
+    end
+
+    # nested forms keep their own Errors:
+    it { form.hit.errors.messages.must_equal({:title=>["can't be blank"]}) }
+    it { form.songs[0].errors.messages.must_equal({:title=>["can't be blank"]}) }
+
+    it do
+      form.errors.messages.must_equal({
+        :title        => ["can't be blank"],
+        :"hit.title"  => ["can't be blank"],
+        :"songs.title"=> ["can't be blank"]})
+    end # TODO: add another invalid item.
+  end
+
+  describe "#validate with main form invalid" do
+    before { @result = form.validate("title"=>"") }
+
+    it { @result.must_equal false }
+    it { form.errors.messages.must_equal({:title=>["can't be blank"]}) }
+  end
+
+  describe "#validate with middle nested form invalid" do
+    before { @result = form.validate("hit"=>{"title" => ""}) }
+
+    it { @result.must_equal false }
+    it { form.errors.messages.must_equal({:"hit.title"=>["can't be blank"]}) }
+  end
+
+  describe "#validate with last nested form invalid" do
+    before { @result = form.validate("songs"=>[{"title" => ""}]) }
+
+    it { @result.must_equal false }
+    it { form.errors.messages.must_equal({:"songs.title"=>["can't be blank"]}) }
+  end
+
+  describe "correct #validate" do
+    before { @result = form.validate(
+      "hit"   => {"title" => "Sacrifice"},
+      "title" => "Second Heat",
+      "songs" => [{"title"=>"Heart Of A Lion"}]
+      ) }
+
+    it { @result.must_equal true }
+    it { form.hit.title.must_equal "Sacrifice" }
+    it { form.title.must_equal "Second Heat" }
+    it { form.songs.first.title.must_equal "Heart Of A Lion" }
+  end
+end

data/test/form_composition_test.rb

@@ -0,0 +1,60 @@
+require 'test_helper'
+
+class FormCompositionTest < MiniTest::Spec
+  class SongForm < Reform::Form
+    include Composition
+
+    property  :title,           :on => :song
+    properties [:name, :genre], :on => :artist
+
+    validates :name, :title, :genre, :presence => true
+  end
+
+  let (:form)   { SongForm.new(:song => song, :artist => artist) }
+  let (:song)   { OpenStruct.new(:title => "Rio") }
+  let (:artist) { OpenStruct.new(:name => "Duran Duran") }
+
+
+  # delegation form -> composition works
+  it { form.title.must_equal  "Rio" }
+  it { form.name.must_equal   "Duran Duran" }
+  # delegation form -> composed models (e.g. when saving this can be handy)
+  it { form.song.must_equal   song }
+  it { form.artist.must_equal artist }
+
+
+  it "creates Composition for you" do
+    form.validate("title" => "Greyhound", "name" => "Frenzal Rhomb").must_equal false
+  end
+
+  describe "#save" do
+    it "provides data block argument" do
+      hash = {}
+
+      form.save do |data, map|
+        hash[:name]   = data.name
+        hash[:title]  = data.title
+      end
+
+      hash.must_equal({:name=>"Duran Duran", :title=>"Rio"})
+    end
+
+    it "provides nested symbolized hash as second block argument" do
+      hash = {}
+
+      form.save do |data, map|
+        hash = map
+      end
+
+      hash.must_equal({:song=>{:title=>"Rio"}, :artist=>{:name=>"Duran Duran"}})
+    end
+
+    it "pushes data to models when no block passed" do
+      form.validate("title" => "Greyhound", "name" => "Frenzal Rhomb")
+      form.save
+
+      artist.name.must_equal "Frenzal Rhomb"
+      song.title.must_equal "Greyhound"
+    end
+  end
+end