rubype 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8245a625a95d3dc343ff7fc3b8b174ade30da9a3
-  data.tar.gz: cd5dc17e64353d10ce7edd75e99be2042346ea04
+  metadata.gz: 8d3acd50cc84b3a88ae2270111796825a1d7b916
+  data.tar.gz: 53745d33a11a70db20b39199df8cd54115cf3e6e
 SHA512:
-  metadata.gz: 69b14ea4de852e73345b8c91317b0625afd0244fde38f019fa4590beac853e2c52f624571cba7506e5dfde740a3f55454b1580332dec45b8c4db82b0b3b65b55
-  data.tar.gz: 59bcb2b702a7c9fbf2a9b9e2d48dcea0cdff1ad4116bff6b260648e046b2cae2e0c7ee3245b0a8ec4905b3a80f187817ad0b55e2e356b8cf88b079f570b2feeb
+  metadata.gz: 28374048f7e03c8611d69d1cc6ee842ed93e0cda775968f0e9f4d1e7da31f29a6694fd136445d8c93864403fa0ed97001bc08cdbeb14d85447326c81070829e8
+  data.tar.gz: b0faae01aa81746ca428efd63993969b6f4c4d4f8437b5a4fd76051b7bd7ecf48f1cd78bed70bb2470a140c57dcbe8dd161c0b27bc41bc023a282c799f4ccc51

data/.travis.yml

@@ -1,3 +1,7 @@
 language: ruby
 rvm:
   - 2.1.2
+  - 2.0.0
+  - 1.9.3
+notifications:
+  email: false

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in rubype.gemspec
+gem 'pry'
 gemspec

data/README.md

@@ -1,31 +1,116 @@
-# Rubype
+# Ruby with Type.
 
-TODO: Write a gem description
+Matz has mentioned Ruby3.0 with static type at some confluences. But almost all rubyists(include me) are not sure how typed Ruby is.
 
-## Installation
+But it's worth thinking more. This gem is kind of trial without so much side-effect.
+
+```rb
+require 'rubype'
+
+# ex1
+class MyClass
+  def sum(x, y)
+    x + y
+  end
+  type Numeric, Numeric >= Numeric, :sum
+
+  def wrong_sum(x, y)
+    'string'
+  end
+  type Numeric, Numeric >= Numeric, :sum
+end
+
+MyClass.new.sum(1, 2)
+#=> 3
+
+MyClass.new.sum(1, 'string')
+#=> ArgumentError: Wrong type of argument, type of "str" should be Numeric
+
+MyClass.new.wrong_sum(1, 2)
+#=> TypeError: Expected wrong_sum to return Numeric but got "str" instead
+
+# ex2: (Ruby 2.1.0+)
+class MyClass
+  type Numeric, Numeric >= Numeric, def sum(x, y)
+    x + y
+  end
+
+  type Numeric, Numeric >= Numeric, def wrong_sum(x, y)
+    'string'
+  end
+end
+
+# ex3: (Ruby 2.1.0+)
+class People
+  type People >= Any, def marry(people)
+    # Your Ruby code as usual
+  end
+end
+
+People.new.marry(People.new)
+#=> no error
+
+People.new.marry('non people')
+#=> ArgumentError: Wrong type of argument, type of "non people" should be People
+```
 
-Add this line to your application's Gemfile:
+## Feature
+### Typed method can coexist with non-typed method
 
 ```ruby
-gem 'rubype'
+# It's totally OK!!
+class MyClass
+  def sum(x, y)
+    x + y
+  end
+  type Numeric, Numeric >= Numeric, :sum
+
+  def wrong_sum(x, y)
+    'string'
+  end
+end
+```
+
+### Duck typing
+
+```ruby
+
+class MyClass
+  def foo(any_obj)
+    1
+  end
+  type Any >= Numeric, :foo
+end
+
+# It's totally OK!!
+MyClass.new.foo(1)
+# It's totally OK!!
+MyClass.new.foo('str')
 ```
 
