overloader 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ae0b6a1e018a6dc49298c7333333f5b780395c08d6050696d466e67071bdaf5
-  data.tar.gz: e796b18cc593dc6ac014185e45a86a8b3f17f7de9764ee5da465ced12e445c10
+  metadata.gz: daa6e411ef5ed471ff9ece81500cb7ba07197141f8b031b2870636953c634b6a
+  data.tar.gz: e7cff143d64a4bf06213def2ffacfee00286e1b7a82be2479fc695714500a749
 SHA512:
-  metadata.gz: d7287ffa69f2c273324acd514fa011f5a4834a16ee970310e452adec5a206325b43a8c3a213332b7046826ff075791e34e2e8ab7391c47c12452842834d4222d
-  data.tar.gz: 0c11df4506fdcf596a5be17f5a067759f513c6ed32bb19b711b564c5a0a66fc0f4091ba85a866e2a6e590777fca6f9897eb68aabb4030d3ed4736f1c9c00b3c2
+  metadata.gz: 85da59bc8d15f1fa5497d65a0d03b2a525f1123e037aff1b122d50a81772f9ea84c0ad2384e869e8101ee4e69b0aebaa968bac25cc82df06b9b587e05945a590
+  data.tar.gz: '019a49943d9ede03c0dbc3679b1c0d90160601f72d377171b80e39d1487796fc8e3c6b94fe7af008c4baf2fb74a2fc2038dce79f73f01cce4973467640eecd54'

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/ruby-signature"]
+	path = vendor/ruby-signature
+	url = https://github.com/ruby/ruby-signature.git

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.6.5
+  - 2.7.0
+  - ruby-head

data/Gemfile

@@ -2,3 +2,7 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in overloader.gemspec
 gemspec
+
+gem 'ruby-signature', path: 'vendor/ruby-signature'
+gem 'ruby2_keywords'
+gem 'racc'

data/README.md

@@ -2,6 +2,8 @@
 
 Overload for Ruby
 
+# DO NOT USE THIS LIBRARY FOR PRODUCTION
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -38,6 +40,45 @@ p a.foo(1) # => "one args"
 p a.foo(1, 2) # => "two args"
 ```
 
+## Advanced Usage: types
+
+You can define overload with types.
+
+This feature requires the following things.
+
+* Ruby 2.7 or greater
+* [ruby-signature](https://github.com/ruby/ruby-signature) gem
+  * This gem has not been published to RubyGems.org. So you need to install it manually.
+
+First, add `require 'overloader/type'`.
+Then, define the method type with RBS syntax. https://github.com/ruby/ruby-signature
+
+
+```ruby
+require 'overloader'
+require 'overloader/type'
+
+class A
+  extend Overloader
+  overload do
+    # (String, Integer) -> untyped
+    def foo(x, y) 'str int' end
+
+    # (Integer, String) -> untyped
+    def foo(x, y) 'int str' end
+
+    # (Symbol, Symbol) -> untyped
+    def foo(x, y) 'sym sym' end
+  end
+end
+
+a = A.new
+p a.foo('bar', 42) # => "str int"
+p a.foo(42, 'baz') # => "int str"
+p a.foo(:a, :b)    # => "sym sym"
+p a.foo(:a, 42)    # => ArgumentError
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,6 +1,11 @@
 require "bundler/gem_tasks"
 require 'rake/testtask'
-task :default => :test
+task :default => [:build_deps, :test]
+
+task :build_deps do
+  sh 'bundle check || bundle install', chdir: 'vendor/ruby-signature'
+  sh 'bundle exec rake parser', chdir: 'vendor/ruby-signature'
+end
 
 Rake::TestTask.new do |test|
   test.libs << 'test'

data/lib/overloader/ast_ext.rb

@@ -20,6 +20,20 @@ module Overloader
         file_content(path)[first_index(path)..last_index(path)]
       end
 
