rbs 0.2.0

data/lib/ruby/signature.rb

@@ -0,0 +1,7 @@
+STDERR.puts "🚨🚨 ruby-signature is renamed to rbs. require 'rbs' instead of 'ruby/signature'. 🚨🚨"
+
+require "rbs"
+
+module Ruby
+  Signature = RBS
+end

data/rbs.gemspec

@@ -0,0 +1,46 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rbs/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rbs"
+  spec.version       = RBS::VERSION
+  spec.authors       = ["Soutaro Matsumoto"]
+  spec.email         = ["matsumoto@soutaro.com"]
+
+  spec.summary       = %q{Type signature for Ruby.}
+  spec.description   = %q{RBS is the language for type signatures for Ruby and standard library definitions.}
+  spec.homepage      = "https://github.com/ruby/rbs"
+  spec.licenses      = ['BSD-2-Clause', 'Ruby']
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/ruby/rbs.git"
+    spec.metadata["changelog_uri"] = "https://github.com/ruby/rbs/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.files << "lib/rbs/parser.rb"
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "racc", "~> 1.4.16"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-rubycw"
+  spec.add_development_dependency "minitest-reporters", "~> 1.3.6"
+  spec.add_development_dependency "json", "~> 2.3.0"
+end

data/stdlib/abbrev/abbrev.rbs

@@ -0,0 +1,60 @@
+# Calculates the set of unambiguous abbreviations for a given set of strings.
+#
+#     require 'abbrev'
+#     require 'pp'
+#
+#     pp Abbrev.abbrev(['ruby'])
+#     #=>  {"ruby"=>"ruby", "rub"=>"ruby", "ru"=>"ruby", "r"=>"ruby"}
+#
+#     pp Abbrev.abbrev(%w{ ruby rules })
+#
+# *Generates:*
+#     { "ruby"  =>  "ruby",
+#       "rub"   =>  "ruby",
+#       "rules" =>  "rules",
+#       "rule"  =>  "rules",
+#       "rul"   =>  "rules" }
+#
+# It also provides an array core extension, Array#abbrev.
+#
+#     pp %w{ summer winter }.abbrev
+#
+# *Generates:*
+#     { "summer"  => "summer",
+#       "summe"   => "summer",
+#       "summ"    => "summer",
+#       "sum"     => "summer",
+#       "su"      => "summer",
+#       "s"       => "summer",
+#       "winter"  => "winter",
+#       "winte"   => "winter",
+#       "wint"    => "winter",
+#       "win"     => "winter",
+#       "wi"      => "winter",
+#       "w"       => "winter" }
+#
+module Abbrev
+  # Given a set of strings, calculate the set of unambiguous abbreviations for
+  # those strings, and return a hash where the keys are all the possible
+  # abbreviations and the values are the full strings.
+  #
+  # Thus, given `words` is "car" and "cone", the keys pointing to "car" would be
+  # "ca" and "car", while those pointing to "cone" would be "co", "con", and
+  # "cone".
+  #
+  #     require 'abbrev'
+  #
+  #     Abbrev.abbrev(%w{ car cone })
+  #     #=> {"ca"=>"car", "con"=>"cone", "co"=>"cone", "car"=>"car", "cone"=>"cone"}
+  #
+  # The optional `pattern` parameter is a pattern or a string. Only input strings
+  # that match the pattern or start with the string are included in the output
+  # hash.
+  #
+  #     Abbrev.abbrev(%w{car box cone crab}, /b/)
+  #     #=> {"box"=>"box", "bo"=>"box", "b"=>"box", "crab" => "crab"}
+  #
+  #     Abbrev.abbrev(%w{car box cone}, 'ca')
+  #     #=> {"car"=>"car", "ca"=>"car"}
+  def self?.abbrev: (Array[String], ?String | Regexp | nil) -> Hash[String, String]
+end

data/stdlib/base64/base64.rbs

