reform 2.3.0.rc1 → 2.3.0.rc2

data/test/populator_skip_test.rb

@@ -4,7 +4,6 @@ class PopulatorSkipTest < MiniTest::Spec
   Album = Struct.new(:songs)
   Song  = Struct.new(:title)
 
-
   class AlbumForm < TestForm
     collection :songs, populator: :my_populator do
       property :title
@@ -26,4 +25,4 @@ class PopulatorSkipTest < MiniTest::Spec
     assert_nil form.songs[0].title
     form.songs[1].title.must_equal "Bad"
   end
-end
+end

data/test/prepopulator_test.rb

@@ -1,17 +1,17 @@
-require 'test_helper'
+require "test_helper"
 
 class PrepopulatorTest < MiniTest::Spec
   Song = Struct.new(:title, :band, :length)
   Band = Struct.new(:name)
 
   class AlbumForm < TestForm
-    property :title, prepopulator: ->(*){ self.title = "Another Day At Work" }                  # normal assignment.
+    property :title, prepopulator: ->(*) { self.title = "Another Day At Work" }                  # normal assignment.
     property :length
 
     property :hit, prepopulator: ->(options) { self.hit = Song.new(options[:title]) } do # use user options.
       property :title
 
-      property :band, prepopulator: ->(options){ self.band = my_band(options[:title]) } do                             # invoke your own code.
+      property :band, prepopulator: ->(options) { self.band = my_band(options[:title]) } do                             # invoke your own code.
         property :name
       end
 
@@ -24,7 +24,7 @@ class PrepopulatorTest < MiniTest::Spec
         property :title
     end
 
-  private
+    private
     def prepopulate_songs!(options)
       if songs == nil
         self.songs = [Song.new, Song.new]
@@ -78,7 +78,6 @@ class PrepopulateWithoutConfiguration < MiniTest::Spec
   it { subject.songs.size.must_equal 0 }
 end
 
-
 class ManualPrepopulatorOverridingTest < MiniTest::Spec
   Song = Struct.new(:title, :band, :length)
   Band = Struct.new(:name)
@@ -109,4 +108,4 @@ class ManualPrepopulatorOverridingTest < MiniTest::Spec
     form.hit.model.must_equal Song.new("Potemkin City Limits")
     form.hit.title.must_equal "Potemkin City Limits"
   end
-end
+end

data/test/read_only_test.rb

@@ -1,3 +1,14 @@
-require 'test_helper'
+require "test_helper"
 
+class ReadonlyTest < MiniTest::Spec
+  class SongForm < TestForm
+    property :artist
+    property :title, writeable: false
+    # TODO: what to do with virtual values?
+  end
 
+  let(:form) { SongForm.new(OpenStruct.new) }
+
+  it { form.readonly?(:artist).must_equal false }
+  it { form.readonly?(:title).must_equal true }
+end

data/test/readable_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require "test_helper"
 
 class ReadableTest < MiniTest::Spec
   Credentials = Struct.new(:password)
@@ -7,8 +7,8 @@ class ReadableTest < MiniTest::Spec
     property :password, readable: false
   end
 
-  let (:cred) { Credentials.new }
-  let (:form) { PasswordForm.new(cred) }
+  let(:cred) { Credentials.new }
+  let(:form) { PasswordForm.new(cred) }
 
   it {
     assert_nil form.password # password not read.
@@ -25,6 +25,6 @@ class ReadableTest < MiniTest::Spec
       hash = nested
     end
 
-    hash.must_equal("password"=> "123")
+    hash.must_equal("password" => "123")
   }
-end
+end

data/test/reform_new_api.rb

