rbs 3.10.2 → 4.0.0.dev.1

data/core/ruby.rbs

@@ -1,53 +0,0 @@
-# <!-- rdoc-file=version.c -->
-# The [Ruby](rdoc-ref:Ruby) module that contains portable information among
-# implementations.
-#
-# The constants defined here are aliased in the toplevel with `RUBY_` prefix.
-#
-module Ruby
-  # <!-- rdoc-file=version.c -->
-  # The copyright string for ruby
-  #
-  COPYRIGHT: ::String
-
-  # <!-- rdoc-file=version.c -->
-  # The full ruby version string, like `ruby -v` prints
-  #
-  DESCRIPTION: ::String
-
-  # <!-- rdoc-file=version.c -->
-  # The engine or interpreter this ruby uses.
-  #
-  ENGINE: ::String
-
-  # <!-- rdoc-file=version.c -->
-  # The version of the engine or interpreter this ruby uses.
-  #
-  ENGINE_VERSION: ::String
-
-  # <!-- rdoc-file=version.c -->
-  # The patchlevel for this ruby.  If this is a development build of ruby the
-  # patchlevel will be -1
-  #
-  PATCHLEVEL: ::Integer
-
-  # <!-- rdoc-file=version.c -->
-  # The platform for this ruby
-  #
-  PLATFORM: ::String
-
-  # <!-- rdoc-file=version.c -->
-  # The date this ruby was released
-  #
-  RELEASE_DATE: ::String
-
-  # <!-- rdoc-file=version.c -->
-  # The GIT commit hash for this ruby.
-  #
-  REVISION: ::String
-
-  # <!-- rdoc-file=version.c -->
-  # The running version of ruby
-  #
-  VERSION: ::String
-end

data/docs/aliases.md

@@ -1,79 +0,0 @@
-# Aliases
-
-This document explains module/class aliases and type aliases.
-
-## Module/class alias
-
-Module/class aliases give another name to a module/class.
-This is useful for some syntaxes that has lexical constraints.
-
-```rbs
-class C
-end
-
-class D = C         # ::D is an alias for ::C
-
-class E < D         # ::E inherits from ::D, which is actually ::C
-end
-```
-
-Note that module/class aliases cannot be recursive.
-
-So, we can define a *normalization* of aliased module/class names.
-Normalization follows the chain of alias definitions and resolves them to the original module/class defined with `module`/`class` syntax.
-
-```rbs
-class C
-end
-
-class D = C
-class E = D
-```
-
-`::E` is defined as an alias, and it can be normalized to `::C`.
-
-## Type alias
-
-The biggest difference from module/class alias is that type alias can be recursive.
-
-```rbs
-# cons_cell type is defined recursively
-type cons_cell = nil
-               | [Integer, cons_cell]
-```
-
-This means type aliases *cannot be* normalized generally.
-So, we provide another operation for type alias, `DefinitionBuilder#expand_alias` and its family.
-It substitutes with the immediate right hand side of a type alias.
-
-```
-cons_cell ===> nil | [Integer, cons_cell]                   (expand 1 step)
-          ===> nil | [Integer, nil | [Integer, cons_cell]]  (expand 2 steps)
-          ===> ...                                          (expand will go infinitely)
-```
-
-Note that the namespace of a type alias *can be* normalized, because they are module names.
-
-```rbs
-module M
-  type t = String
-end
-
-module N = M
-```
-
-With the type definition above, a type `::N::t` can be normalized to `::M::t`.
-And then it can be expanded to `::String`.
-
-> [!NOTE]
-> This is something like an *unfold* operation in type theory.
-
-## Type name resolution
-
-Type name resolution in RBS usually rewrites *relative* type names to *absolute* type names.
-`Environment#resolve_type_names` converts all type names in the RBS type definitions, and returns a new `Environment` object.
-
-It also *normalizes* modules names in type names.
-
-- If the type name can be resolved and normalized successfully, the AST has *absolute* type names.
-- If the type name resolution/normalization fails, the AST has *relative* type names.

data/docs/encoding.md