@@ -0,0 +1,71 @@
+# The Base64 module provides for the encoding (#encode64, #strict_encode64,
+# #urlsafe_encode64) and decoding (#decode64, #strict_decode64,
+# #urlsafe_decode64) of binary data using a Base64 representation.
+#
+# ## Example
+#
+# A simple encoding and decoding.
+#
+#     require "base64"
+#
+#     enc   = Base64.encode64('Send reinforcements')
+#                         # -> "U2VuZCByZWluZm9yY2VtZW50cw==\n"
+#     plain = Base64.decode64(enc)
+#                         # -> "Send reinforcements"
+#
+# The purpose of using base64 to encode data is that it translates any binary
+# data into purely printable characters.
+#
+module Base64
+  # Returns the Base64-decoded version of `str`. This method complies with RFC
+  # 2045. Characters outside the base alphabet are ignored.
+  #
+  #     require 'base64'
+  #     str = 'VGhpcyBpcyBsaW5lIG9uZQpUaGlzIG' +
+  #           'lzIGxpbmUgdHdvClRoaXMgaXMgbGlu' +
+  #           'ZSB0aHJlZQpBbmQgc28gb24uLi4K'
+  #     puts Base64.decode64(str)
+  #
+  # *Generates:*
+  #
+  #     This is line one
+  #     This is line two
+  #     This is line three
+  #     And so on...
+  def self?.decode64: (String str) -> String
+
+  # Returns the Base64-encoded version of `bin`. This method complies with RFC
+  # 2045. Line feeds are added to every 60 encoded characters.
+  #
+  #     require 'base64'
+  #     Base64.encode64("Now is the time for all good coders\nto learn Ruby")
+  #
+  # *Generates:*
+  #
+  #     Tm93IGlzIHRoZSB0aW1lIGZvciBhbGwgZ29vZCBjb2RlcnMKdG8gbGVhcm4g
+  #     UnVieQ==
+  def self?.encode64: (String bin) -> String
+
+  # Returns the Base64-decoded version of `str`. This method complies with RFC
+  # 4648. ArgumentError is raised if `str` is incorrectly padded or contains
+  # non-alphabet characters.  Note that CR or LF are also rejected.
+  def self?.strict_decode64: (String str) -> String
+
+  # Returns the Base64-encoded version of `bin`. This method complies with RFC
+  # 4648. No line feeds are added.
+  def self?.strict_encode64: (String bin) -> String
+
+  # Returns the Base64-decoded version of `str`. This method complies with ``Base
+  # 64 Encoding with URL and Filename Safe Alphabet'' in RFC 4648. The alphabet
+  # uses '-' instead of '+' and '_' instead of '/'.
+  #
+  # The padding character is optional. This method accepts both correctly-padded
+  # and unpadded input. Note that it still rejects incorrectly-padded input.
+  def self?.urlsafe_decode64: (String str) -> String
+
+  # Returns the Base64-encoded version of `bin`. This method complies with ``Base
+  # 64 Encoding with URL and Filename Safe Alphabet'' in RFC 4648. The alphabet
+  # uses '-' instead of '+' and '_' instead of '/'. Note that the result can still
+  # contain '='. You can remove the padding by setting `padding` as false.
+  def self?.urlsafe_encode64: (String bin, ?padding: bool) -> String
+end

data/stdlib/benchmark/benchmark.rbs