@@ -0,0 +1,204 @@
+require "test_helper"
+
+class ReformTest < Minitest::Spec
+  let(:comp) { OpenStruct.new(name: "Duran Duran", title: "Rio") }
+
+  let(:form) { SongForm.new(comp) }
+
+  class SongForm < TestForm
+    property :name
+    property :title
+
+    validation do
+      params { required(:name).filled }
+    end
+  end
+
+  describe "(new) form with empty models" do
+    let(:comp) { OpenStruct.new }
+
+    it "returns empty fields" do
+      assert_nil form.title
+      form.name.must_be_nil
+    end
+
+    describe "and submitted values" do
+      it "returns filled-out fields" do
+        form.validate("name" => "Duran Duran")
+
+        assert_nil form.title
+        form.name.must_equal "Duran Duran"
+      end
+    end
+  end
+
+  describe "(edit) form with existing models" do
+    it "returns filled-out fields" do
+      form.name.must_equal  "Duran Duran"
+      form.title.must_equal "Rio"
+    end
+  end
+
+  describe "#validate" do
+    let(:comp) { OpenStruct.new }
+
+    it "ignores unmapped fields in input" do
+      form.validate("name" => "Duran Duran", :genre => "80s")
+      assert_raises NoMethodError do
+        form.genre
+      end
+    end
+
+    it "returns true when valid" do
+      form.validate("name" => "Duran Duran").must_equal true
+    end
+
+    it "exposes input via property accessors" do
+      form.validate("name" => "Duran Duran")
+
+      form.name.must_equal "Duran Duran"
+    end
+
+    it "doesn't change model properties" do
+      form.validate("name" => "Duran Duran")
+
+      assert_nil comp.name # don't touch model, yet.
+    end
+
+    # TODO: test errors. test valid.
+    describe "invalid input" do
+      class ValidatingForm < TestForm
+        property :name
+        property :title
+
+        validation do
+          params do
+            required(:name).filled
+            required(:title).filled
+          end
+        end
+      end
+      let(:form) { ValidatingForm.new(comp) }
+
+      it "returns false when invalid" do
+        form.validate({}).must_equal false
+      end
+
+      it "populates errors" do
+        form.validate({})
+        form.errors.messages.must_equal(name: ["must be filled"], title: ["must be filled"])
+      end
+    end
+  end
+
+  describe "#save" do
+    let(:comp) { OpenStruct.new }
+    let(:form) { SongForm.new(comp) }
+
+    before { form.validate("name" => "Diesel Boy") }
+
+    it "xxpushes data to models" do
+      form.save
+
+      comp.name.must_equal "Diesel Boy"
+      assert_nil comp.title
+    end
+
+    describe "#save with block" do
+      it do
+        hash = {}
+
+        form.save do |map|
+          hash = map
+        end
+
+        hash.must_equal("name" => "Diesel Boy", "title" => nil)
+      end
+    end
+  end
+
+  describe "#model" do
+    it { form.model.must_equal comp }
+  end
+
+  describe "inheritance" do
+    class HitForm < SongForm
+      property :position
+      validation do
+        params { required(:position).filled }
+      end
+    end
+
+    let(:form) { HitForm.new(OpenStruct.new()) }
+    it do
+      form.validate("title" => "The Body")
+      form.title.must_equal "The Body"
+      assert_nil form.position
+      form.errors.messages.must_equal(name: ["must be filled"], position: ["must be filled"])
+    end
+  end
+end
+
+class OverridingAccessorsTest < BaseTest
+  class SongForm < TestForm
+    property :title
+
+    def title=(v) # used in #validate.
+      super v * 2
+    end
+
+    def title # used in #sync.
+      super.downcase
+    end
+  end
+
+  let(:song) { Song.new("Pray") }
+  subject { SongForm.new(song) }
+
+  # override reader for presentation.
+  it { subject.title.must_equal "pray" }
+
+  describe "#save" do
+    before { subject.validate("title" => "Hey Little World") }
+
+    # reader always used
+    it { subject.title.must_equal "hey little worldhey little world" }
+
+    # the reader is not used when saving/syncing.
+    it do
+      subject.save do |hash|
+        hash["title"].must_equal "Hey Little WorldHey Little World"
+      end
+    end
+
+    # no reader or writer used when saving/syncing.
+    it do
+      song.extend(Saveable)
+      subject.save
+      song.title.must_equal "Hey Little WorldHey Little World"
+    end
+  end
+end
+
+class MethodInFormTest < MiniTest::Spec
+  class AlbumForm < TestForm
+    property :title
+
+    def title
+      "The Suffer And The Witness"
+    end
+
+    property :hit do
+      property :title
+
+      def title
+        "Drones"
+      end
+    end
+  end
+
+  # methods can be used instead of created accessors.
+  subject { AlbumForm.new(OpenStruct.new(hit: OpenStruct.new)) }
+  it { subject.title.must_equal "The Suffer And The Witness" }
+  it { subject.hit.title.must_equal "Drones" }
+end

data/test/{reform_test.rb → reform_old_api.rb}

@@ -1,10 +1,9 @@
-require 'test_helper'
+require "test_helper"
 
-# TODO: this test should be removed.
 class ReformTest < Minitest::Spec
-  let (:comp) { OpenStruct.new(:name => "Duran Duran", :title => "Rio") }
+  let(:comp) { OpenStruct.new(name: "Duran Duran", title: "Rio") }
 
