rbs 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2559e695400fc8d1c360aa80b1a9065f5ea0ae24b59faa91907102f7fc46d572
+  data.tar.gz: e32722dcf716317553827e15b3232e8971f3d613c3b2bd7f71a5b902e2fef8b3
+SHA512:
+  metadata.gz: c26e77f6a2506cf1414d12aa74e1783bf8f7ca40d5e803831c9deb2e8b290954db119bb89fa8d26a24b76e8713b26fdd6535e557e59788808addbc3e96a07ec8
+  data.tar.gz: 10a1e4a16e16f627bda62c565258b84bb830c7a85b0d74acbd9187094626b3e76eca4f8bacc5d77758755bfa82d5dacdd7dc6a374b53f3778d0421b449013d40

data/.github/workflows/ruby.yml

@@ -0,0 +1,28 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - master
+  pull_request: {}
+
+jobs:
+  test:
+    runs-on: "ubuntu-latest"
+    strategy:
+      matrix:
+        container_tag:
+        - master-nightly-bionic 
+        - 2.6.5-bionic
+        - 2.7.0-bionic
+    container:
+      image: rubylang/ruby:${{ matrix.container_tag }}
+    steps:
+    - uses: actions/checkout@v1
+    - name: Run test
+      run: |
+        ruby -v
+        gem install bundler
+        bin/setup
+        bundle exec rake
+        bundle exec rake build

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+/.ruby-version
+/lib/rbs/parser.rb
+/lib/rbs/parser.output
+/vendor/sigs

data/.rubocop.yml

@@ -0,0 +1,15 @@
+require: rubocop-rubycw
+AllCops:
+  TargetRubyVersion: 2.7
+  DisabledByDefault: true
+  Exclude:
+    - 'vendor/bundle/**/*'
+Rubycw/Rubycw:
+  Enabled: true
+  Exclude:
+    - 'test/**/*_test.rb'
+
+Lint/DuplicateMethods:
+  Enabled: true
+  Include:
+    - 'test/**/*_test.rb'

data/BSDL

@@ -0,0 +1,22 @@
+Copyright (C) 2019 Soutaro Matsumoto. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# CHANGELOG
+
+## master
+
+* The first release of RBS gem.
+
+## 0.1.0
+
+* Version 0.1.0 is the original `rbs` gem and it is different software from RBS.

data/COPYING

@@ -0,0 +1,56 @@
+ruby-signature is copyrighted free software by Soutaro Matsumoto <matsumoto@soutaro.com>.
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see the file BSDL), or the conditions below:
+
+1. You may make and give away verbatim copies of the source form of the
+   software without restriction, provided that you duplicate all of the
+   original copyright notices and associated disclaimers.
+
+2. You may modify your copy of the software in any way, provided that
+   you do at least ONE of the following:
+
+   a. place your modifications in the Public Domain or otherwise
+      make them Freely Available, such as by posting said
+      modifications to Usenet or an equivalent medium, or by allowing
+      the author to include your modifications in the software.
+
+   b. use the modified software only within your corporation or
+      organization.
+
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+3. You may distribute the software in object code or binary form,
+   provided that you do at least ONE of the following:
+
+   a. distribute the binaries and library files of the software,
+      together with instructions (in the manual page or equivalent)
+      on where to get the original distribution.
+
+   b. accompany the distribution with the machine-readable source of
+      the software.
+
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+4. You may modify and include the part of the software into any other
+   software (possibly commercial).  But some files in the distribution
+   are not written by the author, so that they are not under these terms.
+
+   For the list of those files and their copying conditions, see the
+   file LEGAL.
+
+5. The scripts and library files supplied as input to or produced as
+   output from the software do not automatically fall under the
+   copyright of the software, but belong to whomever generated them,
+   and may be sold commercially, and may be aggregated with this
+   software.
+
+6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+   IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+   PURPOSE.

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ruby-signature.gemspec
+gemspec
+
+gem "ruby-signature-amber", path: "test/assets/test-gem"