-And then execute:
+## Installation
+
+gem install rubype or add gem 'rubype' to your Gemfile.
+
+This gem requires Ruby 2.0.0+.
+
+### Contributing
+
+Fork it ( https://github.com/[my-github-username]/rubype/fork )
+
+Create your feature branch (`git checkout -b my-new-feature`)
 
-    $ bundle
+    $ bundle install --path vendor/bundle
 
-Or install it yourself as:
+Commit your changes (`git commit -am 'Add some feature'`)
 
-    $ gem install rubype
+    $ bundle exec rake test
 
-## Usage
+    > 5 runs, 39 assertions, 0 failures, 0 errors, 0 skips
 
-TODO: Write usage instructions here
+Push to the branch (`git push origin my-new-feature`)
 
-## Contributing
+Create a new Pull Request
 
-1. Fork it ( https://github.com/[my-github-username]/rubype/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+## Credits
+[@chancancode](https://github.com/chancancode) first brought this to my attention. I've stolen some idea from him.

data/lib/rubype/type_pair.rb

@@ -0,0 +1,7 @@
+class TypePair < Struct.new(:last_arg_type, :rtn_type); end
+
+class Module
+  def >=(r)
+    TypePair.new(self, r)
+  end
+end

data/lib/rubype/version.rb

@@ -1,3 +1,3 @@
 module Rubype
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/rubype.rb

@@ -1,6 +1,49 @@
-require "rubype/version"
-require "rubype/rubype"
+require 'rubype/type_pair'
+
+# Builtin Contracts
+class  Any;     end
+module Boolean; end
+TrueClass.send(:include, Boolean)
+FalseClass.send(:include, Boolean)
+
+class Module
+  private
+  def __rubype__
+    prepend (@__rubype__ = Module.new) unless @__rubype__
+    @__rubype__
+  end
+
+  def type(*arguments)
+    *arg_types, type_pair, meth = arguments
+
+    __rubype__.send(:define_method, meth) do |*args, &block|
+      ::Rubype.assert_arg_type(meth, args, arg_types << type_pair.last_arg_type)
+      rtn = super(*args, &block)
+      ::Rubype.assert_trn_type(meth, rtn, type_pair.rtn_type)
+      rtn
+    end
+    self
+  end
+end
 
 module Rubype
-  # Your code goes here...
+  class << self
+    def assert_arg_type(meth, args, klasses)
+      args.each_with_index do |arg, i|
+        if wrong_type?(arg, klasses[i])
+          raise ArgumentError, "Wrong type of argument, type of #{arg.inspect} should be #{klasses[i]}"
+        end
+      end
+    end
+
+    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
+
+    def wrong_type?(obj, klass)
+      !(obj.is_a?(klass) || klass == Any)
+    end
+  end
 end

data/rubype.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ["gogotanaka"]
   spec.email         = ["mail@tanakakazuki.com"]
   spec.extensions    = ["ext/rubype/extconf.rb"]
-  spec.summary       = %q{ Ruby with typed method.}
-  spec.description   = %q{ Ruby with typed method.}
-  spec.homepage      = ""
+  spec.summary       = %q{Ruby with type.}
+  spec.description   = %q{Ruby with type.}
+  spec.homepage      = "http://azabuhs.org/"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rake-compiler"
   spec.add_development_dependency "minitest"
 end

data/test/test_rubype.rb

@@ -1,11 +1,113 @@
 require 'minitest_helper'
-
+class TypePair
+  def to_s
+    "#{last_arg_type} >= #{rtn_type}"
+  end
+end
 class TestRubype < MiniTest::Unit::TestCase
-  def test_that_it_has_a_version_number
-    refute_nil ::Rubype::VERSION
+  def setup
+    @string  = 'str'
+    @numeric = 1
+    @symbol  = :test
+    @array   = [1, 2, 3]
+    @hash    = { test: :hash }
+  end
+
+  def test_type_list
+    assert_equal_to_s "Numeric >= Numeric", Numeric >= Numeric
+    assert_equal_to_s "Numeric >= Array", Numeric >= Array
+    assert_equal_to_s "Array >= String", Array >= String
+  end
+
+  def test_correct_type
+    assert_correct_type [Numeric >= Numeric], [@numeric], @numeric
+    assert_correct_type [Numeric >= Array  ], [@numeric], @array
+    assert_correct_type [Numeric >= String ], [@numeric], @string
+    assert_correct_type [Numeric >= Hash   ], [@numeric], @hash
+    assert_correct_type [Numeric >= Symbol ], [@numeric], @symbol
+    assert_correct_type [Numeric >= Boolean], [@numeric], true
+    assert_correct_type [Numeric >= Boolean], [@numeric], false
+
+    assert_correct_type [Boolean, Numeric >= Numeric], [true, @numeric], @numeric
+    assert_correct_type [Boolean, Array   >= Array  ], [true, @array  ], @array
+    assert_correct_type [Boolean, String  >= String ], [true, @string ], @string
+    assert_correct_type [Boolean, Hash    >= Hash   ], [true, @hash   ], @hash
+    assert_correct_type [Boolean, Symbol  >= Symbol ], [true, @symbol ], @symbol
+  end
+
+  def test_wrong_return_type
+    assert_wrong_rtn [Numeric >= Numeric], [@numeric], @array
+    assert_wrong_rtn [Numeric >= Numeric], [@numeric], @string
+    assert_wrong_rtn [Numeric >= Numeric], [@numeric], @hash
+    assert_wrong_rtn [Numeric >= Numeric], [@numeric], @symbol
+    assert_wrong_rtn [Numeric >= Numeric], [@numeric], true
+
+    assert_wrong_rtn [Numeric, Numeric >= Numeric], [@numeric, @numeric], @array
+    assert_wrong_rtn [Numeric, Numeric >= Numeric], [@numeric, @numeric], @string
+    assert_wrong_rtn [Numeric, Numeric >= Numeric], [@numeric, @numeric], @hash
+    assert_wrong_rtn [Numeric, Numeric >= Numeric], [@numeric, @numeric], @symbol
+    assert_wrong_rtn [Numeric, Numeric >= Numeric], [@numeric, @numeric], true
   end
 
-  def test_it_does_something_useful
-    assert false
+  def test_wrong_args_type
+    assert_wrong_arg [Numeric >= Numeric], [@array ], @numeric
+    assert_wrong_arg [Numeric >= Numeric], [@string], @numeric
+    assert_wrong_arg [Numeric >= Numeric], [@hash  ], @numeric
+    assert_wrong_arg [Numeric >= Numeric], [@symbol], @numeric
+    assert_wrong_arg [Numeric >= Numeric], [true   ], @numeric
+
+    assert_wrong_arg [Numeric, Numeric >= Numeric], [@numeric, @array ], @numeric
+    assert_wrong_arg [Numeric, Numeric >= Numeric], [@numeric, @string], @numeric
+    assert_wrong_arg [Numeric, Numeric >= Numeric], [@numeric, @hash  ], @numeric
+    assert_wrong_arg [Numeric, Numeric >= Numeric], [@numeric, @symbol], @numeric
+    assert_wrong_arg [Numeric, Numeric >= Numeric], [@numeric, true   ], @numeric
   end
+
+  def test_any
+    assert_correct_type [Any >= Any], [@array ], @numeric
+    assert_correct_type [Any >= Any], [@string], @numeric
+    assert_correct_type [Any >= Any], [@hash  ], @numeric
+    assert_correct_type [Any >= Any], [@symbol], @numeric
+
+    assert_correct_type [Any, Any >= Any], [@numeric, @array ], @numeric
+    assert_correct_type [Any, Any >= Any], [@numeric, @string], @numeric
+    assert_correct_type [Any, Any >= Any], [@numeric, @hash  ], @numeric
+    assert_correct_type [Any, Any >= Any], [@numeric, @symbol], @numeric
+  end
+
+  private
+    def assert_equal_to_s(str, val)
+      assert_equal str, val.to_s
+    end
+
+    def assert_correct_type(type_list, args, val)
+      assert_equal val, define_test_method(type_list, args, val).call(*args)
+    end
+
+    def assert_wrong_arg(type_list, args, val)
+      assert_raises(ArgumentError) { define_test_method(type_list, args, val).call(*args) }
+    end
+
+    def assert_wrong_rtn(type_list, args, val)
+      assert_raises(TypeError) { define_test_method(type_list, args, val).call(*args) }
+    end
+
+    def define_test_method(type_list, args, val)
+      klass = Class.new.class_eval <<-RUBY_CODE
+        def call(#{arg_literal(args.count)})
+          #{obj_literal(val)}
+        end
+        type #{type_list.map(&:to_s).join(',')}, :call
+      RUBY_CODE
+
+      klass.new
+    end
+
+    def obj_literal(obj)
+      "ObjectSpace._id2ref(#{obj.__id__})"
+    end
+
+    def arg_literal(count)
+      ('a'..'z').to_a[0..count-1].join(',')
+    end
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rubype
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - gogotanaka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-05 00:00:00.000000000 Z
+date: 2014-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: " Ruby with typed method."
+description: Ruby with type.
 email:
 - mail@tanakakazuki.com
 executables:
@@ -86,11 +86,12 @@ files:
 - ext/rubype/rubype.c
 - ext/rubype/rubype.h
 - lib/rubype.rb
+- lib/rubype/type_pair.rb
 - lib/rubype/version.rb
 - rubype.gemspec
 - test/minitest_helper.rb
 - test/test_rubype.rb
-homepage: ''
+homepage: http://azabuhs.org/
 licenses:
 - MIT
 metadata: {}
@@ -113,7 +114,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Ruby with typed method.
+summary: Ruby with type.
 test_files:
 - test/minitest_helper.rb
 - test/test_rubype.rb