blank? and present? commit to return singletons [Xavier Noria & Pavel Pravosud]

The contract of blank? and present? was in principle to return Object, as we
generally do, the test suite and description was consistent with that, but some
examples had comments like "# => true".

This cannot be unclear, we either fix the examples, or update the contract.

Since users may be already assuming singletons due to the examples and the fact
that they were returned before 30ba7ee, the safest option seems to be to revise
the contract and the implementation of String#blank?

The motivation for 30ba7ee was to improve the performance of the predicate, the
refactor based on === is on par regarding speed.

With this commit we start documenting return types using YARD conventions. We
plan to document return types gradually.

1 files changed, 11 insertions, 7 deletions

diff --git a/activesupport/test/core_ext/blank_test.rb b/activesupport/test/core_ext/blank_test.rb
index 3e3176f993..246bc7fa61 100644
--- a/activesupport/test/core_ext/blank_test.rb
+++ b/activesupport/test/core_ext/blank_test.rb
@@ -5,24 +5,28 @@ require 'active_support/core_ext/object/blank'
 
 class BlankTest < ActiveSupport::TestCase
   class EmptyTrue
-    def empty?() true; end
+    def empty?
+      0
+    end
   end
 
   class EmptyFalse
-    def empty?() false; end
+    def empty?
+      nil
+    end
   end
 
-  BLANK = [ EmptyTrue.new, nil, false, '', '   ', "  \n\t  \r ", '　', [], {} ]
+  BLANK = [ EmptyTrue.new, nil, false, '', '   ', "  \n\t  \r ", '　', "\u00a0", [], {} ]
   NOT   = [ EmptyFalse.new, Object.new, true, 0, 1, 'a', [nil], { nil => 0 } ]
 
   def test_blank
-    BLANK.each { |v| assert v.blank?,  "#{v.inspect} should be blank" }
-    NOT.each   { |v| assert !v.blank?, "#{v.inspect} should not be blank" }
+    BLANK.each { |v| assert_equal true, v.blank?,  "#{v.inspect} should be blank" }
+    NOT.each   { |v| assert_equal false, v.blank?, "#{v.inspect} should not be blank" }
   end
 
   def test_present
-    BLANK.each { |v| assert !v.present?, "#{v.inspect} should not be present" }
-    NOT.each   { |v| assert v.present?,  "#{v.inspect} should be present" }
+    BLANK.each { |v| assert_equal false, v.present?, "#{v.inspect} should not be present" }
+    NOT.each   { |v| assert_equal true, v.present?,  "#{v.inspect} should be present" }
   end
 
   def test_presence