y_support 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc599e5fe91dcb19ccd68fd32429f95b63ded715
-  data.tar.gz: 2bc37581f0ccd3a5bbe9496ec289b0b883958dfc
+  metadata.gz: baadc96c9834da6e35bc3b2b9fc8406123c3c68c
+  data.tar.gz: e956e788aabb00f16ab6bef159b5900a00e945de
 SHA512:
-  metadata.gz: 8c7f97c8a6d64c095ff12c9372b300c9a4a9bb5086537c3caee403e03b68a45dd1a0ddc8319b9bf1b94a9f31667f63d11a8d8cb846cd97b91707d79f54535976
-  data.tar.gz: c70caa248db66904b1d1393c41fd48bee5abf70a9cc9a326ab766e62196975ee2b6b93de8267e30c5da950e877ad8c0a24461cc0a5dc1dab0c4224f8e3f16fa7
+  metadata.gz: 06615d7a25a37c48818e8553c0d0f528397ec5035c04bd1fbd5b1a991b4646dbd928fe3f620b4b51cde6c226c5aacab1b4baab3e78495ca1935d662fe66bbb48
+  data.tar.gz: 9a235fe65a3a7b51f8e037fb0f50d49dfe5f14e75b74a4b8ff4fa98c6a7fe4beea0d9d19b0a71259ec0f560d0242f33a94466914f3fa57d0e23681aa93106eb9

data/lib/y_support/core_ext/object/inspection.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+class Object
+  # Constructs the string "#{self.class}:#{self}". Useful for inspection.
+  # 
+  def insp
+    "#{self.class}:#{self}"
+  end
+end

data/lib/y_support/core_ext/object.rb

@@ -1,2 +1,3 @@
 require 'y_support'
 require 'y_support/core_ext/object/misc'
+require 'y_support/core_ext/object/inspection'

data/lib/y_support/core_ext/string/misc.rb

@@ -77,4 +77,11 @@ class String
     standardize
       .to_sym
   end
+
+  # Capitalizes a string and append an exclamation mark. Also allows optional
+  # argument for string interpolation. Handy for constructing error messages.
+  # 
+  def X! arg=nil
+    arg.nil? ? capitalize + ?! : ( self % arg ).X!
+  end
 end

data/lib/y_support/typing/object/typing.rb

@@ -1,6 +1,8 @@
 #encoding: utf-8
 
 require 'active_support/core_ext/object/blank'
+require 'y_support/core_ext/object/inspection'
+require 'y_support/core_ext/string/misc'
 
 class Object
   # === Support for typing by declaration
@@ -46,13 +48,12 @@ class Object
   # the receiver (using #instance_exec method). If no block is given, it is
   # checked, whether the object is truey.
   # 
-  def aT what_is_receiver=nil, how_comply=nil, &b
+  def aT what_is_receiver=insp, how_comply=nil, &b
     if block_given? then
-      m = "%s fails #{how_comply ? 'to %s' % how_comply : 'its duck type'}!" %
-        if what_is_receiver then what_is_receiver.to_s.capitalize else
-          "#{self.class} instance #{object_id}"
-        end
-      tap { b.( self ) or fail TypeError, m }
+      if b.( self ) then self else
+        m = "%s fails " + how_comply ? "to #{how_comply}" : "its check"
+        fail TypeError, m.X!( what_is_receiver ) 
+      end
     else self or fail TypeError end
   end
   
@@ -65,107 +66,92 @@ class Object
   # inside the singleton class of the receiver (using #instance_exec method). If
   # no block is given, it is checked, whether the object is falsey.
   # 
-  def aT_not what_is_receiver=nil, how_comply=nil, &b
-    if block_given? then
-      m = how_comply ? "%s must not #{how_comply}!" : "%s fails its duck type!"
-      m %= if what_is_receiver then what_is_receiver.to_s.capitalize else
-             "#{self.class} instance #{object_id}"
-           end
-      tap { fail TypeError, m if b.( self ) }
-    else tap { fail TypeError if self } end
+  def aT_not what_is_receiver=insp, how_comply=nil, &b
+    tap do
+      if block_given? then
+        if b.( self ) then
+          m = how_comply ? "%s must not #{how_comply}" : "%s fails its check"
+          fail TypeError, m.X!( what_is_receiver )
+        end
+      else fail TypeError if self end
+    end
   end
 
   # Fails with TypeError unless the receiver is of the prescribed class. Second
   # optional argument customizes the error message (receiver description).
   # 