data/README.md

@@ -0,0 +1,93 @@
+# RBS
+
+RBS provides syntax and semantics definition for the `Ruby Signature` language, `.rbs` files.
+It consists of a parser, the syntax, and class definition interpreter, the semantics.
+
+## Build
+
+We haven't published a gem yet.
+You need to install the dependencies, and build its parser with `bin/setup`.
+
+```
+$ bin/setup
+$ bundle exec exe/rbs
+```
+
+## Usage
+
+```
+$ rbs list
+$ rbs ancestors ::Object
+$ rbs methods ::Object
+$ rbs method ::Object tap
+```
+
+### rbs [--class|--module|interface] list
+
+```
+$ rbs list
+```
+
+This command lists all of the classes/modules/interfaces defined in `.rbs` files.
+
+### rbs ancestors [--singleton|--instance] CLASS
+
+```
+$ rbs ancestors Array                    # ([].class.ancestors)
+$ rbs ancestors --singleton Array        # (Array.class.ancestors)
+```
+
+This command prints the _ancestors_ of the class.
+The name of the command is borrowed from `Class#ancestors`, but the semantics is a bit different.
+The `ancestors` command is more precise (I believe).
+
+### rbs methods [--singleton|--instance] CLASS
+
+```
+$ rbs methods ::Integer                  # 1.methods
+$ rbs methods --singleton ::Object       # Object.methods
+```
+
+This command prints all methods provided for the class.
+
+### rbs method [--singleton|--instance] CLASS METHOD
+
+```
+$ rbs method ::Integer '+'               # 1+2
+$ rbs method --singleton ::Object tap    # Object.tap { ... }
+```
+
+This command prints type and properties of the method.
+
+### Options
+
+It accepts two global options, `-r` and `-I`.
+
+`-r` is for libraries. You can specify the names of libraries.
+
+```
+$ rbs -r set list
+```
+
+`-I` is for application signatures. You can specify the name of directory.
+
+```
+$ rbs -I sig list
+```
+
+## Guides
+
+- [Standard library signature contribution guide](docs/CONTRIBUTING.md)
+- [Writing signatures guide](docs/sigs.md)
+- [Stdlib signatures guide](docs/stdlib.md)
+- [Syntax](docs/syntax.md)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/ruby-signature.

data/Rakefile

