rubype 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7c7fb90c7b7bb6d84aed99e298cfd92344c334b
-  data.tar.gz: 66a55c98516f1d8b2f4b1a1454516532406c3e24
+  metadata.gz: 2acef96be19b3b93d4403a8ac88be41dfa2d45a9
+  data.tar.gz: 573fd9e52d7bbcec0e178964633ccb3e48e40342
 SHA512:
-  metadata.gz: 56da79236105ebf887d96f031d596efdff6272ee1e1a548f3d87c23b63fde00bc49eb77c18de1146177e6157f0acf92bb46669f1b89026a147ab65f1b5b41c81
-  data.tar.gz: b2d3b9172ec56df5b2b5f1488c2b8022048d699202e0eadb26399aad46078d4b7da70d699ea6e3694e709819cd7ce5de9ed61a0ede214858c92fe60039e3ade4
+  metadata.gz: a1e45168f79837035f25ba88da2fc53472026fc10d37ce2be1a61e65542692d3ddf365634343a6c7da23be7f47becccf6c034366617d99a970d7ad9eb2617625
+  data.tar.gz: 506debee9973cd93b74eb2f4248253cbc5328dc3c618d340543bd8ada6119bc305d3ca11c0e46715b55c4ce911c38c86febc899705e513ad03270298b06a5ddd

data/README.md