-  def aT_kind_of klass, what_is_receiver=nil
-    m = "%s is not a kind of #{klass}!" %
-      if what_is_receiver then what_is_receiver.to_s.capitalize else
-        "#{self.class} instance #{object_id}"
-      end
-    tap { kind_of? klass or fail TypeError, m }
+  def aT_kind_of klass, what_is_receiver=insp
+    tap do
+      is_a? klass or fail TypeError, "%s not a #{klass}".X!( what_is_receiver )
+    end
   end
-  alias :aT_is_a :aT_kind_of
+  alias aT_is_a aT_kind_of
 
   # Fails with TypeError unless the receiver declares compliance with the
   # given class, or is a descendant of that class. Second optional argument
   # customizes the error message (receiver description).
   # 
-  def aT_class_complies klass, what_is_receiver=nil
-    m = "%s does not comply or declare compliance with #{klass}!" %
-      if what_is_receiver then what_is_receiver.to_s.capitalize else
-        "#{self.class} instance #{object_id}"
-      end
-    tap { class_complies? klass or fail TypeError, m }
+  def aT_class_complies klass, what_is_receiver=insp
+    if class_complies? klass then
+      fail TypeError, "%s does not comply with #{klass}".X!( what_is_receiver )
+    else self end
   end
   
   # Fails with TypeError unless the receiver responds to the given
   # method. Second optional argument customizes the error message (receiver
   # description).
   # 
-  def aT_respond_to method_name, what_is_receiver=nil
-    m = "%s does not respond to method '#{method_name}'!" %
-      if what_is_receiver then what_is_receiver.to_s.capitalize else
-        "#{self.class} instance #{object_id}"
-      end
-    tap { respond_to? method_name or fail TypeError, m }
+  def aT_respond_to method_name, what_is_receiver=insp
+    if respond_to? method_name then self else
+      m = "%s does not respond to method '#{method_name}'"
+      fail TypeError, m.X!( what_is_receiver )
+    end
   end
-  alias :aT_responds_to :aT_respond_to
+  alias aT_responds_to aT_respond_to
   
   # Fails with TypeError unless the receiver, according to #== method, is
   # equal to the argument. Two more optional arguments customize the error
   # message (receiver description and the description of the other object).
   # 
-  def aT_equal other, what_is_receiver=nil, what_is_other=nil
-    r = what_is_receiver ? what_is_receiver.to_s.capitalize :
-      "#{self.class} instance #{object_id}"
-    o = what_is_other || "the prescribed value (#{other.class})"
-    m = "%s is not equal (==) to %s!" % [r, o]
-    tap { self == other or fail TypeError, m }
+  def aT_equal other, what_is_receiver=insp, what_is_other=nil
+    if self == other then self else
+      wo = what_is_other || "the prescribed value (#{other.insp})"
+      fail TypeError, "%s must be equal to %s".X!( [ what_is_receiver, wo ] )
+    end
   end
 
   # Fails with TypeError unless the receiver, according to #== method, differs
   # from to the argument. Two more optional arguments customize the error
   # message (receiver description and the description of the other object).
   # 
-  def aT_not_equal other, what_is_receiver=nil, what_is_other=nil
-    r = what_is_receiver ? what_is_receiver.to_s.capitalize :
-      "#{self.class} instance #{object_id}"
-    o = what_is_other || "the prescribed value (#{other.class})"
-    m = "%s fails to differ from %s!" % [r, o]
-    tap { fail TypeError, m if self == other }
+  def aT_not_equal other, what_is_receiver=insp, what_is_other=nil
+    if self == other
+      wo = what_is_other || "the prescribed value (#{other.insp})"
+      fail TypeError, "%s must not == %s".X!( [ what_is_receiver, wo ] )
+    else self end
   end
 
   # Fails with TypeError unless the ActiveSupport method #blank returns true
   # for the receiver.
   # 
-  def aT_blank what_is_receiver=nil
-    r = 
-    m = "#%s fails to be blank!" %
-      if what_is_receiver then what_is_receiver.to_s.capitalize else
-        "#{self.class} instance #{object_id}"
-      end
-    tap { blank? or fail TypeError, m }
+  def aT_blank what_is_receiver=insp
+    tap { blank? or fail TypeError, "%s not blank".X!( what_is_receiver ) }
   end
 
   # Fails with TypeError unless the ActiveSupport method #present returns true
   # for the receiver.
   # 
-  def aT_present what_is_receiver=nil
-    m = "%s fails to be present!" %
-      if what_is_receiver then what_is_receiver.to_s.capitalize else
-        "#{self.class} instance #{object_id}"
-      end
-    tap { present? or fail TypeError, m }
+  def aT_present what_is_receiver=insp
+    tap { present? or fail TypeError, "%s not present".X!( what_is_receiver ) }
   end
 
   private
 