@@ -0,0 +1,142 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"].reject do |path|
+    path =~ %r{test/stdlib/}
+  end
+end
+
+multitask :default => [:test, :stdlib_test, :rubocop, :validate]
+
+task :validate => :parser do
+  sh "rbs validate"
+end
+
+FileList["test/stdlib/**/*_test.rb"].each do |test|
+  multitask test => :parser do
+    sh "ruby bin/test_runner.rb #{test}"
+  end
+  multitask stdlib_test: test
+end
+
+task :rubocop do
+  sh "rubocop --parallel"
+end
+
+rule ".rb" => ".y" do |t|
+  sh "racc -v -o #{t.name} #{t.source}"
+end
+
+task :parser => "lib/rbs/parser.rb"
+task :test => :parser
+task :stdlib_test => :parser
+task :build => :parser
+
+namespace :generate do
+  task :stdlib_test, [:class] do |_task, args|
+    klass = args.fetch(:class) do
+      raise "Class name is necessary. e.g. rake 'generate:stdlib_test[String]'"
+    end
+
+    path = Pathname("test/stdlib/#{klass}_test.rb")
+    raise "#{path} already exists!" if path.exist?
+
+    require "erb"
+    require "ruby/signature"
+
+    class TestTemplateBuilder
+      attr_reader :klass, :env
+
+      def initialize(klass)
+        @klass = klass
+
+        @env = Ruby::Signature::Environment.new
+        Ruby::Signature::EnvironmentLoader.new.load(env: @env)
+      end
+
+      def call
+        ERB.new(<<~ERB, trim_mode: "-").result(binding)
+          require_relative "test_helper"
+
+          class <%= klass %>Test < StdlibTest
+            target <%= klass %>
+            # library "pathname", "set", "securerandom"     # Declare library signatures to load
+            using hook.refinement
+          <%- class_methods.each do |method_name, definition| %>
+            def test_class_method_<%= test_name_for(method_name) %>
+            <%- definition.method_types.each do |method_type| -%>
+              # <%= method_type %>
+              <%= klass %>.<%= method_name %>
+            <%- end -%>
+            end
+          <%- end -%>
+          <%- instance_methods.each do |method_name, definition| %>
+            def test_<%= test_name_for(method_name) %>
+            <%- definition.method_types.each do |method_type| -%>
+              # <%= method_type %>
+              <%= klass %>.new.<%= method_name %>
+            <%- end -%>
+            end
+          <%- end -%>
+          end
+        ERB
+      end
+
+      private
+
+      def test_name_for(method_name)
+        {
+          :==  => 'double_equal',
+          :!=  => 'not_equal',
+          :=== => 'triple_equal',
+          :[]  => 'square_bracket',
+          :[]= => 'square_bracket_assign',
+          :>   => 'greater_than',
+          :<   => 'less_than',
+          :>=  => 'greater_than_equal_to',
+          :<=  => 'less_than_equal_to',
+          :<=> => 'spaceship',
+          :+   => 'plus',
+          :-   => 'minus',
+          :*   => 'multiply',
+          :/   => 'divide',
+          :**  => 'power',
+          :%   => 'modulus',
+          :&   => 'and',
+          :|   => 'or',
+          :^   => 'xor',
+          :>>  => 'right_shift',
+          :<<  => 'left_shift',
+          :=~  => 'pattern_match',
+          :!~  => 'does_not_match',
+          :~   => 'tilde'
+        }.fetch(method_name, method_name)
+      end
+
+      def type_name
+        @type_name ||= Ruby::Signature::TypeName.new(name: klass.to_sym, namespace: Ruby::Signature::Namespace.new(path: [], absolute: true))
+      end
+
+      def class_methods
+        @class_methods ||= Ruby::Signature::DefinitionBuilder.new(env: env).build_singleton(type_name).methods.select {|_, definition|
+          definition.implemented_in.name.absolute! == type_name
+        }
+      end
+
+      def instance_methods
+        @instance_methods ||= Ruby::Signature::DefinitionBuilder.new(env: env).build_instance(type_name).methods.select {|_, definition|
+          definition.implemented_in.name.absolute! == type_name
+        }
+      end
+    end
+
+    path.write TestTemplateBuilder.new(klass).call
+
+    puts "Created: #{path}"
+  end
+end
+
+CLEAN.include("lib/rbs/parser.rb")

data/bin/annotate-with-rdoc