@@ -1,56 +0,0 @@
-# RBS File Encoding
-
-## Best Practice
-
-**Use UTF-8** for both file encoding and your system locale.
-
-## Supported Encodings
-
-RBS parser supports ASCII-compatible encodings (similar to Ruby's script encoding support).
-
-**Examples**: UTF-8, US-ASCII, Shift JIS, EUC-JP, ...
-
-## Unicode Codepoint Symbols
-
-String literal types in RBS can contain Unicode codepoint escape sequences (`\uXXXX`).
-
-When the file encoding is UTF-8, the parser translates Unicode codepoint symbols:
-
-```rbs
-# In UTF-8 encoded files
-
-type t = "\u0123"  # Translated to the actual Unicode character ģ
-type s = "\u3042"  # Translated to the actual Unicode character あ
-```
-
-When the file encoding is not UTF-8, Unicode escape sequences are interpreted literally as the string `\uXXXX`:
-
-```rbs
-# In non-UTF-8 encoded files
-
-type t = "\u0123"  # Remains as the literal string "\u0123"
-```
-
-## Implementation
-
-RBS gem currently doesn't do anything for file encoding. It relies on Ruby's encoding handling, specifically `Encoding.default_external` and `Encoding.default_internal`.
-
-`Encoding.default_external` is the encoding Ruby assumes when it reads external resources like files. The Ruby interpreter sets it based on the locale. `Encoding.default_internal` is the encoding Ruby converts the external resources to. The default is `nil` (no conversion.)
-
-When your locale is set to use `UTF-8` encoding, `default_external` is `Encoding::UTF_8`. So the RBS file content read from the disk will have UTF-8 encoding.
-
-### Parsing non UTF-8 RBS source text
-
-If you want to work with another encoding, ensure the source string has ASCII compatible encoding.
-
-```ruby
-source = '"日本語"'
-RBS::Parser.parse_type(source.encode(Encoding::EUC_JP))  # => Parses successfully
-RBS::Parser.parse_type(source.encode(Encoding::UTF_32))  # => Returns `nil` since UTF-32 is not ASCII compatible
-```
-
-### Specifying file encoding
-
-Currently, RBS doesn't support specifying file encoding directly.
-
-You can use `Encoding.default_external` while the gem loads RBS files from the storage.

data/ext/rbs_extension/compat.h

@@ -1,10 +0,0 @@
-#ifdef __clang__
-#define SUPPRESS_RUBY_HEADER_DIAGNOSTICS_BEGIN \
-    _Pragma("clang diagnostic push")           \
-        _Pragma("clang diagnostic ignored \"-Wc2x-extensions\"")
-#define SUPPRESS_RUBY_HEADER_DIAGNOSTICS_END \
-    _Pragma("clang diagnostic pop")
-#else
-#define SUPPRESS_RUBY_HEADER_DIAGNOSTICS_BEGIN
-#define SUPPRESS_RUBY_HEADER_DIAGNOSTICS_END
-#endif

data/stdlib/cgi-escape/0/escape.rbs

@@ -1,171 +0,0 @@
-# <!-- rdoc-file=lib/cgi/escape.rb -->
-# Since Ruby 4.0, CGI is a small holder for various escaping methods, included
-# from CGI::Escape
-#
-#     require 'cgi/escape'
-#
-#     CGI.escape("Ruby programming language")
-#     #=> "Ruby+programming+language"
-#     CGI.escapeURIComponent("Ruby programming language")
-#     #=> "Ruby%20programming%20language"
-#
-# See CGI::Escape module for methods list and their description.
-#
-class CGI
-  include Escape
-
-  extend Escape
-
-  # <!-- rdoc-file=lib/cgi/escape.rb -->
-  # Web-related escape/unescape functionality.
-  #
-  module Escape
-    # <!--
-    #   rdoc-file=lib/cgi/escape.rb
-    #   - escape(string)
-    # -->
-    # URL-encode a string into application/x-www-form-urlencoded. Space characters
-    # (`" "`) are encoded with plus signs (`"+"`)
-    #     url_encoded_string = CGI.escape("'Stop!' said Fred")
-    #        # => "%27Stop%21%27+said+Fred"
-    #
-    def escape: (string str) -> String
-
-    # <!--
-    #   rdoc-file=lib/cgi/escape.rb
-    #   - escapeElement(string, *elements)
-    # -->
-    # Escape only the tags of certain HTML elements in `string`.
-    #
-    # Takes an element or elements or array of elements.  Each element is specified
-    # by the name of the element, without angle brackets. This matches both the
-    # start and the end tag of that element. The attribute list of the open tag will
-    # also be escaped (for instance, the double-quotes surrounding attribute
-    # values).
-    #
-    #     print CGI.escapeElement('<BR><A HREF="url"></A>', "A", "IMG")
-    #       # "<BR>&lt;A HREF=&quot;url&quot;&gt;&lt;/A&gt"
-    #
-    #     print CGI.escapeElement('<BR><A HREF="url"></A>', ["A", "IMG"])
-    #       # "<BR>&lt;A HREF=&quot;url&quot;&gt;&lt;/A&gt"
-    #
-    def escapeElement: (string string, *String | Array[String] elements) -> String
-
-    # <!--
-    #   rdoc-file=lib/cgi/escape.rb
-    #   - escapeHTML(string)
-    # -->
-    # Escape special characters in HTML, namely `'&\"<>`
-    #     CGI.escapeHTML('Usage: foo "bar" <baz>')
-    #        # => "Usage: foo &quot;bar&quot; &lt;baz&gt;"
-    #
-    def escapeHTML: (string str) -> String
-
-    # <!--
-    #   rdoc-file=lib/cgi/escape.rb
-    #   - escapeURIComponent(string)
-    # -->
-    # URL-encode a string following RFC 3986 Space characters (`" "`) are encoded
-    # with (`"%20"`)
-    #     url_encoded_string = CGI.escapeURIComponent("'Stop!' said Fred")
-    #        # => "%27Stop%21%27%20said%20Fred"
-    #
-    def escapeURIComponent: (string) -> String
-
-    # <!--
-    #   rdoc-file=lib/cgi/escape.rb
-    #   - escape_element(string, *elements)
-    # -->
-    #
-    alias escape_element escapeElement
-
-    # <!--
-    #   rdoc-file=lib/cgi/escape.rb
-    #   - escape_html(string)
-    # -->
-    #
-    alias escape_html escapeHTML
-
-    # <!--
-    #   rdoc-file=lib/cgi/escape.rb
-    #   - escape_uri_component(string)
-    # -->
-    #
-    alias escape_uri_component escapeURIComponent
-
-    # <!--
-    #   rdoc-file=lib/cgi/escape.rb
-    #   - h(string)
-    # -->
-    #
-    alias h escapeHTML
-
-    # <!--
-    #   rdoc-file=lib/cgi/escape.rb
-    #   - unescape(string, encoding = @@accept_charset)
-    # -->
-    # URL-decode an application/x-www-form-urlencoded string with
-    # encoding(optional).
-    #     string = CGI.unescape("%27Stop%21%27+said+Fred")
-    #        # => "'Stop!' said Fred"
-    #
-    def unescape: (string str, ?encoding encoding) -> String
-
-    # <!--
-    #   rdoc-file=lib/cgi/escape.rb
-    #   - unescapeElement(string, *elements)
-    # -->
-    # Undo escaping such as that done by CGI.escapeElement
-    #
-    #     print CGI.unescapeElement(
-    #             CGI.escapeHTML('<BR><A HREF="url"></A>'), "A", "IMG")
-    #       # "&lt;BR&gt;<A HREF="url"></A>"
-    #
-    #     print CGI.unescapeElement(
-    #             CGI.escapeHTML('<BR><A HREF="url"></A>'), ["A", "IMG"])
-    #       # "&lt;BR&gt;<A HREF="url"></A>"
-    #
-    def unescapeElement: (string string, *String | Array[String] elements) -> String
-
-    # <!--
-    #   rdoc-file=lib/cgi/escape.rb
-    #   - unescapeHTML(string)
-    # -->
-    # Unescape a string that has been HTML-escaped
-    #     CGI.unescapeHTML("Usage: foo &quot;bar&quot; &lt;baz&gt;")
-    #        # => "Usage: foo \"bar\" <baz>"
-    #
-    def unescapeHTML: (string str) -> String
-
-    # <!--
-    #   rdoc-file=lib/cgi/escape.rb
-    #   - unescapeURIComponent(string, encoding = @@accept_charset)
-    # -->
-    # URL-decode a string following RFC 3986 with encoding(optional).
-    #     string = CGI.unescapeURIComponent("%27Stop%21%27+said%20Fred")
-    #        # => "'Stop!'+said Fred"
-    #
-    def unescapeURIComponent: (string) -> String
-
-    # <!--
-    #   rdoc-file=lib/cgi/escape.rb
-    #   - unescape_element(string, *elements)
-    # -->
-    #
-    alias unescape_element unescapeElement
-
-    # <!--
-    #   rdoc-file=lib/cgi/escape.rb
-    #   - unescape_html(string)
-    # -->
-    #
-    alias unescape_html unescapeHTML
-
-    # <!--
-    #   rdoc-file=lib/cgi/escape.rb
-    #   - unescape_uri_component(string, encoding = @@accept_charset)
-    # -->
-    #
-    alias unescape_uri_component unescapeURIComponent
-  end
-end