rbs 0.2.0

data/stdlib/erb/erb.rbs

@@ -0,0 +1,392 @@
+# # ERB -- Ruby Templating
+#
+# ## Introduction
+#
+# ERB provides an easy to use but powerful templating system for Ruby.  Using
+# ERB, actual Ruby code can be added to any plain text document for the purposes
+# of generating document information details and/or flow control.
+#
+# A very simple example is this:
+#
+#     require 'erb'
+#
+#     x = 42
+#     template = ERB.new <<-EOF
+#       The value of x is: <%= x %>
+#     EOF
+#     puts template.result(binding)
+#
+# *Prints:* The value of x is: 42
+#
+# More complex examples are given below.
+#
+# ## Recognized Tags
+#
+# ERB recognizes certain tags in the provided template and converts them based
+# on the rules below:
+#
+#     <% Ruby code -- inline with output %>
+#     <%= Ruby expression -- replace with result %>
+#     <%# comment -- ignored -- useful in testing %>
+#     % a line of Ruby code -- treated as <% line %> (optional -- see ERB.new)
+#     %% replaced with % if first thing on a line and % processing is used
+#     <%% or %%> -- replace with <% or %> respectively
+#
+# All other text is passed through ERB filtering unchanged.
+#
+# ## Options
+#
+# There are several settings you can change when you use ERB:
+# *   the nature of the tags that are recognized;
+# *   the value of `$SAFE` under which the template is run;
+# *   the binding used to resolve local variables in the template.
+#
+#
+# See the ERB.new and ERB#result methods for more detail.
+#
+# ## Character encodings
+#
+# ERB (or Ruby code generated by ERB) returns a string in the same character
+# encoding as the input string.  When the input string has a magic comment,
+# however, it returns a string in the encoding specified by the magic comment.
+#
+#     # -*- coding: utf-8 -*-
+#     require 'erb'
+#
+#     template = ERB.new <<EOF
+#     <%#-*- coding: Big5 -*-%>
+#       \_\_ENCODING\_\_ is <%= \_\_ENCODING\_\_ %>.
+#     EOF
+#     puts template.result
+#
+# *Prints:* _*ENCODING*_ is Big5.
+#
+# ## Examples
+#
+# ### Plain Text
+#
+# ERB is useful for any generic templating situation.  Note that in this
+# example, we use the convenient "% at start of line" tag, and we quote the
+# template literally with `%q{...}` to avoid trouble with the backslash.
+#
+#     require "erb"
+#
+#     # Create template.
+#     template = %q{
+#       From:  James Edward Gray II <james@grayproductions.net>
+#       To:  <%= to %>
+#       Subject:  Addressing Needs
+#
+#       <%= to[/\w+/] %>:
+#
+#       Just wanted to send a quick note assuring that your needs are being
+#       addressed.
+#
+#       I want you to know that my team will keep working on the issues,
+#       especially:
+#
+#       <%# ignore numerous minor requests -- focus on priorities %>
+#       % priorities.each do |priority|
+#         * <%= priority %>
+#       % end
+#
+#       Thanks for your patience.
+#
+#       James Edward Gray II
+#     }.gsub(/^  /, '')
+#
+#     message = ERB.new(template, trim_mode: "%<>")
+#
+#     # Set up template data.
+#     to = "Community Spokesman <spokesman@ruby_community.org>"
+#     priorities = [ "Run Ruby Quiz",
+#                    "Document Modules",
+#                    "Answer Questions on Ruby Talk" ]
+#
+#     # Produce result.
+#     email = message.result
+#     puts email
+#
+# *Generates:*
+#
+#     From:  James Edward Gray II <james@grayproductions.net>
+#     To:  Community Spokesman <spokesman@ruby_community.org>
+#     Subject:  Addressing Needs
+#
+#     Community:
+#
+#     Just wanted to send a quick note assuring that your needs are being addressed.
+#
+#     I want you to know that my team will keep working on the issues, especially:
+#
+#         * Run Ruby Quiz
+#         * Document Modules
+#         * Answer Questions on Ruby Talk
+#
+#     Thanks for your patience.
+#
+#     James Edward Gray II
+#
+# ### Ruby in HTML
+#
+# ERB is often used in `.rhtml` files (HTML with embedded Ruby).  Notice the
+# need in this example to provide a special binding when the template is run, so
+# that the instance variables in the Product object can be resolved.
+#
+#     require "erb"
+#
+#     # Build template data class.
+#     class Product
+#       def initialize( code, name, desc, cost )
+#         @code = code
+#         @name = name
+#         @desc = desc
+#         @cost = cost
+#
+#         @features = [ ]
+#       end
+#
+#       def add_feature( feature )
+#         @features << feature
+#       end
+#
+#       # Support templating of member data.
+#       def get_binding
+#         binding
+#       end
+#
+#       # ...
+#     end
+#
+#     # Create template.
+#     template = %{
+#       <html>
+#         <head><title>Ruby Toys -- <%= @name %></title></head>
+#         <body>
+#
+#           <h1><%= @name %> (<%= @code %>)</h1>
+#           <p><%= @desc %></p>
+#
+#           <ul>
+#             <% @features.each do |f| %>
+#               <li><b><%= f %></b></li>
+#             <% end %>
+#           </ul>
+#
+#           <p>
+#             <% if @cost < 10 %>
+#               <b>Only <%= @cost %>!!!</b>
+#             <% else %>
+#                Call for a price, today!
+#             <% end %>
+#           </p>
+#
+#         </body>
+#       </html>
+#     }.gsub(/^  /, '')
+#
+#     rhtml = ERB.new(template)
+#
+#     # Set up template data.
+#     toy = Product.new( "TZ-1002",
+#                        "Rubysapien",
+#                        "Geek's Best Friend!  Responds to Ruby commands...",
+#                        999.95 )
+#     toy.add_feature("Listens for verbal commands in the Ruby language!")
+#     toy.add_feature("Ignores Perl, Java, and all C variants.")
+#     toy.add_feature("Karate-Chop Action!!!")
+#     toy.add_feature("Matz signature on left leg.")
+#     toy.add_feature("Gem studded eyes... Rubies, of course!")
+#
+#     # Produce result.
+#     rhtml.run(toy.get_binding)
+#
+# *Generates (some blank lines removed):*
+#
+#     <html>
+#       <head><title>Ruby Toys -- Rubysapien</title></head>
+#       <body>
+#
+#         <h1>Rubysapien (TZ-1002)</h1>
+#         <p>Geek's Best Friend!  Responds to Ruby commands...</p>
+#
+#         <ul>
+#             <li><b>Listens for verbal commands in the Ruby language!</b></li>
+#             <li><b>Ignores Perl, Java, and all C variants.</b></li>
+#             <li><b>Karate-Chop Action!!!</b></li>
+#             <li><b>Matz signature on left leg.</b></li>
+#             <li><b>Gem studded eyes... Rubies, of course!</b></li>
+#         </ul>
+#
+#         <p>
+#              Call for a price, today!
+#         </p>
+#
+#       </body>
+#     </html>
+#
+# ## Notes
+#
+# There are a variety of templating solutions available in various Ruby
+# projects:
+# *   ERB's big brother, eRuby, works the same but is written in C for speed;
+# *   Amrita (smart at producing HTML/XML);
+# *   cs/Template (written in C for speed);
+# *   RDoc, distributed with Ruby, uses its own template engine, which can be
+#     reused elsewhere;
+# *   and others; search [RubyGems.org](https://rubygems.org/) or [The Ruby
+#     Toolbox](https://www.ruby-toolbox.com/).
+#
+#
+# Rails, the web application framework, uses ERB to create views.
+#
+class ERB
+  # Returns revision information for the erb.rb module.
+  #
+  def self.version: () -> String
+
+  # Constructs a new ERB object with the template specified in *str*.
+  #
+  # An ERB object works by building a chunk of Ruby code that will output the
+  # completed template when run. If *safe_level* is set to a non-nil value, ERB
+  # code will be run in a separate thread with **$SAFE** set to the provided
+  # level.
+  #
+  # If *trim_mode* is passed a String containing one or more of the following
+  # modifiers, ERB will adjust its code generation as listed:
+  #
+  #     %  enables Ruby code processing for lines beginning with %
+  #     <> omit newline for lines starting with <% and ending in %>
+  #     >  omit newline for lines ending in %>
+  #     -  omit blank lines ending in -%>
+  #
+  # *eoutvar* can be used to set the name of the variable ERB will build up its
+  # output in.  This is useful when you need to run multiple ERB templates through
+  # the same binding and/or when you want to control where output ends up.  Pass
+  # the name of the variable to be used inside a String.
+  #
+  # ### Example
+  #
+  #     require "erb"
+  #
+  #     # build data class
+  #     class Listings
+  #       PRODUCT = { :name => "Chicken Fried Steak",
+  #                   :desc => "A well messages pattie, breaded and fried.",
+  #                   :cost => 9.95 }
+  #
+  #       attr_reader :product, :price
+  #
+  #       def initialize( product = "", price = "" )
+  #         @product = product
+  #         @price = price
+  #       end
+  #
+  #       def build
+  #         b = binding
+  #         # create and run templates, filling member data variables
+  #         ERB.new(<<-'END_PRODUCT'.gsub(/^\s+/, ""), trim_mode: "", eoutvar: "@product").result b
+  #           <%= PRODUCT[:name] %>
+  #           <%= PRODUCT[:desc] %>
+  #         END_PRODUCT
+  #         ERB.new(<<-'END_PRICE'.gsub(/^\s+/, ""), trim_mode: "", eoutvar: "@price").result b
+  #           <%= PRODUCT[:name] %> -- <%= PRODUCT[:cost] %>
+  #           <%= PRODUCT[:desc] %>
+  #         END_PRICE
+  #       end
+  #     end
+  #
+  #     # setup template data
+  #     listings = Listings.new
+  #     listings.build
+  #
+  #     puts listings.product + "\n" + listings.price
+  #
+  # *Generates*
+  #
+  #     Chicken Fried Steak
+  #     A well messages pattie, breaded and fried.
+  #
+  #     Chicken Fried Steak -- 9.95
+  #     A well messages pattie, breaded and fried.
+  #
+  def initialize: (String, ?eoutvar: String, ?trim_mode: Integer | String | NilClass) -> untyped
+
+  # The Ruby code generated by ERB
+  #
+  def src: () -> String
+
+  # The encoding to eval
+  #
+  def encoding: () -> Encoding
+
+  # The optional *filename* argument passed to Kernel#eval when the ERB code is
+  # run
+  #
+  def filename: () -> (String | NilClass)
+  def filename=: (String | NilClass) -> untyped
+
+  # The optional *lineno* argument passed to Kernel#eval when the ERB code is run
+  #
+  def lineno: () -> Integer
+  def lineno=: (Integer) -> untyped
+  def location=: (Array[String | Integer]) -> untyped
+
+  # Generate results and print them. (see ERB#result)
+  #
+  def run: (?Binding) -> untyped
+
+  # Executes the generated ERB code to produce a completed template, returning the
+  # results of that code.  (See ERB::new for details on how this process can be
+  # affected by *safe_level*.)
+  #
+  # *b* accepts a Binding object which is used to set the context of code
+  # evaluation.
+  #
+  def result: (?Binding) -> String
+
+  # Render a template on a new toplevel binding with local variables specified by
+  # a Hash object.
+  #
+  def result_with_hash: (Hash[untyped, untyped]) -> String
+
+  # Define *methodname* as instance method of *mod* from compiled Ruby source.
+  #
+  # example:
+  #     filename = 'example.rhtml'   # 'arg1' and 'arg2' are used in example.rhtml
+  #     erb = ERB.new(File.read(filename))
+  #     erb.def_method(MyClass, 'render(arg1, arg2)', filename)
+  #     print MyClass.new.render('foo', 123)
+  #
+  def def_method: (Module, String, ?String) -> untyped
+
+  # Create unnamed module, define *methodname* as instance method of it, and
+  # return it.
+  #
+  # example:
+  #     filename = 'example.rhtml'   # 'arg1' and 'arg2' are used in example.rhtml
+  #     erb = ERB.new(File.read(filename))
+  #     erb.filename = filename
+  #     MyModule = erb.def_module('render(arg1, arg2)')
+  #     class MyClass
+  #       include MyModule
+  #     end
+  #
+  def def_module: (?String) -> Module
+
+  # Define unnamed class which has *methodname* as instance method, and return it.
+  #
+  # example:
+  #     class MyClass_
+  #       def initialize(arg1, arg2)
+  #         @arg1 = arg1;  @arg2 = arg2
+  #       end
+  #     end
+  #     filename = 'example.rhtml'  # @arg1 and @arg2 are used in example.rhtml
+  #     erb = ERB.new(File.read(filename))
+  #     erb.filename = filename
+  #     MyClass = erb.def_class(MyClass_, 'render()')
+  #     print MyClass.new('foo', 123).render()
+  #
+  def def_class: (?Class, ?String) -> Class
+end