-  let (:form) { SongForm.new(comp) }
+  let(:form) { SongForm.new(comp) }
 
   class SongForm < TestForm
     property :name
@@ -16,11 +15,11 @@ class ReformTest < Minitest::Spec
   end
 
   describe "(new) form with empty models" do
-    let (:comp) { OpenStruct.new }
+    let(:comp) { OpenStruct.new }
 
     it "returns empty fields" do
       assert_nil form.title
-      form.name.must_equal  nil
+      form.name.must_be_nil
     end
 
     describe "and submitted values" do
@@ -28,7 +27,7 @@ class ReformTest < Minitest::Spec
         form.validate("name" => "Duran Duran")
 
         assert_nil form.title
-        form.name.must_equal  "Duran Duran"
+        form.name.must_equal "Duran Duran"
       end
     end
   end
@@ -41,7 +40,7 @@ class ReformTest < Minitest::Spec
   end
 
   describe "#validate" do
-    let (:comp) { OpenStruct.new }
+    let(:comp) { OpenStruct.new }
 
     it "ignores unmapped fields in input" do
       form.validate("name" => "Duran Duran", :genre => "80s")
@@ -77,7 +76,7 @@ class ReformTest < Minitest::Spec
           required(:title).filled
         end
       end
-      let (:form) { ValidatingForm.new(comp) }
+      let(:form) { ValidatingForm.new(comp) }
 
       it "returns false when invalid" do
         form.validate({}).must_equal false
@@ -85,14 +84,14 @@ class ReformTest < Minitest::Spec
 
       it "populates errors" do
         form.validate({})
-        form.errors.messages.must_equal({:name=>["must be filled"], :title=>["must be filled"]})
+        form.errors.messages.must_equal({name: ["must be filled"], title: ["must be filled"]})
       end
     end
   end
 
   describe "#save" do
-    let (:comp) { OpenStruct.new }
-    let (:form) { SongForm.new(comp) }
+    let(:comp) { OpenStruct.new }
+    let(:form) { SongForm.new(comp) }
 
     before { form.validate("name" => "Diesel Boy") }
 
@@ -111,17 +110,15 @@ class ReformTest < Minitest::Spec
           hash = map
         end
 
-        hash.must_equal({"name"=>"Diesel Boy", "title" => nil})
+        hash.must_equal({"name" => "Diesel Boy", "title" => nil})
       end
     end
   end
 
-
   describe "#model" do
     it { form.model.must_equal comp }
   end
 
-
   describe "inheritance" do
     class HitForm < SongForm
       property :position
@@ -130,23 +127,22 @@ class ReformTest < Minitest::Spec
       end
     end
 
-    let (:form) { HitForm.new(OpenStruct.new()) }
+    let(:form) { HitForm.new(OpenStruct.new()) }
     it do
       form.validate({"title" => "The Body"})
       form.title.must_equal "The Body"
       assert_nil form.position
-      form.errors.messages.must_equal({:name=>["must be filled"], :position=>["must be filled"]})
+      form.errors.messages.must_equal({name: ["must be filled"], position: ["must be filled"]})
     end
   end
 end
 
-
 class OverridingAccessorsTest < BaseTest
   class SongForm < TestForm
     property :title
 
     def title=(v) # used in #validate.
-      super v*2
+      super v * 2
     end
 
     def title # used in #sync.
@@ -154,13 +150,12 @@ class OverridingAccessorsTest < BaseTest
     end
   end
 
-  let (:song) { Song.new("Pray") }
+  let(:song) { Song.new("Pray") }
   subject { SongForm.new(song) }
 
   # override reader for presentation.
   it { subject.title.must_equal "pray" }
 
-
   describe "#save" do
     before { subject.validate("title" => "Hey Little World") }
 
@@ -183,7 +178,6 @@ class OverridingAccessorsTest < BaseTest
   end
 end
 
-
 class MethodInFormTest < MiniTest::Spec
   class AlbumForm < TestForm
     property :title
@@ -202,7 +196,7 @@ class MethodInFormTest < MiniTest::Spec
   end
 
   # methods can be used instead of created accessors.
-  subject { AlbumForm.new(OpenStruct.new(:hit => OpenStruct.new)) }
+  subject { AlbumForm.new(OpenStruct.new(hit: OpenStruct.new)) }
   it { subject.title.must_equal "The Suffer And The Witness" }
   it { subject.hit.title.must_equal "Drones" }
 end