+  # Some objects do not have accessible singleton class. This method returns
+  # the singleton class for those object, which have a singleton class, and
+  # self.class for others.
+  # 
   def singleton_class_or_class
-    begin
-      self.singleton_class
-    rescue TypeError
-      self.class
-    end
+    begin; self.singleton_class; rescue TypeError; self.class end
   end
 end

data/lib/y_support/version.rb

@@ -1,4 +1,4 @@
 module YSupport
-  VERSION = "2.1.1"
+  VERSION = "2.1.2"
   DEBUG = false
 end

data/test/typing_test.rb

@@ -1,4 +1,4 @@
-#! /usr/bin/ruby
+#! /Usr/Bin/ruby
 #encoding: utf-8
 
 require 'test/unit'
@@ -38,31 +38,31 @@ class TypingTest < Test::Unit::TestCase
     end
     
     should "have #aT raising TypeError if block falsey" do
-      assert_raise TErr do 0.aT "yada yada" do |rcvr| rcvr == 1 end end
+      assert_raise TypeError do 0.aT "yada yada" do |rcvr| rcvr == 1 end end
       assert_nothing_raised do 0.aT "yada yada" do |rcvr| rcvr == 0 end end
       assert_equal( "hello",
                     "hello".aT( "have 4 unique letters" ) { |str|
                       str.each_char.map { |e| e }.uniq.join.size == 4
                     } )
       assert_nothing_raised do 2.aT &:even? end
-      assert_raise TErr do 3.aT &:even? end
-      assert_raise TErr do nil.aT end
+      assert_raise TypeError do 3.aT &:even? end
+      assert_raise TypeError do nil.aT end
     end
     
     should "have #aT_not raising TypeError if block truey" do
-      assert_raise TErr do 0.aT_not { |rcvr| rcvr < 1 } end
+      assert_raise TypeError do 0.aT_not { |rcvr| rcvr < 1 } end
       assert_nothing_raised do 1.aT_not { |rcvr| rcvr == 2 } end
       assert_equal( "hello", "hello".aT_not( "have x" ) { |rcvr| rcvr.include? 'x' } )
       assert_nothing_raised do 3.aT_not &:even? end
-      assert_raise TErr do 2.aT_not &:even? end
-      assert_raise TErr do "".aT_not end
+      assert_raise TypeError do 2.aT_not &:even? end
+      assert_raise TypeError do "".aT_not end
     end
     
-    should "have #aT_kind_of, alias #aT_is_a TErr enforcers" do
-      assert_raise TErr do :o.aT_kind_of Numeric end
+    should "have #aT_kind_of, alias #aT_is_a TypeError enforcers" do
+      assert_raise TypeError do :o.aT_kind_of Numeric end
       assert_nothing_raised do 0.aT_kind_of Numeric end
       assert_equal( "hello", "hello".aT_kind_of( String ) )
-      assert_raise TErr do :o.aT_is_a Numeric end
+      assert_raise TypeError do :o.aT_is_a Numeric end
       assert_nothing_raised do 0.aT_is_a Numeric end
       assert_equal( "hello", "hello".aT_is_a( String ) )
     end
@@ -71,42 +71,42 @@ class TypingTest < Test::Unit::TestCase
       Koko = Class.new; Pipi = Class.new
       koko = Koko.new; pipi = Pipi.new
       pipi.declare_class_compliance! koko.class
-      assert_raise TErr do koko.aT_class_complies pipi.class end
+      assert_raise TypeError do koko.aT_class_complies pipi.class end
       assert_nothing_raised do koko.aT_class_complies koko.class end
       assert_nothing_raised do pipi.aT_class_complies pipi.class end
       assert_nothing_raised do pipi.aT_class_complies koko.class end
-      assert_raise TErr do koko.aT_class_complies Pipi end
+      assert_raise TypeError do koko.aT_class_complies Pipi end
       assert_nothing_raised do pipi.aT_class_complies Pipi end
       assert_nothing_raised do pipi.aT_class_complies Koko end
       assert_equal koko, koko.aT_class_complies( Koko )
     end
     
-    should "have #aT_respond_to enforcer" do
-      assert_raise TErr do :o.aT_respond_to :each end
+    should "have #aT_respond_to assertion" do
+      assert_raise TypeError do :o.aT_respond_to :each end
       assert_nothing_raised do {}.aT_respond_to :each end
       assert_equal( [:hello], [:hello].aT_respond_to( :each ) )
     end
     
     should "have #aT_equal enforcer" do