data/stdlib/find/find.rbs

@@ -0,0 +1,40 @@
+# The `Find` module supports the top-down traversal of a set of file paths.
+# 
+# For example, to total the size of all files under your home directory,
+# ignoring anything in a "dot" directory (e.g. $HOME/.ssh):
+# 
+#     require 'find'
+# 
+#     total_size = 0
+# 
+#     Find.find(ENV["HOME"]) do |path|
+#       if FileTest.directory?(path)
+#         if File.basename(path).start_with?('.')
+#           Find.prune       # Don't look any further into this directory.
+#         else
+#           next
+#         end
+#       else
+#         total_size += FileTest.size(path)
+#       end
+#     end
+# 
+module Find
+  # Calls the associated block with the name of every file and directory listed as
+  # arguments, then recursively on their subdirectories, and so on.
+  # 
+  # Returns an enumerator if no block is given.
+  # 
+  # See the `Find` module documentation for an example.
+  # 
+  def self?.find: (*String | _ToPath paths, ?ignore_error: bool) -> Enumerator[String, nil]
+                | (*String | _ToPath paths, ?ignore_error: bool) { (String arg0) -> void } -> nil
+
+  # Skips the current file or directory, restarting the loop with the next entry.
+  # If the current file is a directory, that directory will not be recursively
+  # entered. Meaningful only within the block associated with Find::find.
+  # 
+  # See the `Find` module documentation for an example.
+  # 
+  def self?.prune: () -> void
+end

