rubype 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c7e1779556b1e9829b3b5043bc96aba5caaacb1
-  data.tar.gz: b2c48bd090e006e27a176803c0833d3a39883226
+  metadata.gz: 5a1d6b7168106e0de86c7111cfe41bfe191a4217
+  data.tar.gz: 2663b2cfef26e3eb90ee0c0932be7d34bb562ddb
 SHA512:
-  metadata.gz: 165eeb9c15017ab93dfefcf66236ff8096274bbd65e87fa082e0ae0fd62c10712c6636085fdd46dc96d06a59b1ddf318f9e97dcacd7df7bb78052441459bbcd6
-  data.tar.gz: 5983be0188e80c963ce8994949ff461abc99ea9217e8cde4265c088b2c4f565b58ee4146762e29a2ed76ac8b098436b3203c0b7caef1f7b4fea2be74ad45f2b9
+  metadata.gz: 0dce04b7c97e12030468f044af562c51c04446ed033d17acd27da10355dae3751a0fd8bc74dc8c15e8cdde31d0c6d9710d420a2cf106c6a36495636ac4a9a20e
+  data.tar.gz: 85d34a6e01587cab72001f08f13ca372c39a72efdb52b6b3506b10b12b7de0582f4087a60b8d23929ecb6454921a74e26edf1b0760607493083f40906b355e0f

data/README.md

@@ -1,9 +1,56 @@
-# Ruby with Type.
+# Ruby + Type = Rubype
+
+```rb
+def sum(x, y)
+  x + y
+end
+typesig sum: [Numeric, Numeric => Numeric]
+```
+
+This gem brings you advantage of type without changing existing code's behavior.
 
 Matz has mentioned Ruby3.0 with static type at some confluences. But almost all rubyists(include me) are not sure how typed Ruby is.
 
 But it's worth thinking more. This gem is kind of trial without so much side-effect.
 
+# Feature
+### Typed method can coexist with non-typed method
+
+```ruby
+# It's totally OK!!
+class MyClass
+  def method_with_type(x, y)
+    x + y
+  end
+  typesig sum: [Numeric, Numeric => Numeric]
+
+  def method_without_type(x, y)
+    'string'
+  end
+end
+```
+
+### Duck typing
+
+```ruby
+
+class MyClass
+  def foo(any_obj)
+    1
+  end
+  typesig sum: [Any => Numeric]
+end
+
+# It's totally OK!!
+MyClass.new.foo(1)
+# It's totally OK!!
+MyClass.new.foo('str')
+```
+
+### Advantage of type
+* Meaningful error
+* Executable documentation
+
 ```rb
 require 'rubype'
 
@@ -45,39 +92,7 @@ People.new.marry('non people')
 #=> ArgumentError: Wrong type of argument, type of "non people" should be People
 ```
 
-## Feature
-### Typed method can coexist with non-typed method
-
-```ruby
-# It's totally OK!!
-class MyClass
-  def sum(x, y)
-    x + y
-  end
-  typesig sum: [Numeric, Numeric => Numeric]
-
-  def sum_without_type(x, y)
-    'string'
-  end
-end
-```
-
-### Duck typing
 
-```ruby
-
-class MyClass
-  def foo(any_obj)
-    1
-  end
-  typesig sum: [Any => Numeric]
-end
-
-# It's totally OK!!
-MyClass.new.foo(1)
-# It's totally OK!!
-MyClass.new.foo('str')
-```
 
 ## Installation
 
@@ -104,4 +119,5 @@ Push to the branch (`git push origin my-new-feature`)
 Create a new Pull Request
 
 ## Credits
-[@chancancode](https://github.com/chancancode) first brought this to my attention. I've stolen some idea from him.
+[@chancancode](https://github.com/chancancode) and [This article](http://blog.codeclimate.com/blog/2014/05/06/gradual-type-checking-for-ruby/) first brought this to my attention. I've stolen some idea from them.
+

data/lib/rubype.rb

@@ -1,5 +1,3 @@
-require "rubype/rubype"
-
 # Builtin Contracts
 class  Any;     end
 module Boolean; end
@@ -13,14 +11,15 @@ class Module
     @__rubype__
   end
 
+  # @param hash [Hash] {method_name: [ArgClass1, ArgClass2, ... ArgClassn => RtnClass]}
   def typesig(hash)
     meth = hash.keys.first
     *arg_types, type_pair = hash.values.first
 
     __rubype__.send(:define_method, meth) do |*args, &block|
-      ::Rubype.assert_arg_type(meth, args, arg_types << type_pair.keys.first)
+      ::Rubype.send(:assert_arg_type, meth, args, arg_types << type_pair.keys.first)
       rtn = super(*args, &block)
-      ::Rubype.assert_trn_type(meth, rtn, type_pair.values.first)
+      ::Rubype.send(:assert_trn_type, meth, rtn, type_pair.values.first)
       rtn
     end
     self
@@ -29,6 +28,11 @@ end
 
 module Rubype
   class << self
+    private
+
+    # @param meth [Symbol]
+    # @param args [Array<Object>]
+    # @param klasses [Array<Class>]
     def assert_arg_type(meth, args, klasses)
       args.each_with_index do |arg, i|
         if wrong_type?(arg, klasses[i])
@@ -37,12 +41,18 @@ module Rubype
       end
     end
 
+    # @param meth [Symbol]
+    # @param rtn [Object]
+    # @param klass [Class]
     def assert_trn_type(meth, rtn, klass)
       if wrong_type?(rtn, klass)
         raise TypeError, "Expected #{meth} to return #{klass} but got #{rtn.inspect} instead"
       end
     end
 
+    # @param obj [Object]
+    # @param klass [Class]
+    # @return [Boolean]
     def wrong_type?(obj, klass)
       !(obj.is_a?(klass) || klass == Any)
     end

data/lib/rubype/version.rb

@@ -1,3 +1,3 @@
 module Rubype
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubype
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - gogotanaka