-      assert_raise TErr do 0.aT_equal 1 end
+      assert_raise TypeError do 0.aT_equal 1 end
       assert_nothing_raised do 1.aT_equal 2.0/2.0 end
       assert_equal( "hello", "hello".aT_equal( " hello ".strip ) )
     end
     
     should "have #aT_not_equal enforcer" do
-      assert_raise TErr do 1.aT_not_equal 1.0 end
+      assert_raise TypeError do 1.aT_not_equal 1.0 end
       assert_nothing_raised do 7.aT_not_equal 42 end
       assert_equal( "hello", "hello".aT_not_equal( "goodbye" ) )
     end
     
     should "have #aT_blank enforcer" do
-      assert_raise TErr do "x".aT_blank end
+      assert_raise TypeError do "x".aT_blank end
       assert_nothing_raised do ["", []].each{|e| e.aT_blank } end
       assert_equal( {}, {}.aT_blank )
     end
     
     should "have #aT_present enforcer" do
-      assert_raise TErr do nil.aT_present end
+      assert_raise TypeError do nil.aT_present end
       assert_nothing_raised do 0.aT_present end
       assert_equal( "hello", "hello".aT_present )
     end
@@ -114,34 +114,34 @@ class TypingTest < Test::Unit::TestCase
     
   context "Enumerable" do
     should "have #aT_all enforcer" do
-      assert_raise TErr do [1, 2, 7].aT_all { |e| e < 5 } end
+      assert_raise TypeError do [1, 2, 7].aT_all { |e| e < 5 } end
       assert_nothing_raised do [1, 2, 4].aT_all { |e| e < 5 } end
     end
 
     should "have #aT_all_kind_of enforcer" do
-      assert_raise TErr do [1.0, 2.0, :a].aT_all_kind_of Numeric end
+      assert_raise TypeError do [1.0, 2.0, :a].aT_all_kind_of Numeric end
       assert_nothing_raised do [1.0, 2.0, 3].aT_all_kind_of Numeric end
     end
 
     should "have #aT_all_comply class compliance enforcer" do
-      assert_raise TErr do [1.0, 2.0, :a].aT_all_comply Numeric end
+      assert_raise TypeError do [1.0, 2.0, :a].aT_all_comply Numeric end
       assert_nothing_raised do [1.0, 2.0, 3].aT_all_comply Numeric end
     end
 
     should "have #aT_all_numeric enforcer" do
-      assert_raise TErr do [:a].aT_all_numeric end
+      assert_raise TypeError do [:a].aT_all_numeric end
       assert_nothing_raised do [1, 2.0].aT_all_numeric end
     end
     
     should "have #aT_subset_of enforcer" do
-      assert_raise TErr do [6].aT_subset_of [*0..5] end
+      assert_raise TypeError do [6].aT_subset_of [*0..5] end
       assert_nothing_raised do [1,2].aT_subset_of [*0..5] end
     end
   end # context Enumerable
 
   context "Array" do
     should "have #aT_includes (alias #aT_include) enforcer" do
-      assert_raise TErr do [1, 2, 4].aT_includes 3 end
+      assert_raise TypeError do [1, 2, 4].aT_includes 3 end
       assert_nothing_raised do [1, 2, 4].aT_includes( 4 ).aT_include( 4 ) end
       assert_equal [6, 7], [6, 7].aT_includes( 6 )
       assert_equal [6, 7], [6, 7].aT_include( 6 )
@@ -160,7 +160,7 @@ class TypingTest < Test::Unit::TestCase
       assert_equal true, a.merge_synonym_keys!( :k, :o, :t )
       assert_equal( { a: 'a', b: 'b', k: 'k' }, a )
       old = a.dup
-      assert_raise TErr do a.merge_synonym_keys!( :a, :b ) end
+      assert_raise TypeError do a.merge_synonym_keys!( :a, :b ) end
       assert_equal old, a
       assert_equal true, a.merge_synonym_keys!( :c, :b )
       assert_equal( { a: 'a', c: 'b', k: 'k' }, a )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: y_support
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors:
 - boris
@@ -67,6 +67,7 @@ files:
 - lib/y_support/core_ext/numeric.rb
 - lib/y_support/core_ext/numeric/misc.rb
 - lib/y_support/core_ext/object.rb
+- lib/y_support/core_ext/object/inspection.rb
 - lib/y_support/core_ext/object/misc.rb
 - lib/y_support/core_ext/string.rb
 - lib/y_support/core_ext/string/misc.rb