data/stdlib/ipaddr/ipaddr.rbs

@@ -0,0 +1,247 @@
+# IPAddr provides a set of methods to manipulate an IP address.  Both IPv4 and
+# IPv6 are supported.
+#
+# ## Example
+#
+#     require 'ipaddr'
+#
+#     ipaddr1 = IPAddr.new "3ffe:505:2::1"
+#
+#     p ipaddr1                   #=> #<IPAddr: IPv6:3ffe:0505:0002:0000:0000:0000:0000:0001/ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff>
+#
+#     p ipaddr1.to_s              #=> "3ffe:505:2::1"
+#
+#     ipaddr2 = ipaddr1.mask(48)  #=> #<IPAddr: IPv6:3ffe:0505:0002:0000:0000:0000:0000:0000/ffff:ffff:ffff:0000:0000:0000:0000:0000>
+#
+#     p ipaddr2.to_s              #=> "3ffe:505:2::"
+#
+#     ipaddr3 = IPAddr.new "192.168.2.0/24"
+#
+#     p ipaddr3                   #=> #<IPAddr: IPv4:192.168.2.0/255.255.255.0>
+#
+class IPAddr
+  include Comparable
+
+  # Creates a new ipaddr containing the given network byte ordered string form of
+  # an IP address.
+  #
+  def self.new_ntoh: (String addr) -> IPAddr
+
+  # Convert a network byte ordered string form of an IP address into human
+  # readable form.
+  #
+  def self.ntop: (String addr) -> String
+
+  # Creates a new ipaddr object either from a human readable IP address
+  # representation in string, or from a packed in_addr value followed by an
+  # address family.
+  #
+  # In the former case, the following are the valid formats that will be
+  # recognized: "address", "address/prefixlen" and "address/mask", where IPv6
+  # address may be enclosed in square brackets (`[' and `]').  If a prefixlen or a
+  # mask is specified, it returns a masked IP address.  Although the address
+  # family is determined automatically from a specified string, you can specify
+  # one explicitly by the optional second argument.
+  #
+  # Otherwise an IP address is generated from a packed in_addr value and an
+  # address family.
+  #
+  # The IPAddr class defines many methods and operators, and some of those, such
+  # as &, |, include? and ==, accept a string, or a packed in_addr value instead
+  # of an IPAddr object.
+  #
+  def initialize: (?String addr, ?untyped family) -> IPAddr
+
+  # Returns a new ipaddr built by bitwise AND.
+  #
+  def &: (untyped other) -> IPAddr
+
+  # Returns a new ipaddr built by bitwise left shift.
+  #
+  def <<: (Integer num) -> IPAddr
+
+  # Compares the ipaddr with another.
+  #
+  def <=>: (untyped other) -> Integer?
+
+  # Returns true if two ipaddrs are equal.
+  #
+  def ==: (untyped other) -> bool
+
+  alias === include?
+
+  # Returns a new ipaddr built by bitwise right-shift.
+  #
+  def >>: (Integer num) -> IPAddr
+
+  # Checks equality used by Hash.
+  #
+  def eql?: (untyped other) -> bool
+
+  # Returns the address family of this IP address.
+  #
+  attr_reader family: Integer
+
+  # Returns a hash value used by Hash, Set, and Array classes
+  #
+  def hash: () -> Integer
+
+  # Returns a network byte ordered string form of the IP address.
+  #
+  def hton: () -> String
+
+  # Returns true if the given ipaddr is in the range.
+  #
+  # e.g.:
+  #     require 'ipaddr'
+  #     net1 = IPAddr.new("192.168.2.0/24")
+  #     net2 = IPAddr.new("192.168.2.100")
+  #     net3 = IPAddr.new("192.168.3.0")
+  #     p net1.include?(net2)     #=> true
+  #     p net1.include?(net3)     #=> false
+  #
+  def include?: (untyped other) -> bool
+
+  # Returns a string containing a human-readable representation of the ipaddr.
+  # ("#<IPAddr: family:address/mask>")
+  #
+  def inspect: () -> String
+
+  # Returns a string for DNS reverse lookup compatible with RFC3172.
+  #
+  def ip6_arpa: () -> String
+
+  # Returns a string for DNS reverse lookup compatible with RFC1886.
+  #
+  def ip6_int: () -> String
+
+  # Returns true if the ipaddr is an IPv4 address.
+  #
+  def ipv4?: () -> bool
+
+  # Returns a new ipaddr built by converting the native IPv4 address into an
+  # IPv4-compatible IPv6 address.
+  #
+  def ipv4_compat: () -> IPAddr
+
+  # Returns true if the ipaddr is an IPv4-compatible IPv6 address.
+  #
+  def ipv4_compat?: () -> bool
+
+  # Returns a new ipaddr built by converting the native IPv4 address into an
+  # IPv4-mapped IPv6 address.
+  #
+  def ipv4_mapped: () -> IPAddr
+
+  # Returns true if the ipaddr is an IPv4-mapped IPv6 address.
+  #
+  def ipv4_mapped?: () -> bool
+
+  # Returns true if the ipaddr is an IPv6 address.
+  #
+  def ipv6?: () -> bool
+
+  # Returns true if the ipaddr is a link-local address.  IPv4 addresses in
+  # 169.254.0.0/16 reserved by RFC 3927 and Link-Local IPv6 Unicast Addresses in
+  # fe80::/10 reserved by RFC 4291 are considered link-local.
+  #
+  def link_local?: () -> bool
+
+  # Returns true if the ipaddr is a loopback address.
+  #
+  def loopback?: () -> bool
+
+  # Returns a new ipaddr built by masking IP address with the given
+  # prefixlen/netmask. (e.g. 8, 64, "255.255.255.0", etc.)
+  #
+  def mask: (String | Integer prefixlen) -> IPAddr
+
+  # Returns a new ipaddr built by converting the IPv6 address into a native IPv4
+  # address.  If the IP address is not an IPv4-mapped or IPv4-compatible IPv6
+  # address, returns self.
+  #
+  def native: () -> IPAddr
+
+  # Returns the prefix length in bits for the ipaddr.
+  #
+  def prefix: () -> Integer
+
+  # Sets the prefix length in bits
+  #
+  def prefix=: (Integer prefix) -> self
+
+  # Returns true if the ipaddr is a private address.  IPv4 addresses in
+  # 10.0.0.0/8, 172.16.0.0/12 and 192.168.0.0/16 as defined in RFC 1918 and IPv6
+  # Unique Local Addresses in fc00::/7 as defined in RFC 4193 are considered
+  # private.
+  #
+  def private?: () -> bool
+
+  # Returns a string for DNS reverse lookup.  It returns a string in RFC3172 form
+  # for an IPv6 address.
+  #
+  def reverse: () -> String
+
+  # Returns the successor to the ipaddr.
+  #
+  def succ: () -> IPAddr
+
+  # Returns the integer representation of the ipaddr.
+  #
+  def to_i: () -> Integer
+
+  # Creates a Range object for the network address.
+  #
+  def to_range: () -> Range[IPAddr]
+
+  # Returns a string containing the IP address representation.
+  #
+  def to_s: () -> String
+
+  # Returns a string containing the IP address representation in canonical form.
+  #
+  def to_string: () -> String
+
+  # Returns a new ipaddr built by bitwise OR.
+  #
+  def |: (untyped other) -> IPAddr
+
+  # Returns a new ipaddr built by bitwise negation.
+  #
+  def ~: () -> IPAddr
+end
+
+# Generic IPAddr related error. Exceptions raised in this class should inherit
+# from Error.
+#
+class IPAddr::Error < ArgumentError
+end
+
+# Raised when the provided IP address is an invalid address.
+#
+class IPAddr::InvalidAddressError < IPAddr::Error
+end
+
+# Raised when the address family is invalid such as an address with an
+# unsupported family, an address with an inconsistent family, or an address
+# who's family cannot be determined.
+#
+class IPAddr::AddressFamilyError < IPAddr::Error
+end
+
+# Raised when the address is an invalid length.
+#
+class IPAddr::InvalidPrefixError < IPAddr::InvalidAddressError
+end
+
+# 32 bit mask for IPv4
+#
+IPAddr::IN4MASK: Integer
+
+# Format string for IPv6
+#
+IPAddr::IN6FORMAT: String
+
+# 128 bit mask for IPv6
+#
+IPAddr::IN6MASK: Integer