+      def comment(content: nil, path: nil)
+        raise ArgumentError.new("content or path is required") unless content || path
+
+        content ||= file_content(path)
+        l = first_lineno - 2
+
+        res = []
+        while (comment = content.lines[l])&.match?(/^\s*#/)
+          res.unshift comment
+          l -= 1
+        end
+        res.empty? ? nil : res.join
+      end
+
       # method node ext
 
       def method_body

data/lib/overloader/core.rb

@@ -3,7 +3,7 @@ module Overloader
     using AstExt
 
     def self.define_overload(klass, proc)
-      self.new(klass, proc).define_overload
+      new(klass, proc).define_overload
     end
 
     def initialize(klass, proc)
@@ -25,7 +25,7 @@ module Overloader
           def __#{name}_#{index}_checker_inner(#{args_source}) end
           def __#{name}_#{index}_checker(*args)
             __#{name}_#{index}_checker_inner(*args)
-            true
+            #{type_check_code(def_node, name)}
           rescue ArgumentError
             false
           end
@@ -51,6 +51,17 @@ module Overloader
       end
     end
 
+    def type_check_code(def_node, method_name)
+      return 'true' unless defined?(::Overloader::Type)
+
+      comment = def_node.comment(path: absolute_path)
+      return 'true' unless comment
+
+      type = comment.sub(/^\s*#/, '')
+
+      "::Overloader::Type.callable?(#{type.dump}, self.class, #{method_name.inspect}, *args)"
+    end
+
     private def absolute_path
       @proc.source_location[0]
     end

data/lib/overloader/type/checker.rb

@@ -0,0 +1,46 @@
+module Overloader
+  module Type
+    class Checker
+      def initialize(type:, klass:)
+        @type = type
+        @klass = klass
+      end
+
+      def self.env
+        @env ||= begin
+                   loader = Ruby::Signature::EnvironmentLoader.new
+                   Ruby::Signature::Environment.new.tap do |env|
+                     loader.load(env: env)
+                   end
+                 end
+      end
+
+      def self.builder
+        Ruby::Signature::DefinitionBuilder.new(env: env)
+      end
+
+      ruby2_keywords def errors(method_name, *args)
+        call = Ruby::Signature::Test::CallTrace.new(
+          method_call: Ruby::Signature::Test::ArgumentsReturn.new(arguments: args, return_value: nil, exception: nil),
+          block_calls: [],
+          block_given: false,
+        )
+        errors = type_check.method_call(method_name, method_type, call, errors: [])
+
+        errors.reject { |e| e.is_a?(Ruby::Signature::Test::Errors::ReturnTypeError) }
+      end
+
+      private def method_type
+        Ruby::Signature::Parser.parse_method_type(type)
+      end
+
+      private def type_check
+        Ruby::Signature::Test::TypeCheck.new(self_class: klass, builder: self.class.builder)
+      end
+
+
+      private
+      attr_reader :type, :klass
+    end
+  end
+end

data/lib/overloader/type.rb

@@ -0,0 +1,23 @@
+gem 'ruby-signature'
+gem 'ruby2_keywords'
+require 'ruby/signature'
+require 'ruby/signature/test'
+require 'ruby2_keywords'
+
+require_relative 'type/checker'
+
+module Overloader
+  module Type
+    CHECKERS = {}
+    extend self
+
+    ruby2_keywords def callable?(type, klass, method_name, *args)
+      checker = checker(klass: klass, type: type)
+      checker.errors(method_name, *args).empty?
+    end
+
+    private def checker(klass:, type:)
+      CHECKERS[[klass, type]] ||= Checker.new(type: type, klass: klass)
+    end
+  end
+end

data/lib/overloader/version.rb

@@ -1,3 +1,3 @@
 module Overloader
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/overloader.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 2.1.a"
+  spec.add_development_dependency "bundler", "< 3"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "minitest", "> 5"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: overloader
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Masataka Pocke Kuwabara
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-27 00:00:00.000000000 Z
+date: 2020-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.1.a
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.1.a
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -60,6 +60,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitmodules"
+- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
@@ -68,6 +70,8 @@ files:
 - lib/overloader.rb
 - lib/overloader/ast_ext.rb
 - lib/overloader/core.rb
+- lib/overloader/type.rb
+- lib/overloader/type/checker.rb
 - lib/overloader/version.rb
 - overloader.gemspec
 homepage: https://github.com/pocke/overloader