@@ -2,6 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/rubype.svg)](http://badge.fury.io/rb/rubype) [![Build Status](https://travis-ci.org/gogotanaka/Rubype.svg?branch=develop)](https://travis-ci.org/gogotanaka/Rubype) [![Dependency Status](https://gemnasium.com/gogotanaka/Rubype.svg)](https://gemnasium.com/gogotanaka/Rubype) [![Code Climate](https://codeclimate.com/github/gogotanaka/Rubype/badges/gpa.svg)](https://codeclimate.com/github/gogotanaka/Rubype)
 
+![210414.png](https://qiita-image-store.s3.amazonaws.com/0/30440/0aafba03-1a4c-4676-5377-75f906aaeab9.png)
 ```rb
 # Assert class of both args is Numeric and class of return is String
 def sum(x, y)
@@ -19,11 +20,22 @@ typesig :sum, [:to_i, Numeric] => Numeric
 
 This gem brings you advantage of type without changing existing code's behavior.
 
+## Good point:
+* Meaningful error
+* Executable documentation
+* Don't need to check type of method's arguments and return.
+* Type info itself is object, you can check it and even change it during run time.
+
+## Bad point:
+* Checking type run every time method call... it might be overhead, but it's not big deal.
+* There is no static analysis.
+
 # Feature
 
 ### Advantage of type
 * Meaningful error
 * Executable documentation
+* Don't need to check type of method's arguments and return .
 
 ```rb
 require 'rubype'
@@ -45,7 +57,7 @@ MyClass.new.sum(1, 2)
 #=> 3
 
 MyClass.new.sum(1, 'string')
-#=> Rubype::ArgumentTypeError: Expected MyClass#sum's 2th argument to be Numeric but got "string" instead
+#=> Rubype::ArgumentTypeError: Expected MyClass#sum's 2nd argument to be Numeric but got "string" instead
 
 MyClass.new.wrong_sum(1, 2)
 #=> Rubype::ReturnTypeError: Expected MyClass#wrong_sum to return Numeric but got "string" instead
@@ -63,7 +75,7 @@ MyClass.new.sum('1', 2)
 #=> 3
 
 MyClass.new.sum(:has_no_to_i, 2)
-#=> Rubype::ArgumentTypeError: Expected MyClass#sum's 1th argument to have method #to_i but got :has_no_to_i instead
+#=> Rubype::ArgumentTypeError: Expected MyClass#sum's 1st argument to have method #to_i but got :has_no_to_i instead
 
 
 # ex3: You can use Any class, if you want
@@ -78,7 +90,7 @@ People.new.marry(People.new)
 #=> no error
 
 People.new.marry('non people')
-#=> Rubype::ArgumentTypeError: Expected People#marry's 1th argument to be People but got "non people" instead
+#=> Rubype::ArgumentTypeError: Expected People#marry's 1st argument to be People but got "non people" instead
 
 ```
 
@@ -90,7 +102,7 @@ class MyClass
   def method_with_type(x, y)
     x + y
   end
-  typesig :sum, [Numeric, Numeric] => Numeric
+  typesig :method_with_type, [Numeric, Numeric] => Numeric
 
   def method_without_type(x, y)
     'string'
@@ -134,15 +146,81 @@ class MyClass
   typesig :sum, [:to_i, Numeric] => Numeric
 end
 
-MyClass.new.method(:foo).type_info
+MyClass.new.method(:sum).type_info
 # => [:to_i, Numeric] => Numeric
 
+MyClass.new.method(:sum).arg_types
+# => [:to_i, Numeric]
+
+MyClass.new.method(:sum).return_type
+# => Numeric
+
 ```
 
+## Benchmarks
+
+```ruby
+require 'rubype'
+require 'benchmark'
+
+class RubypeCommonClass
+  def sum(x, y)
+    x + y
+  end
+  typesig :sum, [Numeric, Numeric] => Numeric
+end
+
+class CommonClass
+  def sum(x, y)
+    x + y
+  end
+end
+
+class RubypeDucktypeClass
+  def sum(x, y)
+    x.to_i + y
+  end
+  typesig :sum, [:to_i, Numeric] => Numeric
+end
+
+class DucktypeClass
+  def sum(x, y)
+    x.to_i + y
+  end
+end
+
+N = 100_000
+Benchmark.bm("RubypeDucktypeClass".length + 3) do |x|
+  x.report("RubypeCommonClass") { N.times { RubypeCommonClass.new.sum(1, 5) } }
+  x.report("CommonClass")       { N.times { CommonClass.new.sum(1, 5) } }
+end
+
+Benchmark.bm("RubypeDucktypeClass".length + 3) do |x|
+  x.report("RubypeDucktypeClass")  { N.times { RubypeDucktypeClass.new.sum(1, 5) } }
+  x.report("DucktypeClass")        { N.times { DucktypeClass.new.sum(1, 5) } }
+end
+```
+
+### Results
+Ruby 2.2.0, Macbook Pro 2.9Ghz Intel Core i7, 8GB RAM
+
+```
+                             user     system      total        real
+RubypeCommonClass        0.530000   0.010000   0.540000 (  0.566493)
+CommonClass              0.030000   0.000000   0.030000 (  0.035718)
+                             user     system      total        real
+RubypeDucktypeClass      0.590000   0.010000   0.600000 (  0.682504)
+DucktypeClass            0.030000   0.000000   0.030000 (  0.029856)
+```
+
+
+
 ## Installation
 
 gem install rubype or add gem 'rubype' to your Gemfile.
 
+And `require 'rubype'`, enjoy typed Ruby.
+
 This gem requires Ruby 2.0.0+.
 
 ### Contributing
@@ -161,7 +239,7 @@ Commit your changes (`git commit -am 'Add some feature'`)
 
     Finished in 0.010961s, 547.3953 runs/s, 5017.7903 assertions/s.
 
-    6 runs, 55 assertions, 0 failures, 0 errors, 0 skips
+    7 runs, 61 assertions, 0 failures, 0 errors, 0 skips
 
 Push to the branch (`git push origin my-new-feature`)
 

data/lib/rubype.rb

@@ -1,3 +1,5 @@
+require 'rubype/ordinal'
+
 # Builtin Contracts
 class  Any;     end
 module Boolean; end
@@ -22,16 +24,19 @@ class Module
 end
 
 class Method
+  # @return [Hash]: { [ArgInfo_1, ArgInfo_2, ... ArgInfo_n] => RtnInfo }
   def type_info
     if methods_hash = Rubype.typed_method_info[owner]
       methods_hash[name]
     end
   end
 
+  # @return [Array<Class, Symbol>]: [ArgInfo_1, ArgInfo_2, ... ArgInfo_n]
   def arg_types
     type_info.first.first if type_info
   end
 
+  # @return [Class, Symbol]: RtnInfo
   def return_type
     type_info.first.last if type_info
   end
@@ -80,10 +85,10 @@ module Rubype
           case type_check(arg, type_info)
           when :need_correct_class
             raise ArgumentTypeError,
-              "Expected #{meth_caller.class}##{meth}'s #{i}th argument to be #{type_info} but got #{arg.inspect} instead"
+              "Expected #{meth_caller.class}##{meth}'s #{i}#{ordinal(i)} argument to be #{type_info} but got #{arg.inspect} instead"
           when :need_correct_method
             raise ArgumentTypeError,
-              "Expected #{meth_caller.class}##{meth}'s #{i}th argument to have method ##{type_info} but got #{arg.inspect} instead"
+              "Expected #{meth_caller.class}##{meth}'s #{i}#{ordinal(i)} argument to have method ##{type_info} but got #{arg.inspect} instead"
           end
         end
       end

data/lib/rubype/ordinal.rb

@@ -0,0 +1,13 @@
+# Borrowed from ActiveSupport::Inflector
+def ordinal(number)
+  if (11..13).include?(number % 100)
+    "th"
+  else
+    case number % 10
+      when 1; "st"
+      when 2; "nd"
+      when 3; "rd"
+      else    "th"
+    end
+  end
+end

data/lib/rubype/version.rb

@@ -1,3 +1,3 @@
 module Rubype
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

data/test/test_rubype.rb

@@ -103,10 +103,10 @@ class TestRubype < MiniTest::Unit::TestCase
     assert_equal meth.return_type, String
 
     err = assert_raises(Rubype::ReturnTypeError) { meth.(1,2) }
-    assert_equal err.message, "Expected MyClass#test_mth to return String but got nil instead"
+    assert_equal err.message, %|Expected MyClass#test_mth to return String but got nil instead|
 
     err = assert_raises(Rubype::ArgumentTypeError) { meth.(1,'2') }
-    assert_equal err.message, "Expected MyClass#test_mth's 2th argument to be Numeric but got \"2\" instead"
+    assert_equal err.message, %|Expected MyClass#test_mth's 2nd argument to be Numeric but got "2" instead|
   end
 
   private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubype
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - gogotanaka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2015-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,6 +71,7 @@ files:
 - ext/rubype/rubype.c
 - ext/rubype/rubype.h
 - lib/rubype.rb
+- lib/rubype/ordinal.rb
 - lib/rubype/version.rb
 - rubype.gemspec
 - test/minitest_helper.rb