@@ -0,0 +1,372 @@
+# The Benchmark module provides methods to measure and report the time used to
+# execute Ruby code.
+#
+# *   Measure the time to construct the string given by the expression
+#     `"a"*1_000_000_000`:
+#
+#         require 'benchmark'
+#
+#         puts Benchmark.measure { "a"*1_000_000_000 }
+#
+#     On my machine (OSX 10.8.3 on i5 1.7 GHz) this generates:
+#
+#         0.350000   0.400000   0.750000 (  0.835234)
+#
+#     This report shows the user CPU time, system CPU time, the sum of the user
+#     and system CPU times, and the elapsed real time. The unit of time is
+#     seconds.
+#
+# *   Do some experiments sequentially using the #bm method:
+#
+#         require 'benchmark'
+#
+#         n = 5000000
+#         Benchmark.bm do |x|
+#           x.report { for i in 1..n; a = "1"; end }
+#           x.report { n.times do   ; a = "1"; end }
+#           x.report { 1.upto(n) do ; a = "1"; end }
+#         end
+#
+#     The result:
+#
+#             user     system      total        real
+#         1.010000   0.000000   1.010000 (  1.014479)
+#         1.000000   0.000000   1.000000 (  0.998261)
+#         0.980000   0.000000   0.980000 (  0.981335)
+#
+# *   Continuing the previous example, put a label in each report:
+#
+#         require 'benchmark'
+#
+#         n = 5000000
+#         Benchmark.bm(7) do |x|
+#           x.report("for:")   { for i in 1..n; a = "1"; end }
+#           x.report("times:") { n.times do   ; a = "1"; end }
+#           x.report("upto:")  { 1.upto(n) do ; a = "1"; end }
+#         end
+#
+#
+# The result:
+#
+#                   user     system      total        real
+#     for:      1.010000   0.000000   1.010000 (  1.015688)
+#     times:    1.000000   0.000000   1.000000 (  1.003611)
+#     upto:     1.030000   0.000000   1.030000 (  1.028098)
+#
+# *   The times for some benchmarks depend on the order in which items are run. 
+#     These differences are due to the cost of memory allocation and garbage
+#     collection. To avoid these discrepancies, the #bmbm method is provided. 
+#     For example, to compare ways to sort an array of floats:
+#
+#         require 'benchmark'
+#
+#         array = (1..1000000).map { rand }
+#
+#         Benchmark.bmbm do |x|
+#           x.report("sort!") { array.dup.sort! }
+#           x.report("sort")  { array.dup.sort  }
+#         end
+#
+#     The result:
+#
+#         Rehearsal -----------------------------------------
+#         sort!   1.490000   0.010000   1.500000 (  1.490520)
+#         sort    1.460000   0.000000   1.460000 (  1.463025)
+#         -------------------------------- total: 2.960000sec
+#
+#                     user     system      total        real
+#         sort!   1.460000   0.000000   1.460000 (  1.460465)
+#         sort    1.450000   0.010000   1.460000 (  1.448327)
+#
+# *   Report statistics of sequential experiments with unique labels, using the
+#     #benchmark method:
+#
+#         require 'benchmark'
+#         include Benchmark         # we need the CAPTION and FORMAT constants
+#
+#         n = 5000000
+#         Benchmark.benchmark(CAPTION, 7, FORMAT, ">total:", ">avg:") do |x|
+#           tf = x.report("for:")   { for i in 1..n; a = "1"; end }
+#           tt = x.report("times:") { n.times do   ; a = "1"; end }
+#           tu = x.report("upto:")  { 1.upto(n) do ; a = "1"; end }
+#           [tf+tt+tu, (tf+tt+tu)/3]
+#         end
+#
+#     The result:
+#
+#                      user     system      total        real
+#         for:      0.950000   0.000000   0.950000 (  0.952039)
+#         times:    0.980000   0.000000   0.980000 (  0.984938)
+#         upto:     0.950000   0.000000   0.950000 (  0.946787)
+#         >total:   2.880000   0.000000   2.880000 (  2.883764)
+#         >avg:     0.960000   0.000000   0.960000 (  0.961255)
+#
+#
+module Benchmark
+  # Invokes the block with a Benchmark::Report object, which may be used to
+  # collect and report on the results of individual benchmark tests. Reserves
+  # `label_width` leading spaces for labels on each line. Prints `caption` at the
+  # top of the report, and uses `format` to format each line. Returns an array of
+  # Benchmark::Tms objects.
+  #
+  # If the block returns an array of Benchmark::Tms objects, these will be used to
+  # format additional lines of output. If `labels` parameter are given, these are
+  # used to label these extra lines.
+  #
+  # *Note*: Other methods provide a simpler interface to this one, and are
+  # suitable for nearly all benchmarking requirements.  See the examples in
+  # Benchmark, and the #bm and #bmbm methods.
+  #
+  # Example:
+  #
+  #     require 'benchmark'
+  #     include Benchmark          # we need the CAPTION and FORMAT constants
+  #
+  #     n = 5000000
+  #     Benchmark.benchmark(CAPTION, 7, FORMAT, ">total:", ">avg:") do |x|
+  #       tf = x.report("for:")   { for i in 1..n; a = "1"; end }
+  #       tt = x.report("times:") { n.times do   ; a = "1"; end }
+  #       tu = x.report("upto:")  { 1.upto(n) do ; a = "1"; end }
+  #       [tf+tt+tu, (tf+tt+tu)/3]
+  #     end
+  #
+  # Generates:
+  #
+  #                   user     system      total        real
+  #     for:      0.970000   0.000000   0.970000 (  0.970493)
+  #     times:    0.990000   0.000000   0.990000 (  0.989542)
+  #     upto:     0.970000   0.000000   0.970000 (  0.972854)
+  #     >total:   2.930000   0.000000   2.930000 (  2.932889)
+  #     >avg:     0.976667   0.000000   0.976667 (  0.977630)
+  #
+  def self?.benchmark: (String caption, ?Integer? label_width, ?String? format, *String labels) { (Report report) -> (Array[Tms] | void) } -> ::Array[Benchmark::Tms]
+
+  # A simple interface to the #benchmark method, #bm generates sequential reports
+  # with labels. `label_width` and `labels` parameters have the same meaning as
+  # for #benchmark.
+  #
+  #     require 'benchmark'
+  #
+  #     n = 5000000
+  #     Benchmark.bm(7) do |x|
+  #       x.report("for:")   { for i in 1..n; a = "1"; end }
+  #       x.report("times:") { n.times do   ; a = "1"; end }
+  #       x.report("upto:")  { 1.upto(n) do ; a = "1"; end }
+  #     end
+  #
+  # Generates:
+  #
+  #                   user     system      total        real
+  #     for:      0.960000   0.000000   0.960000 (  0.957966)
+  #     times:    0.960000   0.000000   0.960000 (  0.960423)
+  #     upto:     0.950000   0.000000   0.950000 (  0.954864)
+  #
+  def self?.bm: (?Integer label_width, *String labels) { (Report report) -> void } -> ::Array[Benchmark::Tms]
+
+  # Sometimes benchmark results are skewed because code executed earlier
+  # encounters different garbage collection overheads than that run later. #bmbm
+  # attempts to minimize this effect by running the tests twice, the first time as
+  # a rehearsal in order to get the runtime environment stable, the second time
+  # for real. GC.start is executed before the start of each of the real timings;
+  # the cost of this is not included in the timings. In reality, though, there's
+  # only so much that #bmbm can do, and the results are not guaranteed to be
+  # isolated from garbage collection and other effects.
+  #
+  # Because #bmbm takes two passes through the tests, it can calculate the
+  # required label width.
+  #
+  #     require 'benchmark'
+  #
+  #     array = (1..1000000).map { rand }
+  #
+  #     Benchmark.bmbm do |x|
+  #       x.report("sort!") { array.dup.sort! }
+  #       x.report("sort")  { array.dup.sort  }
+  #     end
+  #
+  # Generates:
+  #
+  #     Rehearsal -----------------------------------------
+  #     sort!   1.440000   0.010000   1.450000 (  1.446833)
+  #     sort    1.440000   0.000000   1.440000 (  1.448257)
+  #     -------------------------------- total: 2.890000sec
+  #
+  #                 user     system      total        real
+  #     sort!   1.460000   0.000000   1.460000 (  1.458065)
+  #     sort    1.450000   0.000000   1.450000 (  1.455963)
+  #
+  # #bmbm yields a Benchmark::Job object and returns an array of Benchmark::Tms
+  # objects.
+  #
+  def self?.bmbm: (?Integer width) { (Job job) -> void } -> ::Array[Benchmark::Tms]
+
+  # Returns the time used to execute the given block as a Benchmark::Tms object.
+  # Takes `label` option.
+  #
+  #     require 'benchmark'
+  #
+  #     n = 1000000
+  #
+  #     time = Benchmark.measure do
+  #       n.times { a = "1" }
+  #     end
+  #     puts time
+  #
+  # Generates:
+  #
+  #     0.220000   0.000000   0.220000 (  0.227313)
+  #
+  def self?.measure: (?String label) { () -> void } -> Benchmark::Tms
+
+  # Returns the elapsed real time used to execute the given block.
+  #
+  def self?.realtime: () { () -> void } -> Float
+end
+
+Benchmark::BENCHMARK_VERSION: String
+
+# The default caption string (heading above the output times).
+#
+Benchmark::CAPTION: String
+
+# The default format string used to display times.  See also
+# Benchmark::Tms#format.
+#
+Benchmark::FORMAT: String
+
+class Benchmark::Job
+  # Prints the `label` and measured time for the block,
+  # formatted by `format`. See Tms#format for the
+  # formatting rules.
+  def item: (?String label) { () -> void } -> self
+
+  # An array of 2-element arrays, consisting of label and block pairs.
+  def list: () -> ::Array[untyped]
+
+  alias report item
+
+  # Length of the widest label in the #list.
+  def width: () -> Integer
+end
+
+class Benchmark::Report
+  # Prints the `label` and measured time for the block,
+  # formatted by `format`. See Tms#format for the
+  # formatting rules.
+  def item: (?String label, *untyped format) { () -> void } -> Tms
+
+  # An array of Benchmark::Tms objects representing each item.
+  def list: () -> ::Array[Benchmark::Tms]
+
+  alias report item
+end
+
+# A data object, representing the times associated with a benchmark measurement.
+#
+class Benchmark::Tms
+  # Returns a new Tms object obtained by memberwise multiplication of the
+  # individual times for this Tms object by `x`.
+  #
+  def *: (untyped x) -> untyped
+
+  # Returns a new Tms object obtained by memberwise summation of the individual
+  # times for this Tms object with those of the `other` Tms object. This method
+  # and #/() are useful for taking statistics.
+  #
+  def +: (untyped other) -> untyped
+
+  # Returns a new Tms object obtained by memberwise subtraction of the individual
+  # times for the `other` Tms object from those of this Tms object.
+  #
+  def -: (untyped other) -> untyped
+
+  # Returns a new Tms object obtained by memberwise division of the individual
+  # times for this Tms object by `x`. This method and #+() are useful for taking
+  # statistics.
+  #
+  def /: (untyped x) -> untyped
+
+  # Returns a new Tms object whose times are the sum of the times for this Tms
+  # object, plus the time required to execute the code block (`blk`).
+  #
+  def add: () { (*untyped) -> untyped } -> untyped
+
+  # An in-place version of #add. Changes the times of this Tms object by making it
+  # the sum of the times for this Tms object, plus the time required to execute
+  # the code block (`blk`).
+  #
+  def add!: () { (*untyped) -> untyped } -> untyped
+
+  # System CPU time of children
+  #
+  def cstime: () -> Float
+
+  # User CPU time of children
+  #
+  def cutime: () -> Float
+
+  # Returns the contents of this Tms object as a formatted string, according to a
+  # `format` string like that passed to Kernel.format. In addition, #format
+  # accepts the following extensions:
+  #
+  # `%u`
+  # :   Replaced by the user CPU time, as reported by Tms#utime.
+  # `%y`
+  # :   Replaced by the system CPU time, as reported by #stime (Mnemonic: y of
+  #     "s*y*stem")
+  # `%U`
+  # :   Replaced by the children's user CPU time, as reported by Tms#cutime
+  # `%Y`
+  # :   Replaced by the children's system CPU time, as reported by Tms#cstime
+  # `%t`
+  # :   Replaced by the total CPU time, as reported by Tms#total
+  # `%r`
+  # :   Replaced by the elapsed real time, as reported by Tms#real
+  # `%n`
+  # :   Replaced by the label string, as reported by Tms#label (Mnemonic: n of
+  #     "*n*ame")
+  #
+  #
+  # If `format` is not given, FORMAT is used as default value, detailing the user,
+  # system and real elapsed time.
+  #
+  def format: (?String format, *untyped args) -> String
+
+  # Label
+  #
+  def label: () -> String
+
+  # Elapsed real time
+  #
+  def real: () -> Float
+
+  # System CPU time
+  #
+  def stime: () -> Float
+
+  # Returns a new 6-element array, consisting of the label, user CPU time, system
+  # CPU time, children's user CPU time, children's system CPU time and elapsed
+  # real time.
+  #
+  def to_a: () -> untyped
+
+  # Same as #format.
+  #
+  def to_s: () -> String
+
+  # Total time, that is `utime` + `stime` + `cutime` + `cstime`
+  #
+  def total: () -> Float
+
+  # User CPU time
+  #
+  def utime: () -> Float
+end
+
+# Default caption, see also Benchmark::CAPTION
+#
+Benchmark::Tms::CAPTION: String
+
+# Default format string, see also Benchmark::FORMAT
+#
+Benchmark::Tms::FORMAT: String