@@ -0,0 +1,157 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rbs"
+require "rdoc"
+
+def store_for_class(name, stores:)
+  stores.find do |store|
+    store.find_class_named(name) || store.find_module_named(name)
+  end
+end
+
+def format_comment(comment)
+  out = RDoc::Markup::Document.new
+  out << comment
+  formatter = RDoc::Markup::ToMarkdown.new
+  out.accept(formatter)
+end
+
+def comment_for_constant(decl, stores:)
+  class_name = decl.name.namespace.to_type_name.to_s
+  klass = store_for_class(class_name, stores: stores)&.yield_self {|store|
+    store.find_class_named(class_name) || store.find_module_named(class_name)
+  }
+
+  if klass
+    constant = klass.constants.find do |const|
+      const.name == decl.name.name.to_s
+    end
+
+    if constant&.documented?
+      string = format_comment(constant.comment)
+      RBS::AST::Comment.new(location: nil, string: string)
+    end
+  end
+end
+
+def comment_for_class(decl, stores:)
+  name = decl.name.to_s
+  klass = store_for_class(name, stores: stores)&.yield_self {|store|
+    store.find_class_named(name) || store.find_module_named(name)
+  }
+
+  if klass&.documented?
+    string = format_comment(klass.comment)
+    RBS::AST::Comment.new(location: nil, string: string)
+  end
+end
+
+def comment_for_method(klass, method, stores:)
+  method = store_for_class(klass, stores: stores)&.load_method(klass, method)
+
+  if method&.documented?
+    out = RDoc::Markup::Document.new
+
+    out << method.comment
+
+    if method.arglists
+      out << RDoc::Markup::Heading.new(1, "arglists 💪👽🚨 << Delete this section")
+      arglists = method.arglists.chomp.split("\n").map {|line| line + "\n" }
+      out << RDoc::Markup::Verbatim.new(*arglists)
+    end
+
+    string = out.accept(RDoc::Markup::ToMarkdown.new)
+    RBS::AST::Comment.new(location: nil, string: string)
+  end
+
+rescue RDoc::Store::MissingFileError
+  puts "  👺 No document found for #{klass}#{method}"
+  nil
+end
+
+if ARGV.empty?
+  puts 'annotate-with-rdoc [RBS files...]'
+  exit
+end
+
+def print_members(stores, klass_name, members)
+  members.each do |member|
+    case member
+    when RBS::AST::Members::MethodDefinition
+      puts "    Processing #{member.name}..."
+
+      method_name = case
+                    when member.instance?
+                      "##{member.name}"
+                    when member.singleton?
+                      "::#{member.name}"
+                    end
+
+      comment = comment_for_method(klass_name, method_name, stores: stores)
+
+      unless comment
+        if member.instance? && member.name == :initialize
+          comment = comment_for_method(klass_name, '::new', stores: stores)
+        end
+      end
+
+      member.instance_variable_set(:@comment, comment)
+    when RBS::AST::Members::AttrReader, RBS::AST::Members::AttrAccessor, RBS::AST::Members::AttrWriter
+      puts "    👻 Attributes not supported (#{klass_name})"
+    when RBS::AST::Members::Alias
+      puts "    Processing #{member.new_name}(alias)..."
+      prefix = case
+               when member.instance?
+                 "#"
+               when member.singleton?
+                 "."
+               end
+      name = "#{prefix}#{member.new_name}"
+
+      comment = comment_for_method(klass_name, name, stores: stores)
+      member.instance_variable_set(:@comment, comment)
+    end
+  end
+end
+
+stores = []
+RDoc::RI::Paths.each true, true, false, false do |path, type|
+  puts "Loading store from #{path}..."
+  store = RDoc::RI::Store.new(path, type)
+  store.load_all
+  stores << store
+end
+
+ARGV.map {|f| Pathname(f) }.each do |path|
+  puts "Opening #{path}..."
+
+  buffer = RBS::Buffer.new(name: path, content: path.read)
+  sigs = RBS::Parser.parse_signature(buffer)
+
+  sigs.each do |decl|
+    case decl
+    when RBS::AST::Declarations::Constant
+      puts "  Importing documentation for #{decl.name}..."
+      comment = comment_for_constant(decl, stores: stores)
+      decl.instance_variable_set(:@comment, comment)
+    when RBS::AST::Declarations::Class, RBS::AST::Declarations::Module
+      puts "  Importing documentation for #{decl.name}..."
+      comment = comment_for_class(decl, stores: stores)
+      decl.instance_variable_set(:@comment, comment)
+
+      print_members stores, decl.name.to_s, decl.members
+    when RBS::AST::Declarations::Extension
+      puts "  Importing documentation for #{decl.name} (#{decl.extension_name})"
+
+      print_members stores, decl.name.to_s, decl.members
+    end
+  end
+
+  puts "Writing #{path}..."
+  path.open('w') do |out|
+    writer = RBS::Writer.new(out: out)
+    writer.write sigs
+  end
+end
+